bandwidth-sdk 10.0.0 → 11.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +11 -0
- data/Gemfile.lock +102 -0
- data/README.md +204 -139
- data/Rakefile +30 -0
- data/bandwidth-sdk.gemspec +40 -0
- data/bandwidth.yml +5626 -0
- data/coverage/.last_run.json +5 -0
- data/coverage/.resultset.json +9761 -0
- data/coverage/.resultset.json.lock +0 -0
- data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc.png +0 -0
- data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc_disabled.png +0 -0
- data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_both.png +0 -0
- data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc.png +0 -0
- data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc_disabled.png +0 -0
- data/coverage/assets/0.12.3/application.css +1 -0
- data/coverage/assets/0.12.3/application.js +7 -0
- data/coverage/assets/0.12.3/colorbox/border.png +0 -0
- data/coverage/assets/0.12.3/colorbox/controls.png +0 -0
- data/coverage/assets/0.12.3/colorbox/loading.gif +0 -0
- data/coverage/assets/0.12.3/colorbox/loading_background.png +0 -0
- data/coverage/assets/0.12.3/favicon_green.png +0 -0
- data/coverage/assets/0.12.3/favicon_red.png +0 -0
- data/coverage/assets/0.12.3/favicon_yellow.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_glass_75_dadada_1x400.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
- data/coverage/assets/0.12.3/images/ui-icons_222222_256x240.png +0 -0
- data/coverage/assets/0.12.3/images/ui-icons_2e83ff_256x240.png +0 -0
- data/coverage/assets/0.12.3/images/ui-icons_454545_256x240.png +0 -0
- data/coverage/assets/0.12.3/images/ui-icons_888888_256x240.png +0 -0
- data/coverage/assets/0.12.3/images/ui-icons_cd0a0a_256x240.png +0 -0
- data/coverage/assets/0.12.3/loading.gif +0 -0
- data/coverage/assets/0.12.3/magnify.png +0 -0
- data/coverage/index.html +108271 -0
- data/custom_templates/Gemfile.mustache +11 -0
- data/custom_templates/README.mustache +173 -0
- data/custom_templates/gem.mustache +99 -0
- data/custom_templates/gemspec.mustache +37 -0
- data/docs/AccountStatistics.md +20 -0
- data/docs/AnswerCallback.md +44 -0
- data/docs/BridgeCompleteCallback.md +48 -0
- data/docs/BridgeTargetCompleteCallback.md +42 -0
- data/docs/CallDirectionEnum.md +15 -0
- data/docs/CallRecordingMetadata.md +52 -0
- data/docs/CallState.md +52 -0
- data/docs/CallStateEnum.md +15 -0
- data/docs/CallbackMethodEnum.md +15 -0
- data/docs/CallsApi.md +304 -0
- data/docs/CodeRequest.md +28 -0
- data/docs/Conference.md +32 -0
- data/docs/ConferenceCompletedCallback.md +26 -0
- data/docs/ConferenceCreatedCallback.md +26 -0
- data/docs/ConferenceMember.md +28 -0
- data/docs/ConferenceMemberExitCallback.md +32 -0
- data/docs/ConferenceMemberJoinCallback.md +32 -0
- data/docs/ConferenceRecordingAvailableCallback.md +44 -0
- data/docs/ConferenceRecordingMetadata.md +38 -0
- data/docs/ConferenceRedirectCallback.md +26 -0
- data/docs/ConferenceStateEnum.md +15 -0
- data/docs/ConferencesApi.md +688 -0
- data/docs/CreateCall.md +56 -0
- data/docs/CreateCallResponse.md +58 -0
- data/docs/CreateLookupResponse.md +20 -0
- data/docs/CreateMessageRequestError.md +22 -0
- data/docs/CreateParticipantRequest.md +24 -0
- data/docs/CreateParticipantResponse.md +20 -0
- data/docs/DeferredResult.md +20 -0
- data/docs/DeviceApiVersionEnum.md +15 -0
- data/docs/DisconenctCallback.md +50 -0
- data/docs/DisconnectCallback.md +50 -0
- data/docs/Diversion.md +30 -0
- data/docs/DtmfCallback.md +50 -0
- data/docs/FieldError.md +20 -0
- data/docs/FileFormatEnum.md +15 -0
- data/docs/ForbiddenRequest.md +18 -0
- data/docs/GatherCallback.md +52 -0
- data/docs/InboundMessageCallback.md +26 -0
- data/docs/InboundMessageCallbackMessage.md +40 -0
- data/docs/InitiateCallback.md +40 -0
- data/docs/ListMessageDirectionEnum.md +15 -0
- data/docs/ListMessageItem.md +50 -0
- data/docs/LookupRequest.md +18 -0
- data/docs/LookupResult.md +34 -0
- data/docs/LookupStatus.md +24 -0
- data/docs/LookupStatusEnum.md +15 -0
- data/docs/MFAApi.md +226 -0
- data/docs/MachineDetectionCompleteCallback.md +44 -0
- data/docs/MachineDetectionConfiguration.md +46 -0
- data/docs/MachineDetectionModeEnum.md +15 -0
- data/docs/MachineDetectionResult.md +20 -0
- data/docs/Media.md +22 -0
- data/docs/MediaApi.md +307 -0
- data/docs/Message.md +42 -0
- data/docs/MessageDeliveredCallback.md +26 -0
- data/docs/MessageDeliveredCallbackMessage.md +40 -0
- data/docs/MessageDirectionEnum.md +15 -0
- data/docs/MessageFailedCallback.md +28 -0
- data/docs/MessageFailedCallbackMessage.md +40 -0
- data/docs/MessageRequest.md +32 -0
- data/docs/MessageSendingCallback.md +26 -0
- data/docs/MessageSendingCallbackMessage.md +40 -0
- data/docs/MessageStatusEnum.md +15 -0
- data/docs/MessageTypeEnum.md +15 -0
- data/docs/MessagesApi.md +183 -0
- data/docs/MessagesList.md +22 -0
- data/docs/MessagingCodeResponse.md +18 -0
- data/docs/MessagingRequestError.md +20 -0
- data/docs/MfaForbiddenRequestError.md +18 -0
- data/docs/MfaRequestError.md +20 -0
- data/docs/MfaUnauthorizedRequestError.md +18 -0
- data/docs/PageInfo.md +24 -0
- data/docs/Participant.md +30 -0
- data/docs/ParticipantSubscription.md +20 -0
- data/docs/ParticipantsApi.md +227 -0
- data/docs/PhoneNumberLookupApi.md +153 -0
- data/docs/PriorityEnum.md +15 -0
- data/docs/PublishPermissionsEnum.md +15 -0
- data/docs/RecordingAvailableCallback.md +60 -0
- data/docs/RecordingCompleteCallback.md +60 -0
- data/docs/RecordingStateEnum.md +15 -0
- data/docs/RecordingsApi.md +758 -0
- data/docs/RedirectCallback.md +48 -0
- data/docs/RedirectMethodEnum.md +15 -0
- data/docs/RequestError.md +20 -0
- data/docs/Session.md +20 -0
- data/docs/SessionsApi.md +605 -0
- data/docs/StatisticsApi.md +78 -0
- data/docs/StirShaken.md +22 -0
- data/docs/Subscriptions.md +20 -0
- data/docs/Tag.md +20 -0
- data/docs/TnLookupRequestError.md +18 -0
- data/docs/TranscribeRecording.md +30 -0
- data/docs/Transcription.md +20 -0
- data/docs/TranscriptionAvailableCallback.md +58 -0
- data/docs/TranscriptionList.md +18 -0
- data/docs/TranscriptionMetadata.md +24 -0
- data/docs/TransferAnswerCallback.md +46 -0
- data/docs/TransferCompleteCallback.md +52 -0
- data/docs/TransferDisconnectCallback.md +56 -0
- data/docs/UnauthorizedRequest.md +18 -0
- data/docs/UpdateCall.md +36 -0
- data/docs/UpdateCallRecording.md +18 -0
- data/docs/UpdateConference.md +34 -0
- data/docs/UpdateConferenceMember.md +22 -0
- data/docs/VerifyCodeRequest.md +24 -0
- data/docs/VerifyCodeResponse.md +18 -0
- data/docs/VoiceApiError.md +22 -0
- data/docs/VoiceCodeResponse.md +18 -0
- data/git_push.sh +57 -0
- data/lib/bandwidth-sdk/api/calls_api.rb +325 -0
- data/lib/bandwidth-sdk/api/conferences_api.rb +717 -0
- data/lib/bandwidth-sdk/api/media_api.rb +312 -0
- data/lib/bandwidth-sdk/api/messages_api.rb +204 -0
- data/lib/bandwidth-sdk/api/mfa_api.rb +244 -0
- data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +165 -0
- data/lib/bandwidth-sdk/api/recordings_api.rb +782 -0
- data/lib/bandwidth-sdk/api/statistics_api.rb +85 -0
- data/lib/bandwidth-sdk/api_client.rb +428 -0
- data/lib/bandwidth-sdk/api_error.rb +58 -0
- data/lib/bandwidth-sdk/configuration.rb +591 -0
- data/lib/bandwidth-sdk/models/account_statistics.rb +223 -0
- data/lib/bandwidth-sdk/models/answer_callback.rb +368 -0
- data/lib/bandwidth-sdk/models/bridge_complete_callback.rb +390 -0
- data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb +358 -0
- data/lib/bandwidth-sdk/models/bxml/bxml.rb +11 -0
- data/lib/bandwidth-sdk/models/bxml/nestable_verb.rb +46 -0
- data/lib/bandwidth-sdk/models/bxml/response.rb +11 -0
- data/lib/bandwidth-sdk/models/bxml/root.rb +47 -0
- data/lib/bandwidth-sdk/models/bxml/verb.rb +50 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/bridge.rb +28 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/conference.rb +28 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/custom_param.rb +16 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/forward.rb +20 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb +42 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/hangup.rb +10 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/pause.rb +15 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/pause_recording.rb +10 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/phone_number.rb +26 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/play_audio.rb +17 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/record.rb +32 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/redirect.rb +23 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/resume_recording.rb +10 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/ring.rb +16 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/send_dtmf.rb +17 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/sip_uri.rb +27 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/speak_sentence.rb +25 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/start_gather.rb +19 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/start_recording.rb +24 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb +28 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb +29 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_gather.rb +10 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_recording.rb +10 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_stream.rb +15 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_transcription.rb +15 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stream_param.rb +16 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/tag.rb +11 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb +34 -0
- data/lib/bandwidth-sdk/models/call_direction_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/call_recording_metadata.rb +404 -0
- data/lib/bandwidth-sdk/models/call_state.rb +416 -0
- data/lib/bandwidth-sdk/models/call_state_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/callback_method_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/code_request.rb +434 -0
- data/lib/bandwidth-sdk/models/conference.rb +313 -0
- data/lib/bandwidth-sdk/models/conference_completed_callback.rb +255 -0
- data/lib/bandwidth-sdk/models/conference_created_callback.rb +255 -0
- data/lib/bandwidth-sdk/models/conference_member.rb +266 -0
- data/lib/bandwidth-sdk/models/conference_member_exit_callback.rb +285 -0
- data/lib/bandwidth-sdk/models/conference_member_join_callback.rb +285 -0
- data/lib/bandwidth-sdk/models/conference_recording_available_callback.rb +367 -0
- data/lib/bandwidth-sdk/models/conference_recording_metadata.rb +335 -0
- data/lib/bandwidth-sdk/models/conference_redirect_callback.rb +255 -0
- data/lib/bandwidth-sdk/models/conference_state_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/create_call.rb +687 -0
- data/lib/bandwidth-sdk/models/create_call_response.rb +559 -0
- data/lib/bandwidth-sdk/models/create_lookup_response.rb +245 -0
- data/lib/bandwidth-sdk/models/create_message_request_error.rb +246 -0
- data/lib/bandwidth-sdk/models/deferred_result.rb +221 -0
- data/lib/bandwidth-sdk/models/disconenct_callback.rb +405 -0
- data/lib/bandwidth-sdk/models/disconnect_callback.rb +400 -0
- data/lib/bandwidth-sdk/models/diversion.rb +273 -0
- data/lib/bandwidth-sdk/models/dtmf_callback.rb +398 -0
- data/lib/bandwidth-sdk/models/field_error.rb +223 -0
- data/lib/bandwidth-sdk/models/file_format_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/gather_callback.rb +408 -0
- data/lib/bandwidth-sdk/models/inbound_message_callback.rb +284 -0
- data/lib/bandwidth-sdk/models/inbound_message_callback_message.rb +411 -0
- data/lib/bandwidth-sdk/models/initiate_callback.rb +343 -0
- data/lib/bandwidth-sdk/models/list_message_direction_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/list_message_item.rb +398 -0
- data/lib/bandwidth-sdk/models/lookup_request.rb +222 -0
- data/lib/bandwidth-sdk/models/lookup_result.rb +294 -0
- data/lib/bandwidth-sdk/models/lookup_status.rb +269 -0
- data/lib/bandwidth-sdk/models/lookup_status_enum.rb +42 -0
- data/lib/bandwidth-sdk/models/machine_detection_complete_callback.rb +368 -0
- data/lib/bandwidth-sdk/models/machine_detection_configuration.rb +493 -0
- data/lib/bandwidth-sdk/models/machine_detection_mode_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/machine_detection_result.rb +224 -0
- data/lib/bandwidth-sdk/models/media.rb +230 -0
- data/lib/bandwidth-sdk/models/message.rb +377 -0
- data/lib/bandwidth-sdk/models/message_delivered_callback.rb +284 -0
- data/lib/bandwidth-sdk/models/message_delivered_callback_message.rb +418 -0
- data/lib/bandwidth-sdk/models/message_direction_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/message_failed_callback.rb +300 -0
- data/lib/bandwidth-sdk/models/message_failed_callback_message.rb +425 -0
- data/lib/bandwidth-sdk/models/message_request.rb +358 -0
- data/lib/bandwidth-sdk/models/message_sending_callback.rb +284 -0
- data/lib/bandwidth-sdk/models/message_sending_callback_message.rb +425 -0
- data/lib/bandwidth-sdk/models/message_status_enum.rb +46 -0
- data/lib/bandwidth-sdk/models/message_type_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/messages_list.rb +233 -0
- data/lib/bandwidth-sdk/models/messaging_code_response.rb +213 -0
- data/lib/bandwidth-sdk/models/messaging_request_error.rb +235 -0
- data/lib/bandwidth-sdk/models/mfa_forbidden_request_error.rb +213 -0
- data/lib/bandwidth-sdk/models/mfa_request_error.rb +223 -0
- data/lib/bandwidth-sdk/models/mfa_unauthorized_request_error.rb +213 -0
- data/lib/bandwidth-sdk/models/page_info.rb +243 -0
- data/lib/bandwidth-sdk/models/priority_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/recording_available_callback.rb +447 -0
- data/lib/bandwidth-sdk/models/recording_complete_callback.rb +448 -0
- data/lib/bandwidth-sdk/models/recording_state_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/redirect_callback.rb +388 -0
- data/lib/bandwidth-sdk/models/redirect_method_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/stir_shaken.rb +233 -0
- data/lib/bandwidth-sdk/models/tag.rb +221 -0
- data/lib/bandwidth-sdk/models/tn_lookup_request_error.rb +213 -0
- data/lib/bandwidth-sdk/models/transcribe_recording.rb +360 -0
- data/lib/bandwidth-sdk/models/transcription.rb +223 -0
- data/lib/bandwidth-sdk/models/transcription_available_callback.rb +436 -0
- data/lib/bandwidth-sdk/models/transcription_list.rb +214 -0
- data/lib/bandwidth-sdk/models/transcription_metadata.rb +244 -0
- data/lib/bandwidth-sdk/models/transfer_answer_callback.rb +378 -0
- data/lib/bandwidth-sdk/models/transfer_complete_callback.rb +410 -0
- data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +430 -0
- data/lib/bandwidth-sdk/models/update_call.rb +413 -0
- data/lib/bandwidth-sdk/models/update_call_recording.rb +241 -0
- data/lib/bandwidth-sdk/models/update_conference.rb +387 -0
- data/lib/bandwidth-sdk/models/update_conference_member.rb +236 -0
- data/lib/bandwidth-sdk/models/verify_code_request.rb +341 -0
- data/lib/bandwidth-sdk/models/verify_code_response.rb +213 -0
- data/lib/bandwidth-sdk/models/voice_api_error.rb +231 -0
- data/lib/bandwidth-sdk/models/voice_code_response.rb +213 -0
- data/lib/bandwidth-sdk/version.rb +15 -0
- data/lib/bandwidth-sdk.rb +170 -0
- data/openapi-config.yml +12 -0
- data/openapitools.json +7 -0
- data/spec/api/calls_api_spec.rb +230 -0
- data/spec/api/conferences_api_spec.rb +393 -0
- data/spec/api/media_api_spec.rb +129 -0
- data/spec/api/messages_api_spec.rb +193 -0
- data/spec/api/mfa_api_spec.rb +130 -0
- data/spec/api/phone_number_lookup_api_spec.rb +100 -0
- data/spec/api/recordings_api_spec.rb +395 -0
- data/spec/api/statistics_api_spec.rb +45 -0
- data/spec/api_client_spec.rb +377 -0
- data/spec/api_error_spec.rb +23 -0
- data/spec/call_utils.rb +74 -0
- data/spec/configuration_spec.rb +190 -0
- data/spec/fixtures/ruby_cat.jpeg +0 -0
- data/spec/integration/calls_api_integration_spec.rb +202 -0
- data/spec/integration/conferences_api_integration_spec.rb +169 -0
- data/spec/integration/media_api_integration_spec.rb +92 -0
- data/spec/integration/messages_api_integration_spec.rb +138 -0
- data/spec/integration/mfa_api_integration_spec.rb +117 -0
- data/spec/integration/phone_number_lookup_api_integration_spec.rb +96 -0
- data/spec/integration/recordings_api_integration_spec.rb +226 -0
- data/spec/integration/statistics_api_integration_spec.rb +58 -0
- data/spec/models/bxml/bxml_spec.rb +16 -0
- data/spec/models/bxml/nestable_verb_spec.rb +11 -0
- data/spec/models/bxml/response_spec.rb +16 -0
- data/spec/models/bxml/verb_spec.rb +15 -0
- data/spec/models/bxml/verbs/bridge_spec.rb +58 -0
- data/spec/models/bxml/verbs/conference_spec.rb +58 -0
- data/spec/models/bxml/verbs/custom_param_spec.rb +36 -0
- data/spec/models/bxml/verbs/forward_spec.rb +44 -0
- data/spec/models/bxml/verbs/gather_spec.rb +86 -0
- data/spec/models/bxml/verbs/hangup_spec.rb +16 -0
- data/spec/models/bxml/verbs/pause_recording_spec.rb +16 -0
- data/spec/models/bxml/verbs/pause_spec.rb +34 -0
- data/spec/models/bxml/verbs/phone_number_spec.rb +54 -0
- data/spec/models/bxml/verbs/play_audio_spec.rb +36 -0
- data/spec/models/bxml/verbs/record_spec.rb +68 -0
- data/spec/models/bxml/verbs/redirect_spec.rb +50 -0
- data/spec/models/bxml/verbs/resume_recording_spec.rb +16 -0
- data/spec/models/bxml/verbs/ring_spec.rb +36 -0
- data/spec/models/bxml/verbs/send_dtmf_spec.rb +36 -0
- data/spec/models/bxml/verbs/sip_uri_spec.rb +56 -0
- data/spec/models/bxml/verbs/speak_sentence_spec.rb +38 -0
- data/spec/models/bxml/verbs/start_gather_spec.rb +42 -0
- data/spec/models/bxml/verbs/start_recording_spec.rb +52 -0
- data/spec/models/bxml/verbs/start_stream_spec.rb +72 -0
- data/spec/models/bxml/verbs/start_transcription_spec.rb +74 -0
- data/spec/models/bxml/verbs/stop_gather_spec.rb +16 -0
- data/spec/models/bxml/verbs/stop_recording_spec.rb +16 -0
- data/spec/models/bxml/verbs/stop_stream_spec.rb +34 -0
- data/spec/models/bxml/verbs/stop_transcription_spec.rb +34 -0
- data/spec/models/bxml/verbs/stream_param_spec.rb +36 -0
- data/spec/models/bxml/verbs/tag_spec.rb +16 -0
- data/spec/models/bxml/verbs/transfer_spec.rb +84 -0
- data/spec/models/call_state_enum_spec.rb +16 -0
- data/spec/models/call_state_spec.rb +168 -0
- data/spec/models/deferred_result_spec.rb +74 -0
- data/spec/models/message_spec.rb +138 -0
- data/spec/models/verify_code_request_spec.rb +126 -0
- data/spec/spec_helper.rb +171 -0
- metadata +430 -276
- data/LICENSE +0 -28
- data/lib/bandwidth/api_helper.rb +0 -280
- data/lib/bandwidth/client.rb +0 -75
- data/lib/bandwidth/configuration.rb +0 -209
- data/lib/bandwidth/exceptions/api_exception.rb +0 -20
- data/lib/bandwidth/http/api_response.rb +0 -38
- data/lib/bandwidth/http/auth/messaging_basic_auth.rb +0 -22
- data/lib/bandwidth/http/auth/multi_factor_auth_basic_auth.rb +0 -22
- data/lib/bandwidth/http/auth/phone_number_lookup_basic_auth.rb +0 -22
- data/lib/bandwidth/http/auth/voice_basic_auth.rb +0 -22
- data/lib/bandwidth/http/auth/web_rtc_basic_auth.rb +0 -22
- data/lib/bandwidth/http/faraday_client.rb +0 -73
- data/lib/bandwidth/http/http_call_back.rb +0 -24
- data/lib/bandwidth/http/http_client.rb +0 -104
- data/lib/bandwidth/http/http_method_enum.rb +0 -13
- data/lib/bandwidth/http/http_request.rb +0 -50
- data/lib/bandwidth/http/http_response.rb +0 -29
- data/lib/bandwidth/messaging_lib/messaging/client.rb +0 -60
- data/lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb +0 -491
- data/lib/bandwidth/messaging_lib/messaging/controllers/base_controller.rb +0 -47
- data/lib/bandwidth/messaging_lib/messaging/exceptions/messaging_exception.rb +0 -37
- data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_callback_message.rb +0 -100
- data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message.rb +0 -164
- data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message_item.rb +0 -203
- data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_messages_list.rb +0 -79
- data/lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb +0 -60
- data/lib/bandwidth/messaging_lib/messaging/models/media.rb +0 -70
- data/lib/bandwidth/messaging_lib/messaging/models/message_request.rb +0 -111
- data/lib/bandwidth/messaging_lib/messaging/models/page_info.rb +0 -82
- data/lib/bandwidth/messaging_lib/messaging/models/priority_enum.rb +0 -19
- data/lib/bandwidth/messaging_lib/messaging/models/tag.rb +0 -60
- data/lib/bandwidth/messaging_lib/messaging.rb +0 -25
- data/lib/bandwidth/models/base_model.rb +0 -58
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/client.rb +0 -60
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/controllers/base_controller.rb +0 -47
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/controllers/mfa_controller.rb +0 -214
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/error_with_request_exception.rb +0 -37
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/forbidden_request_exception.rb +0 -32
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/unauthorized_request_exception.rb +0 -32
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_code_request_schema.rb +0 -103
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_messaging_response.rb +0 -50
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_verify_code_response.rb +0 -50
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_verify_request_schema.rb +0 -94
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_voice_response.rb +0 -50
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth.rb +0 -23
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/client.rb +0 -60
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/controllers/api_controller.rb +0 -1553
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/controllers/base_controller.rb +0 -47
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/exceptions/accounts_tnlookup400_error_exception.rb +0 -32
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_request.rb +0 -50
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb +0 -61
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_status.rb +0 -95
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/result.rb +0 -132
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup.rb +0 -20
- data/lib/bandwidth/utilities/date_time_helper.rb +0 -156
- data/lib/bandwidth/utilities/file_wrapper.rb +0 -16
- data/lib/bandwidth/voice_lib/bxml/bxml.rb +0 -36
- data/lib/bandwidth/voice_lib/bxml/response.rb +0 -39
- data/lib/bandwidth/voice_lib/bxml/verbs/bridge.rb +0 -28
- data/lib/bandwidth/voice_lib/bxml/verbs/conference.rb +0 -32
- data/lib/bandwidth/voice_lib/bxml/verbs/forward.rb +0 -18
- data/lib/bandwidth/voice_lib/bxml/verbs/gather.rb +0 -49
- data/lib/bandwidth/voice_lib/bxml/verbs/hangup.rb +0 -14
- data/lib/bandwidth/voice_lib/bxml/verbs/pause.rb +0 -15
- data/lib/bandwidth/voice_lib/bxml/verbs/pause_recording.rb +0 -14
- data/lib/bandwidth/voice_lib/bxml/verbs/phone_number.rb +0 -24
- data/lib/bandwidth/voice_lib/bxml/verbs/play_audio.rb +0 -17
- data/lib/bandwidth/voice_lib/bxml/verbs/record.rb +0 -33
- data/lib/bandwidth/voice_lib/bxml/verbs/redirect.rb +0 -24
- data/lib/bandwidth/voice_lib/bxml/verbs/resume_recording.rb +0 -14
- data/lib/bandwidth/voice_lib/bxml/verbs/ring.rb +0 -16
- data/lib/bandwidth/voice_lib/bxml/verbs/send_dtmf.rb +0 -16
- data/lib/bandwidth/voice_lib/bxml/verbs/sip_uri.rb +0 -25
- data/lib/bandwidth/voice_lib/bxml/verbs/speak_sentence.rb +0 -18
- data/lib/bandwidth/voice_lib/bxml/verbs/start_gather.rb +0 -20
- data/lib/bandwidth/voice_lib/bxml/verbs/start_recording.rb +0 -25
- data/lib/bandwidth/voice_lib/bxml/verbs/stop_gather.rb +0 -14
- data/lib/bandwidth/voice_lib/bxml/verbs/stop_recording.rb +0 -14
- data/lib/bandwidth/voice_lib/bxml/verbs/tag.rb +0 -13
- data/lib/bandwidth/voice_lib/bxml/verbs/transfer.rb +0 -48
- data/lib/bandwidth/voice_lib/bxml/verbs/xml_verb.rb +0 -26
- data/lib/bandwidth/voice_lib/voice/client.rb +0 -60
- data/lib/bandwidth/voice_lib/voice/controllers/api_controller.rb +0 -1820
- data/lib/bandwidth/voice_lib/voice/controllers/base_controller.rb +0 -47
- data/lib/bandwidth/voice_lib/voice/exceptions/api_error_exception.rb +0 -42
- data/lib/bandwidth/voice_lib/voice/models/answer_fallback_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/answer_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/call_callback.rb +0 -343
- data/lib/bandwidth/voice_lib/voice/models/call_recording_metadata.rb +0 -250
- data/lib/bandwidth/voice_lib/voice/models/call_state.rb +0 -301
- data/lib/bandwidth/voice_lib/voice/models/callback_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/conference_callback.rb +0 -211
- data/lib/bandwidth/voice_lib/voice/models/conference_event_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/conference_member_state.rb +0 -103
- data/lib/bandwidth/voice_lib/voice/models/conference_recording_metadata.rb +0 -173
- data/lib/bandwidth/voice_lib/voice/models/conference_state.rb +0 -153
- data/lib/bandwidth/voice_lib/voice/models/create_call_request.rb +0 -236
- data/lib/bandwidth/voice_lib/voice/models/create_call_response.rb +0 -266
- data/lib/bandwidth/voice_lib/voice/models/direction_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/disconnect_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/diversion.rb +0 -80
- data/lib/bandwidth/voice_lib/voice/models/fallback_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/file_format_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/machine_detection_configuration.rb +0 -231
- data/lib/bandwidth/voice_lib/voice/models/mode_enum.rb +0 -20
- data/lib/bandwidth/voice_lib/voice/models/modify_call_recording_request.rb +0 -48
- data/lib/bandwidth/voice_lib/voice/models/modify_call_request.rb +0 -156
- data/lib/bandwidth/voice_lib/voice/models/modify_conference_request.rb +0 -144
- data/lib/bandwidth/voice_lib/voice/models/redirect_fallback_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/redirect_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/state1_enum.rb +0 -20
- data/lib/bandwidth/voice_lib/voice/models/state_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/status_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/transcribe_recording_request.rb +0 -108
- data/lib/bandwidth/voice_lib/voice/models/transcript.rb +0 -60
- data/lib/bandwidth/voice_lib/voice/models/transcription.rb +0 -80
- data/lib/bandwidth/voice_lib/voice/models/transcription_metadata.rb +0 -89
- data/lib/bandwidth/voice_lib/voice/models/transcription_response.rb +0 -59
- data/lib/bandwidth/voice_lib/voice.rb +0 -48
- data/lib/bandwidth/web_rtc_lib/utils/web_rtc_transfer.rb +0 -18
- data/lib/bandwidth/web_rtc_lib/web_rtc/client.rb +0 -60
- data/lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb +0 -703
- data/lib/bandwidth/web_rtc_lib/web_rtc/controllers/base_controller.rb +0 -47
- data/lib/bandwidth/web_rtc_lib/web_rtc/exceptions/error_exception.rb +0 -37
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/accounts_participants_response.rb +0 -62
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/device_api_version_enum.rb +0 -17
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/participant.rb +0 -115
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb +0 -48
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/publish_permission_enum.rb +0 -17
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb +0 -60
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/subscriptions.rb +0 -71
- data/lib/bandwidth/web_rtc_lib/web_rtc.rb +0 -22
- data/lib/bandwidth.rb +0 -73
- data/test/controllers/controller_test_base.rb +0 -21
- data/test/http_response_catcher.rb +0 -19
- data/test/integration/test_integration.rb +0 -691
- data/test/test_helper.rb +0 -94
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
# {{gemName}}
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/rb/bandwidth-sdk)
|
|
4
|
+
[](https://github.com/Bandwidth/ruby-sdk/actions/workflows/test-nightly.yml)
|
|
5
|
+
[](https://github.com/rubocop/rubocop)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
| **OS** | **Ruby** |
|
|
9
|
+
|:---:|:---:|
|
|
10
|
+
| Windows 2019 | 2.7, 3.0, 3.1, 3.2 |
|
|
11
|
+
| Windows 2022 | 2.7, 3.0, 3.1, 3.2 |
|
|
12
|
+
| Ubuntu 20.04 | 2.7, 3.0, 3.1, 3.2 |
|
|
13
|
+
| Ubuntu 22.04 | 2.7, 3.0, 3.1, 3.2 |
|
|
14
|
+
|
|
15
|
+
{{moduleName}} - the Ruby gem for the {{appName}}
|
|
16
|
+
|
|
17
|
+
# Generated with the command:
|
|
18
|
+
`openapi-generator generate -g ruby -i bandwidth.yml -c openapi-config.yml -o ./`
|
|
19
|
+
|
|
20
|
+
{{#appDescriptionWithNewLines}}
|
|
21
|
+
{{{.}}}
|
|
22
|
+
{{/appDescriptionWithNewLines}}
|
|
23
|
+
|
|
24
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
25
|
+
|
|
26
|
+
- API version: {{appVersion}}
|
|
27
|
+
- Package version: {{gemVersion}}
|
|
28
|
+
{{^hideGenerationTimestamp}}
|
|
29
|
+
- Build date: {{generatedDate}}
|
|
30
|
+
{{/hideGenerationTimestamp}}
|
|
31
|
+
- Build package: {{generatorClass}}
|
|
32
|
+
{{#infoUrl}}
|
|
33
|
+
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
|
|
34
|
+
{{/infoUrl}}
|
|
35
|
+
|
|
36
|
+
## Installation
|
|
37
|
+
|
|
38
|
+
### Build a gem
|
|
39
|
+
|
|
40
|
+
To build the Ruby code into a gem:
|
|
41
|
+
|
|
42
|
+
```shell
|
|
43
|
+
gem build {{{gemName}}}.gemspec
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Then either install the gem locally:
|
|
47
|
+
|
|
48
|
+
```shell
|
|
49
|
+
gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
(for development, run `gem install --dev ./{{{gemName}}}-{{{gemVersion}}}.gem` to install the development dependencies)
|
|
53
|
+
|
|
54
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
55
|
+
|
|
56
|
+
Finally add this to the Gemfile:
|
|
57
|
+
|
|
58
|
+
gem '{{{gemName}}}', '~> {{{gemVersion}}}'
|
|
59
|
+
|
|
60
|
+
### Install from Git
|
|
61
|
+
|
|
62
|
+
If the Ruby gem is hosted at a git repository: https://{{gitHost}}/{{gitUserId}}{{^gitUserId}}YOUR_GIT_USERNAME{{/gitUserId}}/{{gitRepoId}}{{^gitRepoId}}YOUR_GIT_REPO{{/gitRepoId}}, then add the following in the Gemfile:
|
|
63
|
+
|
|
64
|
+
gem '{{{gemName}}}', :git => 'https://{{gitHost}}/{{gitUserId}}{{^gitUserId}}YOUR_GIT_USERNAME{{/gitUserId}}/{{gitRepoId}}{{^gitRepoId}}YOUR_GIT_REPO{{/gitRepoId}}.git'
|
|
65
|
+
|
|
66
|
+
### Include the Ruby code directly
|
|
67
|
+
|
|
68
|
+
Include the Ruby code directly using `-I` as follows:
|
|
69
|
+
|
|
70
|
+
```shell
|
|
71
|
+
ruby -Ilib script.rb
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Getting Started
|
|
75
|
+
|
|
76
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
77
|
+
|
|
78
|
+
```ruby
|
|
79
|
+
# Load the gem
|
|
80
|
+
require '{{{gemName}}}'
|
|
81
|
+
{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}
|
|
82
|
+
# Setup authorization
|
|
83
|
+
{{{moduleName}}}.configure do |config|{{#authMethods}}{{#isBasic}}{{#isBasicBasic}}
|
|
84
|
+
# Configure HTTP basic authorization: {{{name}}}
|
|
85
|
+
config.username = 'YOUR_USERNAME'
|
|
86
|
+
config.password = 'YOUR_PASSWORD'{{/isBasicBasic}}{{#isBasicBearer}}
|
|
87
|
+
# Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}}
|
|
88
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
89
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
|
90
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
|
|
91
|
+
# Configure API key authorization: {{{name}}}
|
|
92
|
+
config.api_key['{{{name}}}'] = 'YOUR API KEY'
|
|
93
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
94
|
+
# config.api_key_prefix['{{{name}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
|
|
95
|
+
# Configure OAuth2 access token for authorization: {{{name}}}
|
|
96
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
97
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
|
98
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isOAuth}}
|
|
99
|
+
{{#isFaraday}}
|
|
100
|
+
# Configure faraday connection
|
|
101
|
+
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
|
102
|
+
{{/isFaraday}}
|
|
103
|
+
{{/authMethods}}end
|
|
104
|
+
{{/hasAuthMethods}}
|
|
105
|
+
|
|
106
|
+
api_instance = {{{moduleName}}}::{{{classname}}}.new
|
|
107
|
+
{{#requiredParams}}
|
|
108
|
+
{{{paramName}}} = {{{vendorExtensions.x-ruby-example}}} # {{{dataType}}} | {{{description}}}
|
|
109
|
+
{{/requiredParams}}
|
|
110
|
+
{{#optionalParams}}
|
|
111
|
+
{{#-first}}
|
|
112
|
+
opts = {
|
|
113
|
+
{{/-first}}
|
|
114
|
+
{{{paramName}}}: {{{vendorExtensions.x-ruby-example}}}{{^-last}},{{/-last}} # {{{dataType}}} | {{{description}}}
|
|
115
|
+
{{#-last}}
|
|
116
|
+
}
|
|
117
|
+
{{/-last}}
|
|
118
|
+
{{/optionalParams}}
|
|
119
|
+
|
|
120
|
+
begin
|
|
121
|
+
{{#summary}} #{{{.}}}
|
|
122
|
+
{{/summary}} {{#returnType}}result = {{/returnType}}api_instance.{{{operationId}}}{{#hasParams}}({{#requiredParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#optionalParams}}{{#-last}}{{#hasRequiredParams}}, {{/hasRequiredParams}}opts{{/-last}}{{/optionalParams}}){{/hasParams}}{{#returnType}}
|
|
123
|
+
p result{{/returnType}}
|
|
124
|
+
rescue {{{moduleName}}}::ApiError => e
|
|
125
|
+
puts "Exception when calling {{classname}}->{{{operationId}}}: #{e}"
|
|
126
|
+
end
|
|
127
|
+
{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## Documentation for API Endpoints
|
|
131
|
+
|
|
132
|
+
All URIs are relative to *{{basePath}}*
|
|
133
|
+
|
|
134
|
+
Class | Method | HTTP request | Description
|
|
135
|
+
------------ | ------------- | ------------- | -------------
|
|
136
|
+
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{moduleName}}::{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{{summary}}}
|
|
137
|
+
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
|
138
|
+
|
|
139
|
+
## Documentation for Models
|
|
140
|
+
|
|
141
|
+
{{#models}}{{#model}} - [{{moduleName}}::{{classname}}]({{modelDocPath}}{{classname}}.md)
|
|
142
|
+
{{/model}}{{/models}}
|
|
143
|
+
|
|
144
|
+
## Documentation for Authorization
|
|
145
|
+
|
|
146
|
+
{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
|
|
147
|
+
{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
|
|
148
|
+
{{#authMethods}}
|
|
149
|
+
### {{name}}
|
|
150
|
+
|
|
151
|
+
{{#isApiKey}}
|
|
152
|
+
|
|
153
|
+
- **Type**: API key
|
|
154
|
+
- **API key parameter name**: {{keyParamName}}
|
|
155
|
+
- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
|
|
156
|
+
{{/isApiKey}}
|
|
157
|
+
{{#isBasic}}
|
|
158
|
+
{{#isBasicBasic}}- **Type**: HTTP basic authentication
|
|
159
|
+
{{/isBasicBasic}}{{#isBasicBearer}}- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
|
|
160
|
+
{{/isBasicBearer}}{{#isHttpSignature}}- **Type**: HTTP signature authentication
|
|
161
|
+
{{/isHttpSignature}}
|
|
162
|
+
{{/isBasic}}
|
|
163
|
+
{{#isOAuth}}
|
|
164
|
+
|
|
165
|
+
- **Type**: OAuth
|
|
166
|
+
- **Flow**: {{flow}}
|
|
167
|
+
- **Authorization URL**: {{authorizationUrl}}
|
|
168
|
+
- **Scopes**: {{^scopes}}N/A{{/scopes}}
|
|
169
|
+
{{#scopes}} - {{scope}}: {{description}}
|
|
170
|
+
{{/scopes}}
|
|
171
|
+
{{/isOAuth}}
|
|
172
|
+
|
|
173
|
+
{{/authMethods}}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
{{> api_info}}
|
|
3
|
+
=end
|
|
4
|
+
|
|
5
|
+
# Common files
|
|
6
|
+
require '{{gemName}}/api_client'
|
|
7
|
+
require '{{gemName}}/api_error'
|
|
8
|
+
require '{{gemName}}/version'
|
|
9
|
+
require '{{gemName}}/configuration'
|
|
10
|
+
|
|
11
|
+
# Models
|
|
12
|
+
{{^useAutoload}}
|
|
13
|
+
{{#models}}
|
|
14
|
+
{{#model}}
|
|
15
|
+
{{^parent}}
|
|
16
|
+
require '{{gemName}}/{{modelPackage}}/{{classFilename}}'
|
|
17
|
+
{{/parent}}
|
|
18
|
+
{{/model}}
|
|
19
|
+
{{/models}}
|
|
20
|
+
{{#models}}
|
|
21
|
+
{{#model}}
|
|
22
|
+
{{#parent}}
|
|
23
|
+
require '{{gemName}}/{{modelPackage}}/{{classFilename}}'
|
|
24
|
+
{{/parent}}
|
|
25
|
+
{{/model}}
|
|
26
|
+
{{/models}}
|
|
27
|
+
{{/useAutoload}}
|
|
28
|
+
{{#useAutoload}}
|
|
29
|
+
{{#models}}
|
|
30
|
+
{{#model}}
|
|
31
|
+
{{moduleName}}.autoload :{{classname}}, '{{gemName}}/{{modelPackage}}/{{classFilename}}'
|
|
32
|
+
{{/model}}
|
|
33
|
+
{{/models}}
|
|
34
|
+
{{/useAutoload}}
|
|
35
|
+
|
|
36
|
+
# BXML
|
|
37
|
+
require 'bandwidth-sdk/models/bxml/root'
|
|
38
|
+
require 'bandwidth-sdk/models/bxml/bxml'
|
|
39
|
+
require 'bandwidth-sdk/models/bxml/response'
|
|
40
|
+
require 'bandwidth-sdk/models/bxml/verb'
|
|
41
|
+
require 'bandwidth-sdk/models/bxml/nestable_verb'
|
|
42
|
+
require 'bandwidth-sdk/models/bxml/verbs/bridge'
|
|
43
|
+
require 'bandwidth-sdk/models/bxml/verbs/conference'
|
|
44
|
+
require 'bandwidth-sdk/models/bxml/verbs/custom_param'
|
|
45
|
+
require 'bandwidth-sdk/models/bxml/verbs/forward'
|
|
46
|
+
require 'bandwidth-sdk/models/bxml/verbs/gather'
|
|
47
|
+
require 'bandwidth-sdk/models/bxml/verbs/hangup'
|
|
48
|
+
require 'bandwidth-sdk/models/bxml/verbs/pause_recording'
|
|
49
|
+
require 'bandwidth-sdk/models/bxml/verbs/pause'
|
|
50
|
+
require 'bandwidth-sdk/models/bxml/verbs/phone_number'
|
|
51
|
+
require 'bandwidth-sdk/models/bxml/verbs/play_audio'
|
|
52
|
+
require 'bandwidth-sdk/models/bxml/verbs/record'
|
|
53
|
+
require 'bandwidth-sdk/models/bxml/verbs/redirect'
|
|
54
|
+
require 'bandwidth-sdk/models/bxml/verbs/resume_recording'
|
|
55
|
+
require 'bandwidth-sdk/models/bxml/verbs/ring'
|
|
56
|
+
require 'bandwidth-sdk/models/bxml/verbs/send_dtmf'
|
|
57
|
+
require 'bandwidth-sdk/models/bxml/verbs/sip_uri'
|
|
58
|
+
require 'bandwidth-sdk/models/bxml/verbs/speak_sentence'
|
|
59
|
+
require 'bandwidth-sdk/models/bxml/verbs/start_gather'
|
|
60
|
+
require 'bandwidth-sdk/models/bxml/verbs/start_recording'
|
|
61
|
+
require 'bandwidth-sdk/models/bxml/verbs/start_stream'
|
|
62
|
+
require 'bandwidth-sdk/models/bxml/verbs/start_transcription'
|
|
63
|
+
require 'bandwidth-sdk/models/bxml/verbs/stop_gather'
|
|
64
|
+
require 'bandwidth-sdk/models/bxml/verbs/stop_recording'
|
|
65
|
+
require 'bandwidth-sdk/models/bxml/verbs/stop_stream'
|
|
66
|
+
require 'bandwidth-sdk/models/bxml/verbs/stop_transcription'
|
|
67
|
+
require 'bandwidth-sdk/models/bxml/verbs/stream_param'
|
|
68
|
+
require 'bandwidth-sdk/models/bxml/verbs/tag'
|
|
69
|
+
require 'bandwidth-sdk/models/bxml/verbs/transfer'
|
|
70
|
+
|
|
71
|
+
# APIs
|
|
72
|
+
{{#apiInfo}}
|
|
73
|
+
{{#apis}}
|
|
74
|
+
{{^useAutoload}}
|
|
75
|
+
require '{{importPath}}'
|
|
76
|
+
{{/useAutoload}}
|
|
77
|
+
{{#useAutoload}}
|
|
78
|
+
{{moduleName}}.autoload :{{classname}}, '{{importPath}}'
|
|
79
|
+
{{/useAutoload}}
|
|
80
|
+
{{/apis}}
|
|
81
|
+
{{/apiInfo}}
|
|
82
|
+
|
|
83
|
+
module {{moduleName}}
|
|
84
|
+
class << self
|
|
85
|
+
# Customize default settings for the SDK using block.
|
|
86
|
+
# {{moduleName}}.configure do |config|
|
|
87
|
+
# config.username = "xxx"
|
|
88
|
+
# config.password = "xxx"
|
|
89
|
+
# end
|
|
90
|
+
# If no block given, return the default Configuration object.
|
|
91
|
+
def configure
|
|
92
|
+
if block_given?
|
|
93
|
+
yield(Configuration.default)
|
|
94
|
+
else
|
|
95
|
+
Configuration.default
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
end
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
|
2
|
+
|
|
3
|
+
=begin
|
|
4
|
+
{{> api_info}}
|
|
5
|
+
=end
|
|
6
|
+
|
|
7
|
+
$:.push File.expand_path("../lib", __FILE__)
|
|
8
|
+
require "{{gemName}}/version"
|
|
9
|
+
|
|
10
|
+
Gem::Specification.new do |s|
|
|
11
|
+
s.name = "{{gemName}}{{^gemName}}{{{appName}}}{{/gemName}}"
|
|
12
|
+
s.version = {{moduleName}}::VERSION
|
|
13
|
+
s.platform = Gem::Platform::RUBY
|
|
14
|
+
s.authors = ["{{gemAuthor}}{{^gemAuthor}}OpenAPI-Generator{{/gemAuthor}}"]
|
|
15
|
+
s.email = ["{{gemAuthorEmail}}{{^gemAuthorEmail}}{{infoEmail}}{{/gemAuthorEmail}}"]
|
|
16
|
+
s.homepage = "{{gemHomepage}}{{^gemHomepage}}https://openapi-generator.tech{{/gemHomepage}}"
|
|
17
|
+
s.summary = "{{gemSummary}}{{^gemSummary}}{{{appName}}} Ruby Gem{{/gemSummary}}"
|
|
18
|
+
s.description = "{{gemDescription}}{{^gemDescription}}{{{appDescription}}}{{^appDescription}}{{{appName}}} Ruby Gem{{/appDescription}}{{/gemDescription}}"
|
|
19
|
+
s.license = "{{{gemLicense}}}{{^gemLicense}}Unlicense{{/gemLicense}}"
|
|
20
|
+
s.required_ruby_version = "{{{gemRequiredRubyVersion}}}{{^gemRequiredRubyVersion}}>= 2.7{{/gemRequiredRubyVersion}}"
|
|
21
|
+
|
|
22
|
+
{{#isFaraday}}
|
|
23
|
+
s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
|
|
24
|
+
s.add_runtime_dependency 'faraday-multipart'
|
|
25
|
+
{{/isFaraday}}
|
|
26
|
+
{{^isFaraday}}
|
|
27
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
|
28
|
+
{{/isFaraday}}
|
|
29
|
+
s.add_runtime_dependency 'ox', '~> 2.4'
|
|
30
|
+
|
|
31
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
|
32
|
+
|
|
33
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
|
34
|
+
s.test_files = `find spec/*`.split("\n")
|
|
35
|
+
s.executables = []
|
|
36
|
+
s.require_paths = ["lib"]
|
|
37
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Bandwidth::AccountStatistics
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **current_call_queue_size** | **Integer** | The number of calls currently enqueued. | [optional] |
|
|
8
|
+
| **max_call_queue_size** | **Integer** | The maximum size of the queue before outgoing calls start being rejected. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'bandwidth-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Bandwidth::AccountStatistics.new(
|
|
16
|
+
current_call_queue_size: 0,
|
|
17
|
+
max_call_queue_size: 900
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Bandwidth::AnswerCallback
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_type** | **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] |
|
|
8
|
+
| **event_time** | **Time** | 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] |
|
|
9
|
+
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
|
10
|
+
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
|
|
11
|
+
| **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
|
|
12
|
+
| **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
|
|
13
|
+
| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
|
|
14
|
+
| **call_id** | **String** | The call id associated with the event. | [optional] |
|
|
15
|
+
| **call_url** | **String** | The URL of the call associated with the event. | [optional] |
|
|
16
|
+
| **enqueued_time** | **Time** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] |
|
|
17
|
+
| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
|
|
18
|
+
| **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
|
|
19
|
+
| **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] |
|
|
20
|
+
| **machine_detection_result** | [**MachineDetectionResult**](MachineDetectionResult.md) | | [optional] |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'bandwidth-sdk'
|
|
26
|
+
|
|
27
|
+
instance = Bandwidth::AnswerCallback.new(
|
|
28
|
+
event_type: bridgeComplete,
|
|
29
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
|
30
|
+
account_id: 920012,
|
|
31
|
+
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
|
32
|
+
from: +15555555555,
|
|
33
|
+
to: +15555555555,
|
|
34
|
+
direction: null,
|
|
35
|
+
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
36
|
+
call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
37
|
+
enqueued_time: 2022-06-17T22:20Z,
|
|
38
|
+
start_time: 2022-06-17T22:19:40.375Z,
|
|
39
|
+
answer_time: 2022-06-17T22:20Z,
|
|
40
|
+
tag: exampleTag,
|
|
41
|
+
machine_detection_result: null
|
|
42
|
+
)
|
|
43
|
+
```
|
|
44
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Bandwidth::BridgeCompleteCallback
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_type** | **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] |
|
|
8
|
+
| **event_time** | **Time** | 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] |
|
|
9
|
+
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
|
10
|
+
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
|
|
11
|
+
| **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
|
|
12
|
+
| **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
|
|
13
|
+
| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
|
|
14
|
+
| **call_id** | **String** | The call id associated with the event. | [optional] |
|
|
15
|
+
| **call_url** | **String** | The URL of the call associated with the event. | [optional] |
|
|
16
|
+
| **enqueued_time** | **Time** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] |
|
|
17
|
+
| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
|
|
18
|
+
| **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
|
|
19
|
+
| **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] |
|
|
20
|
+
| **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] |
|
|
21
|
+
| **error_message** | **String** | Text explaining the reason that caused the call to fail in case of errors. | [optional] |
|
|
22
|
+
| **error_id** | **String** | Bandwidth's internal id that references the error event. | [optional] |
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'bandwidth-sdk'
|
|
28
|
+
|
|
29
|
+
instance = Bandwidth::BridgeCompleteCallback.new(
|
|
30
|
+
event_type: bridgeComplete,
|
|
31
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
|
32
|
+
account_id: 920012,
|
|
33
|
+
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
|
34
|
+
from: +15555555555,
|
|
35
|
+
to: +15555555555,
|
|
36
|
+
direction: null,
|
|
37
|
+
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
38
|
+
call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
39
|
+
enqueued_time: 2022-06-17T22:20Z,
|
|
40
|
+
start_time: 2022-06-17T22:19:40.375Z,
|
|
41
|
+
answer_time: 2022-06-17T22:20Z,
|
|
42
|
+
tag: exampleTag,
|
|
43
|
+
cause: busy,
|
|
44
|
+
error_message: Call c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f is already bridged with another call,
|
|
45
|
+
error_id: 4642074b-7b58-478b-96e4-3a60955c6765
|
|
46
|
+
)
|
|
47
|
+
```
|
|
48
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Bandwidth::BridgeTargetCompleteCallback
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_type** | **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] |
|
|
8
|
+
| **event_time** | **Time** | 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] |
|
|
9
|
+
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
|
10
|
+
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
|
|
11
|
+
| **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
|
|
12
|
+
| **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
|
|
13
|
+
| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
|
|
14
|
+
| **call_id** | **String** | The call id associated with the event. | [optional] |
|
|
15
|
+
| **call_url** | **String** | The URL of the call associated with the event. | [optional] |
|
|
16
|
+
| **enqueued_time** | **Time** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] |
|
|
17
|
+
| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
|
|
18
|
+
| **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
|
|
19
|
+
| **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] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'bandwidth-sdk'
|
|
25
|
+
|
|
26
|
+
instance = Bandwidth::BridgeTargetCompleteCallback.new(
|
|
27
|
+
event_type: bridgeComplete,
|
|
28
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
|
29
|
+
account_id: 920012,
|
|
30
|
+
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
|
31
|
+
from: +15555555555,
|
|
32
|
+
to: +15555555555,
|
|
33
|
+
direction: null,
|
|
34
|
+
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
35
|
+
call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
36
|
+
enqueued_time: 2022-06-17T22:20Z,
|
|
37
|
+
start_time: 2022-06-17T22:19:40.375Z,
|
|
38
|
+
answer_time: 2022-06-17T22:20Z,
|
|
39
|
+
tag: exampleTag
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Bandwidth::CallRecordingMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
|
|
8
|
+
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
|
9
|
+
| **call_id** | **String** | The call id associated with the event. | [optional] |
|
|
10
|
+
| **parent_call_id** | **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] |
|
|
11
|
+
| **recording_id** | **String** | The unique ID of this recording | [optional] |
|
|
12
|
+
| **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
|
|
13
|
+
| **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
|
|
14
|
+
| **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] |
|
|
15
|
+
| **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
|
|
16
|
+
| **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
|
|
17
|
+
| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
|
|
18
|
+
| **channels** | **Integer** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] |
|
|
19
|
+
| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
|
|
20
|
+
| **end_time** | **Time** | The time that the recording ended in ISO-8601 format | [optional] |
|
|
21
|
+
| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] |
|
|
22
|
+
| **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] |
|
|
23
|
+
| **media_url** | **String** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] |
|
|
24
|
+
| **transcription** | [**TranscriptionMetadata**](TranscriptionMetadata.md) | | [optional] |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'bandwidth-sdk'
|
|
30
|
+
|
|
31
|
+
instance = Bandwidth::CallRecordingMetadata.new(
|
|
32
|
+
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
|
33
|
+
account_id: 920012,
|
|
34
|
+
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
35
|
+
parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
|
|
36
|
+
recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
|
|
37
|
+
to: +15555555555,
|
|
38
|
+
from: +15555555555,
|
|
39
|
+
transfer_caller_id: +15555555555,
|
|
40
|
+
transfer_to: +15555555555),
|
|
41
|
+
duration: PT13.67S,
|
|
42
|
+
direction: null,
|
|
43
|
+
channels: 1,
|
|
44
|
+
start_time: 2022-06-17T22:19:40.375Z,
|
|
45
|
+
end_time: 2022-06-17T22:20Z,
|
|
46
|
+
file_format: null,
|
|
47
|
+
status: completed,
|
|
48
|
+
media_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media,
|
|
49
|
+
transcription: null
|
|
50
|
+
)
|
|
51
|
+
```
|
|
52
|
+
|
data/docs/CallState.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Bandwidth::CallState
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **application_id** | **String** | The application id associated with the call. | [optional] |
|
|
8
|
+
| **account_id** | **String** | The account id associated with the call. | [optional] |
|
|
9
|
+
| **call_id** | **String** | The programmable voice API call ID. | [optional] |
|
|
10
|
+
| **parent_call_id** | **String** | The A-leg call id, set only if this call is the B-leg of a [`<Transfer>`](/docs/voice/bxml/transfer). | [optional] |
|
|
11
|
+
| **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] |
|
|
12
|
+
| **from** | **String** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] |
|
|
13
|
+
| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
|
|
14
|
+
| **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] |
|
|
15
|
+
| **stir_shaken** | **Hash<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] |
|
|
16
|
+
| **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] |
|
|
17
|
+
| **enqueued_time** | **Time** | The time this call was placed in queue. | [optional] |
|
|
18
|
+
| **start_time** | **Time** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] |
|
|
19
|
+
| **answer_time** | **Time** | Populated once the call has been answered, with the time in ISO 8601 format. | [optional] |
|
|
20
|
+
| **end_time** | **Time** | Populated once the call has ended, with the time in ISO 8601 format. | [optional] |
|
|
21
|
+
| **disconnect_cause** | **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] |
|
|
22
|
+
| **error_message** | **String** | Populated only if the call ended with an error, with text explaining the reason. | [optional] |
|
|
23
|
+
| **error_id** | **String** | Populated only if the call ended with an error, with a Bandwidth internal id that references the error event. | [optional] |
|
|
24
|
+
| **last_update** | **Time** | The last time the call had a state update, in ISO 8601 format. | [optional] |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'bandwidth-sdk'
|
|
30
|
+
|
|
31
|
+
instance = Bandwidth::CallState.new(
|
|
32
|
+
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
|
33
|
+
account_id: 9900000,
|
|
34
|
+
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
35
|
+
parent_call_id: c-25ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
36
|
+
to: +19195551234,
|
|
37
|
+
from: 19195554321,
|
|
38
|
+
direction: null,
|
|
39
|
+
state: disconnected,
|
|
40
|
+
stir_shaken: {"verstat":"TN-Verification-Passed","attestationIndicator":"A","originatingId":"abc123"},
|
|
41
|
+
identity: eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9idy1zaGFrZW4tY2VydC1wdWIuczMuYW1hem9uYXdzLmNvbS9iYW5kd2lkdGgtc2hha2VuLWNlcnRfMjAyMzA3MTYucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxOTg0MjgyMDI4MCJdfSwiaWF0IjoxNjU2NTM0MzM2LCJvcmlnIjp7InRuIjoiMTkxOTQ0NDI2ODMifSwib3JpZ2lkIjoiNDk0NTlhOGEtNDJmNi0zNTFjLTkzNjEtYWRmNTdhOWUwOGNhIn0.56un9sRw_uH-sbJvnUsqdevlVxbOVjn8MVlGTlBMicjaZuRRwxfiNp-C9zYCMKTTCbc-QdYPN05F61XNVN4D3w;info=<https://bw-shaken-cert-pub.s3.amazonaws.com/bandwidth-shaken-cert_20230716.pem>;alg=ES256;ppt=shaken,
|
|
42
|
+
enqueued_time: 2022-06-16T13:15:07.160Z,
|
|
43
|
+
start_time: 2022-06-16T13:15:07.160Z,
|
|
44
|
+
answer_time: 2022-06-16T13:15:18.126Z,
|
|
45
|
+
end_time: 2022-06-16T13:15:18.314Z,
|
|
46
|
+
disconnect_cause: null,
|
|
47
|
+
error_message: null,
|
|
48
|
+
error_id: null,
|
|
49
|
+
last_update: 2022-06-16T13:15:18.314Z
|
|
50
|
+
)
|
|
51
|
+
```
|
|
52
|
+
|