Module: Bandwidth

Defined in:
lib/bandwidth-sdk/version.rb,
lib/bandwidth-sdk.rb,
lib/bandwidth-sdk/api_error.rb,
lib/bandwidth-sdk/api_client.rb,
lib/bandwidth-sdk/models/tag.rb,
lib/bandwidth-sdk/api/mfa_api.rb,
lib/bandwidth-sdk/models/media.rb,
lib/bandwidth-sdk/api/calls_api.rb,
lib/bandwidth-sdk/api/media_api.rb,
lib/bandwidth-sdk/configuration.rb,
lib/bandwidth-sdk/models/message.rb,
lib/bandwidth-sdk/api/messages_api.rb,
lib/bandwidth-sdk/models/bxml/bxml.rb,
lib/bandwidth-sdk/models/bxml/root.rb,
lib/bandwidth-sdk/models/bxml/verb.rb,
lib/bandwidth-sdk/models/diversion.rb,
lib/bandwidth-sdk/models/page_info.rb,
lib/bandwidth-sdk/models/call_state.rb,
lib/bandwidth-sdk/models/conference.rb,
lib/bandwidth-sdk/api/recordings_api.rb,
lib/bandwidth-sdk/api/statistics_api.rb,
lib/bandwidth-sdk/models/create_call.rb,
lib/bandwidth-sdk/models/field_error.rb,
lib/bandwidth-sdk/models/stir_shaken.rb,
lib/bandwidth-sdk/models/update_call.rb,
lib/bandwidth-sdk/api/conferences_api.rb,
lib/bandwidth-sdk/models/code_request.rb,
lib/bandwidth-sdk/models/bxml/response.rb,
lib/bandwidth-sdk/models/dtmf_callback.rb,
lib/bandwidth-sdk/models/lookup_result.rb,
lib/bandwidth-sdk/models/lookup_status.rb,
lib/bandwidth-sdk/models/messages_list.rb,
lib/bandwidth-sdk/models/priority_enum.rb,
lib/bandwidth-sdk/models/transcription.rb,
lib/bandwidth-sdk/models/bxml/verbs/tag.rb,
lib/bandwidth-sdk/models/lookup_request.rb,
lib/bandwidth-sdk/models/answer_callback.rb,
lib/bandwidth-sdk/models/bxml/verbs/ring.rb,
lib/bandwidth-sdk/models/call_state_enum.rb,
lib/bandwidth-sdk/models/deferred_result.rb,
lib/bandwidth-sdk/models/gather_callback.rb,
lib/bandwidth-sdk/models/message_request.rb,
lib/bandwidth-sdk/models/voice_api_error.rb,
lib/bandwidth-sdk/models/bxml/verbs/pause.rb,
lib/bandwidth-sdk/models/file_format_enum.rb,
lib/bandwidth-sdk/models/bxml/verbs/bridge.rb,
lib/bandwidth-sdk/models/bxml/verbs/gather.rb,
lib/bandwidth-sdk/models/bxml/verbs/hangup.rb,
lib/bandwidth-sdk/models/bxml/verbs/record.rb,
lib/bandwidth-sdk/models/conference_member.rb,
lib/bandwidth-sdk/models/initiate_callback.rb,
lib/bandwidth-sdk/models/list_message_item.rb,
lib/bandwidth-sdk/models/message_type_enum.rb,
lib/bandwidth-sdk/models/mfa_request_error.rb,
lib/bandwidth-sdk/models/redirect_callback.rb,
lib/bandwidth-sdk/models/update_conference.rb,
lib/bandwidth-sdk/models/account_statistics.rb,
lib/bandwidth-sdk/models/bxml/nestable_verb.rb,
lib/bandwidth-sdk/models/bxml/verbs/forward.rb,
lib/bandwidth-sdk/models/bxml/verbs/sip_uri.rb,
lib/bandwidth-sdk/models/lookup_status_enum.rb,
lib/bandwidth-sdk/models/transcription_list.rb,
lib/bandwidth-sdk/models/bxml/verbs/redirect.rb,
lib/bandwidth-sdk/models/bxml/verbs/transfer.rb,
lib/bandwidth-sdk/models/call_direction_enum.rb,
lib/bandwidth-sdk/models/disconenct_callback.rb,
lib/bandwidth-sdk/models/disconnect_callback.rb,
lib/bandwidth-sdk/models/message_status_enum.rb,
lib/bandwidth-sdk/models/verify_code_request.rb,
lib/bandwidth-sdk/models/voice_code_response.rb,
lib/bandwidth-sdk/api/phone_number_lookup_api.rb,
lib/bandwidth-sdk/models/bxml/verbs/send_dtmf.rb,
lib/bandwidth-sdk/models/callback_method_enum.rb,
lib/bandwidth-sdk/models/create_call_response.rb,
lib/bandwidth-sdk/models/recording_state_enum.rb,
lib/bandwidth-sdk/models/redirect_method_enum.rb,
lib/bandwidth-sdk/models/transcribe_recording.rb,
lib/bandwidth-sdk/models/verify_code_response.rb,
lib/bandwidth-sdk/models/bxml/verbs/conference.rb,
lib/bandwidth-sdk/models/bxml/verbs/play_audio.rb,
lib/bandwidth-sdk/models/conference_state_enum.rb,
lib/bandwidth-sdk/models/update_call_recording.rb,
lib/bandwidth-sdk/models/bxml/verbs/stop_gather.rb,
lib/bandwidth-sdk/models/bxml/verbs/stop_stream.rb,
lib/bandwidth-sdk/models/create_lookup_response.rb,
lib/bandwidth-sdk/models/message_direction_enum.rb,
lib/bandwidth-sdk/models/transcription_metadata.rb,
lib/bandwidth-sdk/models/bxml/verbs/custom_param.rb,
lib/bandwidth-sdk/models/bxml/verbs/phone_number.rb,
lib/bandwidth-sdk/models/bxml/verbs/start_gather.rb,
lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb,
lib/bandwidth-sdk/models/bxml/verbs/stream_param.rb,
lib/bandwidth-sdk/models/call_recording_metadata.rb,
lib/bandwidth-sdk/models/message_failed_callback.rb,
lib/bandwidth-sdk/models/messaging_code_response.rb,
lib/bandwidth-sdk/models/messaging_request_error.rb,
lib/bandwidth-sdk/models/tn_lookup_request_error.rb,
lib/bandwidth-sdk/models/bridge_complete_callback.rb,
lib/bandwidth-sdk/models/inbound_message_callback.rb,
lib/bandwidth-sdk/models/machine_detection_result.rb,
lib/bandwidth-sdk/models/message_sending_callback.rb,
lib/bandwidth-sdk/models/transfer_answer_callback.rb,
lib/bandwidth-sdk/models/update_conference_member.rb,
lib/bandwidth-sdk/models/bxml/verbs/speak_sentence.rb,
lib/bandwidth-sdk/models/bxml/verbs/stop_recording.rb,
lib/bandwidth-sdk/models/bxml/verbs/pause_recording.rb,
lib/bandwidth-sdk/models/bxml/verbs/start_recording.rb,
lib/bandwidth-sdk/models/message_delivered_callback.rb,
lib/bandwidth-sdk/models/transfer_complete_callback.rb,
lib/bandwidth-sdk/models/bxml/verbs/resume_recording.rb,
lib/bandwidth-sdk/models/conference_created_callback.rb,
lib/bandwidth-sdk/models/list_message_direction_enum.rb,
lib/bandwidth-sdk/models/machine_detection_mode_enum.rb,
lib/bandwidth-sdk/models/mfa_forbidden_request_error.rb,
lib/bandwidth-sdk/models/recording_complete_callback.rb,
lib/bandwidth-sdk/models/conference_redirect_callback.rb,
lib/bandwidth-sdk/models/create_message_request_error.rb,
lib/bandwidth-sdk/models/recording_available_callback.rb,
lib/bandwidth-sdk/models/transfer_disconnect_callback.rb,
lib/bandwidth-sdk/models/bxml/verbs/stop_transcription.rb,
lib/bandwidth-sdk/models/conference_completed_callback.rb,
lib/bandwidth-sdk/models/conference_recording_metadata.rb,
lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb,
lib/bandwidth-sdk/models/mfa_unauthorized_request_error.rb,
lib/bandwidth-sdk/models/bridge_target_complete_callback.rb,
lib/bandwidth-sdk/models/conference_member_exit_callback.rb,
lib/bandwidth-sdk/models/conference_member_join_callback.rb,
lib/bandwidth-sdk/models/machine_detection_configuration.rb,
lib/bandwidth-sdk/models/message_failed_callback_message.rb,
lib/bandwidth-sdk/models/inbound_message_callback_message.rb,
lib/bandwidth-sdk/models/message_sending_callback_message.rb,
lib/bandwidth-sdk/models/transcription_available_callback.rb,
lib/bandwidth-sdk/models/message_delivered_callback_message.rb,
lib/bandwidth-sdk/models/machine_detection_complete_callback.rb,
lib/bandwidth-sdk/models/conference_recording_available_callback.rb

