bandwidth-sdk 11.0.0.pre.beta.1.1 → 11.0.0.pre.beta.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +3 -1
- data/Gemfile.lock +44 -20
- data/README.md +7 -3
- data/Rakefile +10 -2
- data/bandwidth-sdk.gemspec +12 -12
- data/bandwidth.yml +401 -352
- data/coverage/.last_run.json +5 -0
- data/coverage/.resultset.json +9759 -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 +108249 -0
- data/custom_templates/Gemfile.mustache +11 -0
- data/custom_templates/README.mustache +170 -0
- data/custom_templates/gem.mustache +99 -0
- data/custom_templates/gemspec.mustache +37 -0
- data/custom_templates/version.mustache +7 -0
- data/docs/AnswerCallback.md +3 -3
- data/docs/BridgeCompleteCallback.md +2 -2
- data/docs/BridgeTargetCompleteCallback.md +2 -2
- data/docs/CallState.md +2 -2
- data/docs/CallsApi.md +15 -15
- data/docs/Conference.md +4 -4
- data/docs/ConferenceCompletedCallback.md +2 -2
- data/docs/ConferenceCreatedCallback.md +2 -2
- data/docs/ConferenceMemberExitCallback.md +2 -2
- data/docs/ConferenceMemberJoinCallback.md +2 -2
- data/docs/ConferenceRecordingAvailableCallback.md +2 -2
- data/docs/ConferenceRedirectCallback.md +2 -2
- data/docs/ConferencesApi.md +42 -42
- data/docs/CreateCall.md +11 -11
- data/docs/CreateCallResponse.md +11 -11
- data/docs/DisconnectCallback.md +2 -2
- data/docs/DtmfCallback.md +2 -2
- data/docs/GatherCallback.md +2 -2
- data/docs/InitiateCallback.md +2 -2
- data/docs/ListMessageItem.md +5 -3
- data/docs/MFAApi.md +6 -6
- data/docs/MachineDetectionCompleteCallback.md +3 -3
- data/docs/MachineDetectionConfiguration.md +2 -2
- data/docs/MachineDetectionResult.md +20 -0
- data/docs/Message.md +2 -2
- data/docs/MessageDeliveredCallbackMessage.md +1 -1
- data/docs/MessageFailedCallbackMessage.md +1 -1
- data/docs/MessageRequest.md +1 -1
- data/docs/MessageSendingCallbackMessage.md +1 -1
- data/docs/MessagesApi.md +5 -1
- data/docs/MessagesList.md +1 -1
- data/docs/PhoneNumberLookupApi.md +4 -4
- data/docs/RecordingAvailableCallback.md +2 -2
- data/docs/RecordingCompleteCallback.md +2 -2
- data/docs/RecordingsApi.md +52 -52
- data/docs/RedirectCallback.md +2 -2
- data/docs/StatisticsApi.md +2 -2
- data/docs/TranscribeRecording.md +4 -2
- data/docs/TranscriptionAvailableCallback.md +2 -2
- data/docs/TransferAnswerCallback.md +2 -2
- data/docs/TransferCompleteCallback.md +2 -2
- data/docs/TransferDisconnectCallback.md +2 -2
- data/docs/UpdateCall.md +3 -3
- data/docs/UpdateConference.md +3 -3
- data/lib/bandwidth-sdk/api/calls_api.rb +18 -18
- data/lib/bandwidth-sdk/api/conferences_api.rb +46 -46
- data/lib/bandwidth-sdk/api/media_api.rb +2 -2
- data/lib/bandwidth-sdk/api/messages_api.rb +8 -2
- data/lib/bandwidth-sdk/api/mfa_api.rb +10 -10
- data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +6 -6
- data/lib/bandwidth-sdk/api/recordings_api.rb +55 -55
- data/lib/bandwidth-sdk/api/statistics_api.rb +3 -3
- data/lib/bandwidth-sdk/api_client.rb +1 -1
- data/lib/bandwidth-sdk/api_error.rb +2 -2
- data/lib/bandwidth-sdk/configuration.rb +12 -10
- data/lib/bandwidth-sdk/models/account_statistics.rb +14 -21
- data/lib/bandwidth-sdk/models/answer_callback.rb +16 -24
- data/lib/bandwidth-sdk/models/bridge_complete_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/bxml/bxml.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/nestable_verb.rb +3 -7
- data/lib/bandwidth-sdk/models/bxml/response.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/root.rb +3 -3
- data/lib/bandwidth-sdk/models/bxml/verb.rb +4 -5
- data/lib/bandwidth-sdk/models/bxml/verbs/bridge.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/conference.rb +2 -5
- data/lib/bandwidth-sdk/models/bxml/verbs/custom_param.rb +16 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/forward.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb +3 -5
- data/lib/bandwidth-sdk/models/bxml/verbs/hangup.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/pause.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/pause_recording.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/phone_number.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/play_audio.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/record.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/redirect.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/resume_recording.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/ring.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/send_dtmf.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/sip_uri.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/speak_sentence.rb +3 -5
- data/lib/bandwidth-sdk/models/bxml/verbs/start_gather.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/start_recording.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb +29 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_gather.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_recording.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_stream.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_transcription.rb +15 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stream_param.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/tag.rb +2 -4
- data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb +2 -4
- data/lib/bandwidth-sdk/models/call_direction_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/call_recording_metadata.rb +14 -21
- data/lib/bandwidth-sdk/models/call_state.rb +16 -23
- data/lib/bandwidth-sdk/models/call_state_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/callback_method_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/code_request.rb +29 -22
- data/lib/bandwidth-sdk/models/conference.rb +17 -24
- data/lib/bandwidth-sdk/models/conference_completed_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/conference_created_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/conference_member.rb +14 -21
- data/lib/bandwidth-sdk/models/conference_member_exit_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/conference_member_join_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/conference_recording_available_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/conference_recording_metadata.rb +14 -21
- data/lib/bandwidth-sdk/models/conference_redirect_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/conference_state_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/create_call.rb +34 -24
- data/lib/bandwidth-sdk/models/create_call_response.rb +36 -29
- data/lib/bandwidth-sdk/models/create_lookup_response.rb +14 -21
- data/lib/bandwidth-sdk/models/create_message_request_error.rb +18 -21
- data/lib/bandwidth-sdk/models/deferred_result.rb +14 -21
- data/lib/bandwidth-sdk/models/disconenct_callback.rb +1 -3
- data/lib/bandwidth-sdk/models/disconnect_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/diversion.rb +14 -21
- data/lib/bandwidth-sdk/models/dtmf_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/field_error.rb +14 -21
- data/lib/bandwidth-sdk/models/file_format_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/gather_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/inbound_message_callback.rb +24 -21
- data/lib/bandwidth-sdk/models/inbound_message_callback_message.rb +33 -21
- data/lib/bandwidth-sdk/models/initiate_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/list_message_direction_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/list_message_item.rb +31 -27
- data/lib/bandwidth-sdk/models/lookup_request.rb +16 -21
- data/lib/bandwidth-sdk/models/lookup_result.rb +14 -21
- data/lib/bandwidth-sdk/models/lookup_status.rb +14 -21
- data/lib/bandwidth-sdk/models/lookup_status_enum.rb +5 -5
- data/lib/bandwidth-sdk/models/machine_detection_complete_callback.rb +16 -24
- data/lib/bandwidth-sdk/models/machine_detection_configuration.rb +14 -21
- data/lib/bandwidth-sdk/models/machine_detection_mode_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/machine_detection_result.rb +224 -0
- data/lib/bandwidth-sdk/models/media.rb +14 -21
- data/lib/bandwidth-sdk/models/message.rb +23 -22
- data/lib/bandwidth-sdk/models/message_delivered_callback.rb +24 -21
- data/lib/bandwidth-sdk/models/message_delivered_callback_message.rb +35 -21
- data/lib/bandwidth-sdk/models/message_direction_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/message_failed_callback.rb +26 -21
- data/lib/bandwidth-sdk/models/message_failed_callback_message.rb +37 -21
- data/lib/bandwidth-sdk/models/message_request.rb +26 -23
- data/lib/bandwidth-sdk/models/message_sending_callback.rb +24 -21
- data/lib/bandwidth-sdk/models/message_sending_callback_message.rb +37 -21
- data/lib/bandwidth-sdk/models/message_status_enum.rb +9 -9
- data/lib/bandwidth-sdk/models/message_type_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/messages_list.rb +15 -22
- data/lib/bandwidth-sdk/models/messaging_code_response.rb +14 -21
- data/lib/bandwidth-sdk/models/messaging_request_error.rb +18 -21
- data/lib/bandwidth-sdk/models/mfa_forbidden_request_error.rb +14 -21
- data/lib/bandwidth-sdk/models/mfa_request_error.rb +14 -21
- data/lib/bandwidth-sdk/models/mfa_unauthorized_request_error.rb +14 -21
- data/lib/bandwidth-sdk/models/page_info.rb +14 -21
- data/lib/bandwidth-sdk/models/priority_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/recording_available_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/recording_complete_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/recording_state_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/redirect_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/redirect_method_enum.rb +3 -3
- data/lib/bandwidth-sdk/models/stir_shaken.rb +14 -21
- data/lib/bandwidth-sdk/models/tag.rb +14 -21
- data/lib/bandwidth-sdk/models/tn_lookup_request_error.rb +14 -21
- data/lib/bandwidth-sdk/models/transcribe_recording.rb +32 -26
- data/lib/bandwidth-sdk/models/transcription.rb +14 -21
- data/lib/bandwidth-sdk/models/transcription_available_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/transcription_list.rb +14 -21
- data/lib/bandwidth-sdk/models/transcription_metadata.rb +14 -21
- data/lib/bandwidth-sdk/models/transfer_answer_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/transfer_complete_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +15 -22
- data/lib/bandwidth-sdk/models/update_call.rb +24 -22
- data/lib/bandwidth-sdk/models/update_call_recording.rb +16 -21
- data/lib/bandwidth-sdk/models/update_conference.rb +15 -22
- data/lib/bandwidth-sdk/models/update_conference_member.rb +14 -21
- data/lib/bandwidth-sdk/models/verify_code_request.rb +20 -21
- data/lib/bandwidth-sdk/models/verify_code_response.rb +14 -21
- data/lib/bandwidth-sdk/models/voice_api_error.rb +14 -21
- data/lib/bandwidth-sdk/models/voice_code_response.rb +14 -21
- data/lib/bandwidth-sdk/version.rb +2 -2
- data/lib/bandwidth-sdk.rb +5 -1
- data/openapi-config.yml +1 -0
- data/openapitools.json +7 -0
- data/spec/api/calls_api_spec.rb +228 -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 +28 -28
- data/spec/configuration_spec.rb +190 -0
- data/spec/integration/calls_api_integration_spec.rb +88 -69
- data/spec/integration/conferences_api_integration_spec.rb +74 -68
- data/spec/integration/media_api_integration_spec.rb +38 -32
- data/spec/integration/messages_api_integration_spec.rb +63 -50
- data/spec/integration/mfa_api_integration_spec.rb +41 -33
- data/spec/integration/phone_number_lookup_api_integration_spec.rb +26 -22
- data/spec/integration/recordings_api_integration_spec.rb +84 -77
- data/spec/integration/statistics_api_integration_spec.rb +15 -14
- data/spec/{unit/models → models}/bxml/bxml_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/nestable_verb_spec.rb +1 -3
- data/spec/{unit/models → models}/bxml/response_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verb_spec.rb +1 -14
- data/spec/{unit/models → models}/bxml/verbs/bridge_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/conference_spec.rb +0 -2
- data/spec/models/bxml/verbs/custom_param_spec.rb +36 -0
- data/spec/{unit/models → models}/bxml/verbs/forward_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/gather_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/hangup_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/pause_recording_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/pause_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/phone_number_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/play_audio_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/record_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/redirect_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/resume_recording_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/ring_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/send_dtmf_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/sip_uri_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/speak_sentence_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/start_gather_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/start_recording_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/start_stream_spec.rb +2 -4
- data/spec/models/bxml/verbs/start_transcription_spec.rb +74 -0
- data/spec/{unit/models → models}/bxml/verbs/stop_gather_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/stop_recording_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/stop_stream_spec.rb +0 -2
- data/spec/models/bxml/verbs/stop_transcription_spec.rb +34 -0
- data/spec/{unit/models → models}/bxml/verbs/stream_param_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/tag_spec.rb +0 -2
- data/spec/{unit/models → models}/bxml/verbs/transfer_spec.rb +0 -2
- 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 +48 -31
- metadata +148 -256
- data/spec/unit/api/calls_api_spec.rb +0 -89
- data/spec/unit/api/conferences_api_spec.rb +0 -163
- data/spec/unit/api/media_api_spec.rb +0 -90
- data/spec/unit/api/messages_api_spec.rb +0 -73
- data/spec/unit/api/mfa_api_spec.rb +0 -74
- data/spec/unit/api/phone_number_lookup_api_spec.rb +0 -61
- data/spec/unit/api/recordings_api_spec.rb +0 -177
- data/spec/unit/api/statistics_api_spec.rb +0 -47
- data/spec/unit/models/account_statistics_spec.rb +0 -40
- data/spec/unit/models/answer_callback_spec.rb +0 -112
- data/spec/unit/models/bridge_complete_callback_spec.rb +0 -124
- data/spec/unit/models/bridge_target_complete_callback_spec.rb +0 -106
- data/spec/unit/models/call_direction_enum_spec.rb +0 -28
- data/spec/unit/models/call_recording_metadata_spec.rb +0 -136
- data/spec/unit/models/call_state_enum_spec.rb +0 -28
- data/spec/unit/models/call_state_spec.rb +0 -136
- data/spec/unit/models/callback_method_enum_spec.rb +0 -28
- data/spec/unit/models/code_request_spec.rb +0 -64
- data/spec/unit/models/conference_completed_callback_spec.rb +0 -58
- data/spec/unit/models/conference_created_callback_spec.rb +0 -58
- data/spec/unit/models/conference_member_exit_callback_spec.rb +0 -76
- data/spec/unit/models/conference_member_join_callback_spec.rb +0 -76
- data/spec/unit/models/conference_member_spec.rb +0 -64
- data/spec/unit/models/conference_recording_available_callback_spec.rb +0 -112
- data/spec/unit/models/conference_recording_metadata_spec.rb +0 -94
- data/spec/unit/models/conference_redirect_callback_spec.rb +0 -58
- data/spec/unit/models/conference_spec.rb +0 -76
- data/spec/unit/models/conference_state_enum_spec.rb +0 -28
- data/spec/unit/models/create_call_response_spec.rb +0 -154
- data/spec/unit/models/create_call_spec.rb +0 -142
- data/spec/unit/models/create_lookup_response_spec.rb +0 -40
- data/spec/unit/models/create_message_request_error_spec.rb +0 -46
- data/spec/unit/models/deferred_result_spec.rb +0 -40
- data/spec/unit/models/disconnect_callback_spec.rb +0 -130
- data/spec/unit/models/diversion_spec.rb +0 -70
- data/spec/unit/models/dtmf_callback_spec.rb +0 -130
- data/spec/unit/models/field_error_spec.rb +0 -40
- data/spec/unit/models/file_format_enum_spec.rb +0 -28
- data/spec/unit/models/gather_callback_spec.rb +0 -136
- data/spec/unit/models/inbound_message_callback_message_spec.rb +0 -100
- data/spec/unit/models/inbound_message_callback_spec.rb +0 -58
- data/spec/unit/models/initiate_callback_spec.rb +0 -100
- data/spec/unit/models/list_message_direction_enum_spec.rb +0 -28
- data/spec/unit/models/list_message_item_spec.rb +0 -124
- data/spec/unit/models/lookup_request_spec.rb +0 -34
- data/spec/unit/models/lookup_result_spec.rb +0 -82
- data/spec/unit/models/lookup_status_enum_spec.rb +0 -28
- data/spec/unit/models/lookup_status_spec.rb +0 -52
- data/spec/unit/models/machine_detection_complete_callback_spec.rb +0 -112
- data/spec/unit/models/machine_detection_configuration_spec.rb +0 -118
- data/spec/unit/models/machine_detection_mode_enum_spec.rb +0 -28
- data/spec/unit/models/media_spec.rb +0 -46
- data/spec/unit/models/message_delivered_callback_message_spec.rb +0 -100
- data/spec/unit/models/message_delivered_callback_spec.rb +0 -58
- data/spec/unit/models/message_direction_enum_spec.rb +0 -28
- data/spec/unit/models/message_failed_callback_message_spec.rb +0 -100
- data/spec/unit/models/message_failed_callback_spec.rb +0 -64
- data/spec/unit/models/message_request_spec.rb +0 -76
- data/spec/unit/models/message_sending_callback_message_spec.rb +0 -100
- data/spec/unit/models/message_sending_callback_spec.rb +0 -58
- data/spec/unit/models/message_spec.rb +0 -106
- data/spec/unit/models/message_status_enum_spec.rb +0 -28
- data/spec/unit/models/message_type_enum_spec.rb +0 -28
- data/spec/unit/models/messages_list_spec.rb +0 -46
- data/spec/unit/models/messaging_code_response_spec.rb +0 -34
- data/spec/unit/models/messaging_request_error_spec.rb +0 -40
- data/spec/unit/models/mfa_forbidden_request_error_spec.rb +0 -34
- data/spec/unit/models/mfa_request_error_spec.rb +0 -40
- data/spec/unit/models/mfa_unauthorized_request_error_spec.rb +0 -34
- data/spec/unit/models/page_info_spec.rb +0 -52
- data/spec/unit/models/priority_enum_spec.rb +0 -28
- data/spec/unit/models/recording_available_callback_spec.rb +0 -160
- data/spec/unit/models/recording_complete_callback_spec.rb +0 -160
- data/spec/unit/models/recording_state_enum_spec.rb +0 -28
- data/spec/unit/models/redirect_callback_spec.rb +0 -124
- data/spec/unit/models/redirect_method_enum_spec.rb +0 -28
- data/spec/unit/models/stir_shaken_spec.rb +0 -46
- data/spec/unit/models/tag_spec.rb +0 -40
- data/spec/unit/models/tn_lookup_request_error_spec.rb +0 -34
- data/spec/unit/models/transcribe_recording_spec.rb +0 -64
- data/spec/unit/models/transcription_available_callback_spec.rb +0 -154
- data/spec/unit/models/transcription_list_spec.rb +0 -34
- data/spec/unit/models/transcription_metadata_spec.rb +0 -52
- data/spec/unit/models/transcription_spec.rb +0 -40
- data/spec/unit/models/transfer_answer_callback_spec.rb +0 -118
- data/spec/unit/models/transfer_complete_callback_spec.rb +0 -136
- data/spec/unit/models/transfer_disconnect_callback_spec.rb +0 -148
- data/spec/unit/models/update_call_recording_spec.rb +0 -34
- data/spec/unit/models/update_call_spec.rb +0 -88
- data/spec/unit/models/update_conference_member_spec.rb +0 -46
- data/spec/unit/models/update_conference_spec.rb +0 -82
- data/spec/unit/models/verify_code_request_spec.rb +0 -52
- data/spec/unit/models/verify_code_response_spec.rb +0 -34
- data/spec/unit/models/voice_api_error_spec.rb +0 -46
- data/spec/unit/models/voice_code_response_spec.rb +0 -34
@@ -0,0 +1,170 @@
|
|
1
|
+
# {{gemName}}
|
2
|
+
|
3
|
+
[![Gem Version](https://badge.fury.io/rb/bandwidth-sdk.svg)](https://badge.fury.io/rb/bandwidth-sdk)
|
4
|
+
[![Tests](https://github.com/Bandwidth/ruby-sdk/actions/workflows/test-nightly.yml/badge.svg)](https://github.com/Bandwidth/ruby-sdk/actions/workflows/test-nightly.yml)
|
5
|
+
[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](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
|
+
{{#appDescriptionWithNewLines}}
|
18
|
+
{{{.}}}
|
19
|
+
{{/appDescriptionWithNewLines}}
|
20
|
+
|
21
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
22
|
+
|
23
|
+
- API version: {{appVersion}}
|
24
|
+
- Package version: {{gemVersion}}
|
25
|
+
{{^hideGenerationTimestamp}}
|
26
|
+
- Build date: {{generatedDate}}
|
27
|
+
{{/hideGenerationTimestamp}}
|
28
|
+
- Build package: {{generatorClass}}
|
29
|
+
{{#infoUrl}}
|
30
|
+
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
|
31
|
+
{{/infoUrl}}
|
32
|
+
|
33
|
+
## Installation
|
34
|
+
|
35
|
+
### Build a gem
|
36
|
+
|
37
|
+
To build the Ruby code into a gem:
|
38
|
+
|
39
|
+
```shell
|
40
|
+
gem build {{{gemName}}}.gemspec
|
41
|
+
```
|
42
|
+
|
43
|
+
Then either install the gem locally:
|
44
|
+
|
45
|
+
```shell
|
46
|
+
gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
|
47
|
+
```
|
48
|
+
|
49
|
+
(for development, run `gem install --dev ./{{{gemName}}}-{{{gemVersion}}}.gem` to install the development dependencies)
|
50
|
+
|
51
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
52
|
+
|
53
|
+
Finally add this to the Gemfile:
|
54
|
+
|
55
|
+
gem '{{{gemName}}}', '~> {{{gemVersion}}}'
|
56
|
+
|
57
|
+
### Install from Git
|
58
|
+
|
59
|
+
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:
|
60
|
+
|
61
|
+
gem '{{{gemName}}}', :git => 'https://{{gitHost}}/{{gitUserId}}{{^gitUserId}}YOUR_GIT_USERNAME{{/gitUserId}}/{{gitRepoId}}{{^gitRepoId}}YOUR_GIT_REPO{{/gitRepoId}}.git'
|
62
|
+
|
63
|
+
### Include the Ruby code directly
|
64
|
+
|
65
|
+
Include the Ruby code directly using `-I` as follows:
|
66
|
+
|
67
|
+
```shell
|
68
|
+
ruby -Ilib script.rb
|
69
|
+
```
|
70
|
+
|
71
|
+
## Getting Started
|
72
|
+
|
73
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
74
|
+
|
75
|
+
```ruby
|
76
|
+
# Load the gem
|
77
|
+
require '{{{gemName}}}'
|
78
|
+
{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}
|
79
|
+
# Setup authorization
|
80
|
+
{{{moduleName}}}.configure do |config|{{#authMethods}}{{#isBasic}}{{#isBasicBasic}}
|
81
|
+
# Configure HTTP basic authorization: {{{name}}}
|
82
|
+
config.username = 'YOUR_USERNAME'
|
83
|
+
config.password = 'YOUR_PASSWORD'{{/isBasicBasic}}{{#isBasicBearer}}
|
84
|
+
# Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}}
|
85
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
86
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
87
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
|
88
|
+
# Configure API key authorization: {{{name}}}
|
89
|
+
config.api_key['{{{name}}}'] = 'YOUR API KEY'
|
90
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
91
|
+
# config.api_key_prefix['{{{name}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
|
92
|
+
# Configure OAuth2 access token for authorization: {{{name}}}
|
93
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
94
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
95
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isOAuth}}
|
96
|
+
{{#isFaraday}}
|
97
|
+
# Configure faraday connection
|
98
|
+
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
99
|
+
{{/isFaraday}}
|
100
|
+
{{/authMethods}}end
|
101
|
+
{{/hasAuthMethods}}
|
102
|
+
|
103
|
+
api_instance = {{{moduleName}}}::{{{classname}}}.new
|
104
|
+
{{#requiredParams}}
|
105
|
+
{{{paramName}}} = {{{vendorExtensions.x-ruby-example}}} # {{{dataType}}} | {{{description}}}
|
106
|
+
{{/requiredParams}}
|
107
|
+
{{#optionalParams}}
|
108
|
+
{{#-first}}
|
109
|
+
opts = {
|
110
|
+
{{/-first}}
|
111
|
+
{{{paramName}}}: {{{vendorExtensions.x-ruby-example}}}{{^-last}},{{/-last}} # {{{dataType}}} | {{{description}}}
|
112
|
+
{{#-last}}
|
113
|
+
}
|
114
|
+
{{/-last}}
|
115
|
+
{{/optionalParams}}
|
116
|
+
|
117
|
+
begin
|
118
|
+
{{#summary}} #{{{.}}}
|
119
|
+
{{/summary}} {{#returnType}}result = {{/returnType}}api_instance.{{{operationId}}}{{#hasParams}}({{#requiredParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#optionalParams}}{{#-last}}{{#hasRequiredParams}}, {{/hasRequiredParams}}opts{{/-last}}{{/optionalParams}}){{/hasParams}}{{#returnType}}
|
120
|
+
p result{{/returnType}}
|
121
|
+
rescue {{{moduleName}}}::ApiError => e
|
122
|
+
puts "Exception when calling {{classname}}->{{{operationId}}}: #{e}"
|
123
|
+
end
|
124
|
+
{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
|
125
|
+
```
|
126
|
+
|
127
|
+
## Documentation for API Endpoints
|
128
|
+
|
129
|
+
All URIs are relative to *{{basePath}}*
|
130
|
+
|
131
|
+
Class | Method | HTTP request | Description
|
132
|
+
------------ | ------------- | ------------- | -------------
|
133
|
+
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{moduleName}}::{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{{summary}}}
|
134
|
+
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
135
|
+
|
136
|
+
## Documentation for Models
|
137
|
+
|
138
|
+
{{#models}}{{#model}} - [{{moduleName}}::{{classname}}]({{modelDocPath}}{{classname}}.md)
|
139
|
+
{{/model}}{{/models}}
|
140
|
+
|
141
|
+
## Documentation for Authorization
|
142
|
+
|
143
|
+
{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
|
144
|
+
{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
|
145
|
+
{{#authMethods}}
|
146
|
+
### {{name}}
|
147
|
+
|
148
|
+
{{#isApiKey}}
|
149
|
+
|
150
|
+
- **Type**: API key
|
151
|
+
- **API key parameter name**: {{keyParamName}}
|
152
|
+
- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
|
153
|
+
{{/isApiKey}}
|
154
|
+
{{#isBasic}}
|
155
|
+
{{#isBasicBasic}}- **Type**: HTTP basic authentication
|
156
|
+
{{/isBasicBasic}}{{#isBasicBearer}}- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
|
157
|
+
{{/isBasicBearer}}{{#isHttpSignature}}- **Type**: HTTP signature authentication
|
158
|
+
{{/isHttpSignature}}
|
159
|
+
{{/isBasic}}
|
160
|
+
{{#isOAuth}}
|
161
|
+
|
162
|
+
- **Type**: OAuth
|
163
|
+
- **Flow**: {{flow}}
|
164
|
+
- **Authorization URL**: {{authorizationUrl}}
|
165
|
+
- **Scopes**: {{^scopes}}N/A{{/scopes}}
|
166
|
+
{{#scopes}} - {{scope}}: {{description}}
|
167
|
+
{{/scopes}}
|
168
|
+
{{/isOAuth}}
|
169
|
+
|
170
|
+
{{/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
|
data/docs/AnswerCallback.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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** | **
|
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
9
|
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
10
10
|
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
|
11
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] |
|
@@ -17,7 +17,7 @@
|
|
17
17
|
| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
|
18
18
|
| **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
|
19
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** | **
|
20
|
+
| **machine_detection_result** | [**MachineDetectionResult**](MachineDetectionResult.md) | | [optional] |
|
21
21
|
|
22
22
|
## Example
|
23
23
|
|
@@ -26,7 +26,7 @@ require 'bandwidth-sdk'
|
|
26
26
|
|
27
27
|
instance = Bandwidth::AnswerCallback.new(
|
28
28
|
event_type: bridgeComplete,
|
29
|
-
event_time:
|
29
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
30
30
|
account_id: 920012,
|
31
31
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
32
32
|
from: +15555555555,
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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** | **
|
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
9
|
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
10
10
|
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
|
11
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] |
|
@@ -28,7 +28,7 @@ require 'bandwidth-sdk'
|
|
28
28
|
|
29
29
|
instance = Bandwidth::BridgeCompleteCallback.new(
|
30
30
|
event_type: bridgeComplete,
|
31
|
-
event_time:
|
31
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
32
32
|
account_id: 920012,
|
33
33
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
34
34
|
from: +15555555555,
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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** | **
|
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
9
|
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
10
10
|
| **application_id** | **String** | The id of the application associated with the call. | [optional] |
|
11
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] |
|
@@ -25,7 +25,7 @@ require 'bandwidth-sdk'
|
|
25
25
|
|
26
26
|
instance = Bandwidth::BridgeTargetCompleteCallback.new(
|
27
27
|
event_type: bridgeComplete,
|
28
|
-
event_time:
|
28
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
29
29
|
account_id: 920012,
|
30
30
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
31
31
|
from: +15555555555,
|
data/docs/CallState.md
CHANGED
@@ -8,11 +8,11 @@
|
|
8
8
|
| **account_id** | **String** | The account id associated with the call. | [optional] |
|
9
9
|
| **call_id** | **String** | The programmable voice API call ID. | [optional] |
|
10
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] |
|
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
12
|
| **from** | **String** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] |
|
13
13
|
| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
|
14
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] |
|
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
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
17
|
| **enqueued_time** | **Time** | The time this call was placed in queue. | [optional] |
|
18
18
|
| **start_time** | **Time** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] |
|
data/docs/CallsApi.md
CHANGED
@@ -31,8 +31,8 @@ Bandwidth.configure do |config|
|
|
31
31
|
end
|
32
32
|
|
33
33
|
api_instance = Bandwidth::CallsApi.new
|
34
|
-
account_id = '9900000' # String | Your Bandwidth Account ID
|
35
|
-
create_call = Bandwidth::CreateCall.new({to: '+19195551234', from: '+19195554321', application_id: '1234-qwer-5679-tyui', answer_url: 'https://www.myCallbackServer.
|
34
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
35
|
+
create_call = Bandwidth::CreateCall.new({to: '+19195551234', from: '+19195554321', application_id: '1234-qwer-5679-tyui', answer_url: 'https://www.myCallbackServer.example/webhooks/answer'}) # CreateCall | JSON object containing information to create an outbound call
|
36
36
|
|
37
37
|
begin
|
38
38
|
# Create Call
|
@@ -65,7 +65,7 @@ end
|
|
65
65
|
|
66
66
|
| Name | Type | Description | Notes |
|
67
67
|
| ---- | ---- | ----------- | ----- |
|
68
|
-
| **account_id** | **String** | Your Bandwidth Account ID | |
|
68
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
69
69
|
| **create_call** | [**CreateCall**](CreateCall.md) | JSON object containing information to create an outbound call | |
|
70
70
|
|
71
71
|
### Return type
|
@@ -103,8 +103,8 @@ Bandwidth.configure do |config|
|
|
103
103
|
end
|
104
104
|
|
105
105
|
api_instance = Bandwidth::CallsApi.new
|
106
|
-
account_id = '9900000' # String | Your Bandwidth Account ID
|
107
|
-
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID
|
106
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
107
|
+
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
|
108
108
|
|
109
109
|
begin
|
110
110
|
# Get Call State Information
|
@@ -137,8 +137,8 @@ end
|
|
137
137
|
|
138
138
|
| Name | Type | Description | Notes |
|
139
139
|
| ---- | ---- | ----------- | ----- |
|
140
|
-
| **account_id** | **String** | Your Bandwidth Account ID | |
|
141
|
-
| **call_id** | **String** | Programmable Voice API Call ID | |
|
140
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
141
|
+
| **call_id** | **String** | Programmable Voice API Call ID. | |
|
142
142
|
|
143
143
|
### Return type
|
144
144
|
|
@@ -175,8 +175,8 @@ Bandwidth.configure do |config|
|
|
175
175
|
end
|
176
176
|
|
177
177
|
api_instance = Bandwidth::CallsApi.new
|
178
|
-
account_id = '9900000' # String | Your Bandwidth Account ID
|
179
|
-
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID
|
178
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
179
|
+
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
|
180
180
|
update_call = Bandwidth::UpdateCall.new # UpdateCall | JSON object containing information to redirect an existing call to a new BXML document
|
181
181
|
|
182
182
|
begin
|
@@ -209,8 +209,8 @@ end
|
|
209
209
|
|
210
210
|
| Name | Type | Description | Notes |
|
211
211
|
| ---- | ---- | ----------- | ----- |
|
212
|
-
| **account_id** | **String** | Your Bandwidth Account ID | |
|
213
|
-
| **call_id** | **String** | Programmable Voice API Call ID | |
|
212
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
213
|
+
| **call_id** | **String** | Programmable Voice API Call ID. | |
|
214
214
|
| **update_call** | [**UpdateCall**](UpdateCall.md) | JSON object containing information to redirect an existing call to a new BXML document | |
|
215
215
|
|
216
216
|
### Return type
|
@@ -248,8 +248,8 @@ Bandwidth.configure do |config|
|
|
248
248
|
end
|
249
249
|
|
250
250
|
api_instance = Bandwidth::CallsApi.new
|
251
|
-
account_id = '9900000' # String | Your Bandwidth Account ID
|
252
|
-
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID
|
251
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
252
|
+
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
|
253
253
|
body = '<?xml version=\"1.0\" encoding=\"UTF-8\"?>
|
254
254
|
<Bxml>
|
255
255
|
<SpeakSentence>This is a test sentence.</SpeakSentence>
|
@@ -285,8 +285,8 @@ end
|
|
285
285
|
|
286
286
|
| Name | Type | Description | Notes |
|
287
287
|
| ---- | ---- | ----------- | ----- |
|
288
|
-
| **account_id** | **String** | Your Bandwidth Account ID | |
|
289
|
-
| **call_id** | **String** | Programmable Voice API Call ID | |
|
288
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
289
|
+
| **call_id** | **String** | Programmable Voice API Call ID. | |
|
290
290
|
| **body** | **String** | | |
|
291
291
|
|
292
292
|
### Return type
|
data/docs/Conference.md
CHANGED
@@ -4,14 +4,14 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | The Bandwidth-generated conference ID | [optional] |
|
8
|
-
| **name** | **String** | The name of the conference, as specified by your application | [optional] |
|
7
|
+
| **id** | **String** | The Bandwidth-generated conference ID. | [optional] |
|
8
|
+
| **name** | **String** | The name of the conference, as specified by your application. | [optional] |
|
9
9
|
| **created_time** | **Time** | The time the conference was initiated, in ISO 8601 format. | [optional] |
|
10
10
|
| **completed_time** | **Time** | The time the conference was terminated, in ISO 8601 format. | [optional] |
|
11
11
|
| **conference_event_url** | **String** | The URL to send the conference-related events. | [optional] |
|
12
12
|
| **conference_event_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional][default to 'POST'] |
|
13
13
|
| **tag** | **String** | The custom string attached to the conference that will be sent with callbacks. | [optional] |
|
14
|
-
| **active_members** | [**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] |
|
14
|
+
| **active_members** | [**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] |
|
15
15
|
|
16
16
|
## Example
|
17
17
|
|
@@ -23,7 +23,7 @@ instance = Bandwidth::Conference.new(
|
|
23
23
|
name: my-conference-name,
|
24
24
|
created_time: 2022-06-17T22:19:40.375Z,
|
25
25
|
completed_time: 2022-06-17T22:20Z,
|
26
|
-
conference_event_url: https://myServer.
|
26
|
+
conference_event_url: https://myServer.example/bandwidth/webhooks/conferenceEvent,
|
27
27
|
conference_event_method: null,
|
28
28
|
tag: my custom tag,
|
29
29
|
active_members: null
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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** | **
|
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
9
|
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
10
10
|
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
11
11
|
| **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] |
|
@@ -17,7 +17,7 @@ require 'bandwidth-sdk'
|
|
17
17
|
|
18
18
|
instance = Bandwidth::ConferenceCompletedCallback.new(
|
19
19
|
event_type: bridgeComplete,
|
20
|
-
event_time:
|
20
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
21
21
|
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
22
22
|
name: my-conference-name,
|
23
23
|
tag: exampleTag
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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** | **
|
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
9
|
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
10
10
|
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
11
11
|
| **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] |
|
@@ -17,7 +17,7 @@ require 'bandwidth-sdk'
|
|
17
17
|
|
18
18
|
instance = Bandwidth::ConferenceCreatedCallback.new(
|
19
19
|
event_type: bridgeComplete,
|
20
|
-
event_time:
|
20
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
21
21
|
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
22
22
|
name: my-conference-name,
|
23
23
|
tag: exampleTag
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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** | **
|
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
9
|
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
10
10
|
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
11
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] |
|
@@ -20,7 +20,7 @@ require 'bandwidth-sdk'
|
|
20
20
|
|
21
21
|
instance = Bandwidth::ConferenceMemberExitCallback.new(
|
22
22
|
event_type: bridgeComplete,
|
23
|
-
event_time:
|
23
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
24
24
|
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
25
25
|
name: my-conference-name,
|
26
26
|
from: +15555555555,
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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** | **
|
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
9
|
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
10
10
|
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
11
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] |
|
@@ -20,7 +20,7 @@ require 'bandwidth-sdk'
|
|
20
20
|
|
21
21
|
instance = Bandwidth::ConferenceMemberJoinCallback.new(
|
22
22
|
event_type: bridgeComplete,
|
23
|
-
event_time:
|
23
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
24
24
|
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
25
25
|
name: my-conference-name,
|
26
26
|
from: +15555555555,
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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** | **
|
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
9
|
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
10
10
|
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
11
11
|
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
@@ -26,7 +26,7 @@ require 'bandwidth-sdk'
|
|
26
26
|
|
27
27
|
instance = Bandwidth::ConferenceRecordingAvailableCallback.new(
|
28
28
|
event_type: bridgeComplete,
|
29
|
-
event_time:
|
29
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
30
30
|
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
31
31
|
name: my-conference-name,
|
32
32
|
account_id: 920012,
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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** | **
|
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
9
|
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
10
10
|
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
11
11
|
| **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] |
|
@@ -17,7 +17,7 @@ require 'bandwidth-sdk'
|
|
17
17
|
|
18
18
|
instance = Bandwidth::ConferenceRedirectCallback.new(
|
19
19
|
event_type: bridgeComplete,
|
20
|
-
event_time:
|
20
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
21
21
|
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
22
22
|
name: my-conference-name,
|
23
23
|
tag: exampleTag
|