Overview

#Bandwidth

#Bandwidth’s Communication APIs

The version of the OpenAPI document: 1.0.0 Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 7.0.0

Defined Under Namespace

Modules: Bxml Classes: AccountStatistics, AnswerCallback, ApiClient, ApiError, BridgeCompleteCallback, BridgeTargetCompleteCallback, CallDirectionEnum, CallRecordingMetadata, CallState, CallStateEnum, CallbackMethodEnum, CallsApi, CodeRequest, Conference, ConferenceCompletedCallback, ConferenceCreatedCallback, ConferenceMember, ConferenceMemberExitCallback, ConferenceMemberJoinCallback, ConferenceRecordingAvailableCallback, ConferenceRecordingMetadata, ConferenceRedirectCallback, ConferenceStateEnum, ConferencesApi, Configuration, CreateCall, CreateCallResponse, CreateLookupResponse, CreateMessageRequestError, DeferredResult, DisconenctCallback, DisconnectCallback, Diversion, DtmfCallback, FieldError, FileFormatEnum, GatherCallback, InboundMessageCallback, InboundMessageCallbackMessage, InitiateCallback, ListMessageDirectionEnum, ListMessageItem, LookupRequest, LookupResult, LookupStatus, LookupStatusEnum, MFAApi, MachineDetectionCompleteCallback, MachineDetectionConfiguration, MachineDetectionModeEnum, MachineDetectionResult, Media, MediaApi, Message, MessageDeliveredCallback, MessageDeliveredCallbackMessage, MessageDirectionEnum, MessageFailedCallback, MessageFailedCallbackMessage, MessageRequest, MessageSendingCallback, MessageSendingCallbackMessage, MessageStatusEnum, MessageTypeEnum, MessagesApi, MessagesList, MessagingCodeResponse, MessagingRequestError, MfaForbiddenRequestError, MfaRequestError, MfaUnauthorizedRequestError, PageInfo, PhoneNumberLookupApi, PriorityEnum, RecordingAvailableCallback, RecordingCompleteCallback, RecordingStateEnum, RecordingsApi, RedirectCallback, RedirectMethodEnum, StatisticsApi, StirShaken, Tag, TnLookupRequestError, TranscribeRecording, Transcription, TranscriptionAvailableCallback, TranscriptionList, TranscriptionMetadata, TransferAnswerCallback, TransferCompleteCallback, TransferDisconnectCallback, UpdateCall, UpdateCallRecording, UpdateConference, UpdateConferenceMember, VerifyCodeRequest, VerifyCodeResponse, VoiceApiError, VoiceCodeResponse

Constant Summary collapse

VERSION =
'11.3.0'

Class Method Summary collapse

Class Method Details

.configureObject

Customize default settings for the SDK using block.

Bandwidth.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



162
163
164
165
166
167
168
# File 'lib/bandwidth-sdk.rb', line 162

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end