bandwidth-sdk 18.1.3 → 18.2.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.lock +56 -10
- data/README.md +2 -0
- data/UPDATING_MODEL_TESTS.md +17 -2
- data/bandwidth-sdk.gemspec +2 -2
- data/bandwidth.yml +190 -51
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +819 -144
- data/coverage/index.html +15708 -8440
- data/custom_templates/configuration.mustache +6 -2
- data/custom_templates/gemspec.mustache +1 -1
- data/docs/AnswerCallback.md +4 -2
- data/docs/BridgeCompleteCallback.md +1 -1
- data/docs/BridgeTargetCompleteCallback.md +1 -1
- data/docs/ConferenceCompletedCallback.md +1 -1
- data/docs/ConferenceCreatedCallback.md +1 -1
- data/docs/ConferenceMemberExitCallback.md +1 -1
- data/docs/ConferenceMemberJoinCallback.md +1 -1
- data/docs/ConferenceRecordingAvailableCallback.md +1 -1
- data/docs/ConferenceRedirectCallback.md +1 -1
- data/docs/DisconnectCallback.md +6 -2
- data/docs/DtmfCallback.md +1 -1
- data/docs/GatherCallback.md +1 -1
- data/docs/InitiateCallback.md +6 -2
- data/docs/MachineDetectionCompleteCallback.md +1 -1
- data/docs/MediaApi.md +8 -8
- data/docs/MessagesApi.md +4 -4
- data/docs/MultiChannelApi.md +2 -2
- data/docs/RbmActionBase.md +1 -1
- data/docs/RbmSuggestionResponse.md +1 -1
- data/docs/RecordingAvailableCallback.md +1 -1
- data/docs/RecordingCompleteCallback.md +1 -1
- data/docs/RedirectCallback.md +1 -1
- data/docs/ReferCallStatusEnum.md +15 -0
- data/docs/ReferCompleteCallback.md +46 -0
- data/docs/TranscriptionAvailableCallback.md +1 -1
- data/docs/TransferAnswerCallback.md +1 -1
- data/docs/TransferCompleteCallback.md +1 -1
- data/docs/TransferDisconnectCallback.md +1 -1
- data/lib/bandwidth-sdk/api/calls_api.rb +6 -6
- data/lib/bandwidth-sdk/api/conferences_api.rb +10 -10
- data/lib/bandwidth-sdk/api/endpoints_api.rb +6 -6
- data/lib/bandwidth-sdk/api/media_api.rb +13 -13
- data/lib/bandwidth-sdk/api/messages_api.rb +7 -7
- data/lib/bandwidth-sdk/api/mfa_api.rb +4 -4
- data/lib/bandwidth-sdk/api/multi_channel_api.rb +4 -4
- data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +4 -4
- data/lib/bandwidth-sdk/api/recordings_api.rb +11 -11
- data/lib/bandwidth-sdk/api/statistics_api.rb +2 -2
- data/lib/bandwidth-sdk/api/toll_free_verification_api.rb +9 -9
- data/lib/bandwidth-sdk/api/transcriptions_api.rb +4 -4
- data/lib/bandwidth-sdk/api_client.rb +1 -1
- data/lib/bandwidth-sdk/api_error.rb +1 -1
- data/lib/bandwidth-sdk/api_model_base.rb +1 -1
- data/lib/bandwidth-sdk/configuration.rb +7 -3
- data/lib/bandwidth-sdk/models/account_statistics.rb +1 -1
- data/lib/bandwidth-sdk/models/additional_denial_reason.rb +1 -1
- data/lib/bandwidth-sdk/models/address.rb +1 -1
- data/lib/bandwidth-sdk/models/answer_callback.rb +17 -7
- data/lib/bandwidth-sdk/models/async_lookup_request.rb +1 -1
- data/lib/bandwidth-sdk/models/blocked_webhook.rb +1 -1
- data/lib/bandwidth-sdk/models/bridge_complete_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/brtc_error.rb +1 -1
- data/lib/bandwidth-sdk/models/brtc_error_response.rb +1 -1
- data/lib/bandwidth-sdk/models/brtc_error_source.rb +1 -1
- data/lib/bandwidth-sdk/models/brtc_link.rb +1 -1
- data/lib/bandwidth-sdk/models/business_entity_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/business_registration_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/bxml/root.rb +1 -1
- data/lib/bandwidth-sdk/models/bxml/verb.rb +1 -1
- data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb +1 -1
- data/lib/bandwidth-sdk/models/bxml/verbs/refer.rb +24 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/sip_uri.rb +3 -1
- data/lib/bandwidth-sdk/models/bxml/verbs/speak_sentence.rb +1 -1
- data/lib/bandwidth-sdk/models/call_direction_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/call_recording_metadata.rb +1 -1
- data/lib/bandwidth-sdk/models/call_state.rb +1 -1
- data/lib/bandwidth-sdk/models/call_state_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/call_transcription.rb +1 -1
- data/lib/bandwidth-sdk/models/call_transcription_detected_language_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/call_transcription_metadata.rb +1 -1
- data/lib/bandwidth-sdk/models/call_transcription_response.rb +1 -1
- data/lib/bandwidth-sdk/models/call_transcription_track_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/callback.rb +1 -1
- data/lib/bandwidth-sdk/models/callback_method_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/card_width_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/code_request.rb +1 -1
- data/lib/bandwidth-sdk/models/completed_lookup_status_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/conference.rb +1 -1
- data/lib/bandwidth-sdk/models/conference_completed_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_created_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_member.rb +1 -1
- data/lib/bandwidth-sdk/models/conference_member_exit_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_member_join_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_recording_available_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_recording_metadata.rb +1 -1
- data/lib/bandwidth-sdk/models/conference_redirect_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_state_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/contact.rb +1 -1
- data/lib/bandwidth-sdk/models/create_async_bulk_lookup_response.rb +1 -1
- data/lib/bandwidth-sdk/models/create_async_bulk_lookup_response_data.rb +1 -1
- data/lib/bandwidth-sdk/models/create_call.rb +1 -1
- data/lib/bandwidth-sdk/models/create_call_response.rb +1 -1
- data/lib/bandwidth-sdk/models/create_endpoint_request_base.rb +1 -1
- data/lib/bandwidth-sdk/models/create_endpoint_response.rb +1 -1
- data/lib/bandwidth-sdk/models/create_endpoint_response_data.rb +1 -1
- data/lib/bandwidth-sdk/models/create_message_request_error.rb +1 -1
- data/lib/bandwidth-sdk/models/create_multi_channel_message_response.rb +1 -1
- data/lib/bandwidth-sdk/models/create_sync_lookup_response.rb +1 -1
- data/lib/bandwidth-sdk/models/create_sync_lookup_response_data.rb +1 -1
- data/lib/bandwidth-sdk/models/create_web_rtc_connection_request.rb +1 -1
- data/lib/bandwidth-sdk/models/deactivation_event_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/device.rb +1 -1
- data/lib/bandwidth-sdk/models/device_status_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/disconnect_callback.rb +27 -7
- data/lib/bandwidth-sdk/models/diversion.rb +1 -1
- data/lib/bandwidth-sdk/models/dtmf_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/endpoint.rb +1 -1
- data/lib/bandwidth-sdk/models/endpoint_direction_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/endpoint_event.rb +1 -1
- data/lib/bandwidth-sdk/models/endpoint_event_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/endpoint_response.rb +1 -1
- data/lib/bandwidth-sdk/models/endpoint_status_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/endpoint_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/endpoints.rb +1 -1
- data/lib/bandwidth-sdk/models/error_object.rb +1 -1
- data/lib/bandwidth-sdk/models/error_source.rb +1 -1
- data/lib/bandwidth-sdk/models/failure_webhook.rb +1 -1
- data/lib/bandwidth-sdk/models/field_error.rb +1 -1
- data/lib/bandwidth-sdk/models/file_format_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/gather_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/get_async_bulk_lookup_response.rb +1 -1
- data/lib/bandwidth-sdk/models/get_async_bulk_lookup_response_data.rb +1 -1
- data/lib/bandwidth-sdk/models/in_progress_lookup_status_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/inbound_callback.rb +1 -1
- data/lib/bandwidth-sdk/models/inbound_callback_message.rb +1 -1
- data/lib/bandwidth-sdk/models/inbound_callback_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/initiate_callback.rb +28 -6
- data/lib/bandwidth-sdk/models/latest_message_delivery_status_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/line_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/link.rb +1 -1
- data/lib/bandwidth-sdk/models/link_schema.rb +1 -1
- data/lib/bandwidth-sdk/models/links_object.rb +1 -1
- data/lib/bandwidth-sdk/models/list_endpoints_response.rb +1 -1
- data/lib/bandwidth-sdk/models/list_message_direction_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/list_message_item.rb +1 -1
- data/lib/bandwidth-sdk/models/lookup_error_response.rb +1 -1
- data/lib/bandwidth-sdk/models/lookup_error_schema.rb +1 -1
- data/lib/bandwidth-sdk/models/lookup_error_schema_meta.rb +1 -1
- data/lib/bandwidth-sdk/models/lookup_result.rb +1 -1
- data/lib/bandwidth-sdk/models/machine_detection_complete_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/machine_detection_configuration.rb +1 -1
- data/lib/bandwidth-sdk/models/machine_detection_mode_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/machine_detection_result.rb +1 -1
- data/lib/bandwidth-sdk/models/media.rb +1 -1
- data/lib/bandwidth-sdk/models/message.rb +1 -1
- data/lib/bandwidth-sdk/models/message_direction_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/message_request.rb +1 -1
- data/lib/bandwidth-sdk/models/message_status_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/message_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/messages_list.rb +1 -1
- data/lib/bandwidth-sdk/models/messaging_code_response.rb +1 -1
- data/lib/bandwidth-sdk/models/messaging_request_error.rb +1 -1
- data/lib/bandwidth-sdk/models/mfa_forbidden_request_error.rb +1 -1
- data/lib/bandwidth-sdk/models/mfa_request_error.rb +1 -1
- data/lib/bandwidth-sdk/models/mfa_unauthorized_request_error.rb +1 -1
- data/lib/bandwidth-sdk/models/mms_message_content.rb +1 -1
- data/lib/bandwidth-sdk/models/mms_message_content_file.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_action.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_mms_object.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_mms_response_object.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_object_base.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_owner_object.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_rbm_object.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_rbm_object_all_of_content.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_rbm_response_object.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_request_object.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_response_object.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_sms_object.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_error.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_message_channel_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_message_content.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_message_request.rb +1 -1
- data/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb +1 -1
- data/lib/bandwidth-sdk/models/opt_in_workflow.rb +1 -1
- data/lib/bandwidth-sdk/models/page.rb +1 -1
- data/lib/bandwidth-sdk/models/page_info.rb +1 -1
- data/lib/bandwidth-sdk/models/priority_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/product_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_action_base.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_action_dial.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_action_open_url.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_action_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_action_view_location.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_card_content.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_card_content_media.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_location_response.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_media_height_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_message_carousel_card.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_message_content_file.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_message_content_rich_card.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_message_content_text.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_message_media.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_open_url_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_standalone_card.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_suggestion_response.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_web_view_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/recording_available_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/recording_complete_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/recording_state_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/recording_transcription_clip.rb +1 -1
- data/lib/bandwidth-sdk/models/recording_transcription_metadata.rb +1 -1
- data/lib/bandwidth-sdk/models/recording_transcriptions.rb +1 -1
- data/lib/bandwidth-sdk/models/redirect_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/redirect_method_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/refer_call_status_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/refer_complete_callback.rb +309 -0
- data/lib/bandwidth-sdk/models/sip_connection_metadata.rb +1 -1
- data/lib/bandwidth-sdk/models/sip_credentials.rb +1 -1
- data/lib/bandwidth-sdk/models/sms_message_content.rb +1 -1
- data/lib/bandwidth-sdk/models/standalone_card_orientation_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/status_callback.rb +1 -1
- data/lib/bandwidth-sdk/models/status_callback_message.rb +1 -1
- data/lib/bandwidth-sdk/models/status_callback_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/stir_shaken.rb +1 -1
- data/lib/bandwidth-sdk/models/sync_lookup_request.rb +1 -1
- data/lib/bandwidth-sdk/models/telephone_number.rb +1 -1
- data/lib/bandwidth-sdk/models/tfv_basic_authentication.rb +1 -1
- data/lib/bandwidth-sdk/models/tfv_callback_status_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/tfv_error.rb +1 -1
- data/lib/bandwidth-sdk/models/tfv_status.rb +1 -1
- data/lib/bandwidth-sdk/models/tfv_status_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/tfv_submission_info.rb +1 -1
- data/lib/bandwidth-sdk/models/tfv_submission_wrapper.rb +1 -1
- data/lib/bandwidth-sdk/models/thumbnail_alignment_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/transcribe_recording.rb +1 -1
- data/lib/bandwidth-sdk/models/transcription.rb +1 -1
- data/lib/bandwidth-sdk/models/transcription_available_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/transfer_answer_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/transfer_complete_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/update_call.rb +1 -1
- data/lib/bandwidth-sdk/models/update_call_recording.rb +1 -1
- data/lib/bandwidth-sdk/models/update_conference.rb +1 -1
- data/lib/bandwidth-sdk/models/update_conference_member.rb +1 -1
- data/lib/bandwidth-sdk/models/verification_denial_webhook.rb +1 -1
- data/lib/bandwidth-sdk/models/verification_request.rb +1 -1
- data/lib/bandwidth-sdk/models/verification_update_request.rb +1 -1
- data/lib/bandwidth-sdk/models/verification_webhook.rb +1 -1
- data/lib/bandwidth-sdk/models/verify_code_request.rb +1 -1
- data/lib/bandwidth-sdk/models/verify_code_response.rb +1 -1
- data/lib/bandwidth-sdk/models/voice_api_error.rb +1 -1
- data/lib/bandwidth-sdk/models/voice_code_response.rb +1 -1
- data/lib/bandwidth-sdk/models/webhook_subscription.rb +1 -1
- data/lib/bandwidth-sdk/models/webhook_subscription_basic_authentication.rb +1 -1
- data/lib/bandwidth-sdk/models/webhook_subscription_error.rb +1 -1
- data/lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb +1 -1
- data/lib/bandwidth-sdk/models/webhook_subscription_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/webhook_subscriptions_list_body.rb +1 -1
- data/lib/bandwidth-sdk/version.rb +2 -2
- data/lib/bandwidth-sdk.rb +4 -1
- data/openapitools.json +1 -1
- data/spec/unit/api/calls_api_spec.rb +1 -2
- data/spec/unit/api/conferences_api_spec.rb +1 -2
- data/spec/unit/api/endpoints_api_spec.rb +1 -2
- data/spec/unit/api/media_api_spec.rb +1 -2
- data/spec/unit/api/messages_api_spec.rb +1 -2
- data/spec/unit/api/mfa_api_spec.rb +1 -2
- data/spec/unit/api/multi_channel_api_spec.rb +1 -2
- data/spec/unit/api/phone_number_lookup_api_spec.rb +1 -2
- data/spec/unit/api/recordings_api_spec.rb +1 -2
- data/spec/unit/api/statistics_api_spec.rb +1 -2
- data/spec/unit/api/toll_free_verification_api_spec.rb +1 -2
- data/spec/unit/api/transcriptions_api_spec.rb +1 -2
- data/spec/unit/models/account_statistics_spec.rb +1 -1
- data/spec/unit/models/additional_denial_reason_spec.rb +1 -1
- data/spec/unit/models/address_spec.rb +1 -1
- data/spec/unit/models/answer_callback_spec.rb +8 -4
- data/spec/unit/models/async_lookup_request_spec.rb +1 -1
- data/spec/unit/models/blocked_webhook_spec.rb +1 -1
- data/spec/unit/models/bridge_complete_callback_spec.rb +1 -1
- data/spec/unit/models/bridge_target_complete_callback_spec.rb +1 -1
- data/spec/unit/models/brtc_error_response_spec.rb +1 -1
- data/spec/unit/models/brtc_error_source_spec.rb +1 -1
- data/spec/unit/models/brtc_error_spec.rb +1 -1
- data/spec/unit/models/brtc_link_spec.rb +1 -1
- data/spec/unit/models/bxml/verbs/refer_spec.rb +54 -0
- data/spec/unit/models/call_recording_metadata_spec.rb +1 -1
- data/spec/unit/models/call_state_spec.rb +1 -1
- data/spec/unit/models/call_transcription_metadata_spec.rb +1 -1
- data/spec/unit/models/call_transcription_response_spec.rb +1 -1
- data/spec/unit/models/call_transcription_spec.rb +1 -1
- data/spec/unit/models/code_request_spec.rb +1 -1
- data/spec/unit/models/conference_completed_callback_spec.rb +1 -1
- data/spec/unit/models/conference_created_callback_spec.rb +1 -1
- data/spec/unit/models/conference_member_exit_callback_spec.rb +1 -1
- data/spec/unit/models/conference_member_join_callback_spec.rb +1 -1
- data/spec/unit/models/conference_member_spec.rb +1 -1
- data/spec/unit/models/conference_recording_available_callback_spec.rb +1 -1
- data/spec/unit/models/conference_recording_metadata_spec.rb +1 -1
- data/spec/unit/models/conference_redirect_callback_spec.rb +1 -1
- data/spec/unit/models/conference_spec.rb +1 -1
- data/spec/unit/models/contact_spec.rb +1 -1
- data/spec/unit/models/create_async_bulk_lookup_response_data_spec.rb +1 -1
- data/spec/unit/models/create_async_bulk_lookup_response_spec.rb +1 -1
- data/spec/unit/models/create_call_response_spec.rb +1 -1
- data/spec/unit/models/create_call_spec.rb +1 -1
- data/spec/unit/models/create_endpoint_request_base_spec.rb +1 -1
- data/spec/unit/models/create_endpoint_response_data_spec.rb +1 -1
- data/spec/unit/models/create_endpoint_response_spec.rb +1 -1
- data/spec/unit/models/create_message_request_error_spec.rb +1 -1
- data/spec/unit/models/create_multi_channel_message_response_spec.rb +1 -1
- data/spec/unit/models/create_sync_lookup_response_data_spec.rb +1 -1
- data/spec/unit/models/create_sync_lookup_response_spec.rb +1 -1
- data/spec/unit/models/create_web_rtc_connection_request_spec.rb +1 -1
- data/spec/unit/models/device_spec.rb +1 -1
- data/spec/unit/models/disconnect_callback_spec.rb +12 -4
- data/spec/unit/models/diversion_spec.rb +1 -1
- data/spec/unit/models/dtmf_callback_spec.rb +1 -1
- data/spec/unit/models/endpoint_event_spec.rb +1 -1
- data/spec/unit/models/endpoint_response_spec.rb +1 -1
- data/spec/unit/models/endpoint_spec.rb +1 -1
- data/spec/unit/models/endpoints_spec.rb +1 -1
- data/spec/unit/models/error_object_spec.rb +1 -1
- data/spec/unit/models/error_source_spec.rb +1 -1
- data/spec/unit/models/failure_webhook_spec.rb +1 -1
- data/spec/unit/models/field_error_spec.rb +1 -1
- data/spec/unit/models/gather_callback_spec.rb +1 -1
- data/spec/unit/models/get_async_bulk_lookup_response_data_spec.rb +1 -1
- data/spec/unit/models/get_async_bulk_lookup_response_spec.rb +1 -1
- data/spec/unit/models/inbound_callback_message_spec.rb +1 -1
- data/spec/unit/models/inbound_callback_spec.rb +1 -1
- data/spec/unit/models/initiate_callback_spec.rb +13 -4
- data/spec/unit/models/link_schema_spec.rb +1 -1
- data/spec/unit/models/link_spec.rb +1 -1
- data/spec/unit/models/links_object_spec.rb +1 -1
- data/spec/unit/models/list_endpoints_response_spec.rb +1 -1
- data/spec/unit/models/list_message_item_spec.rb +1 -1
- data/spec/unit/models/lookup_error_response_spec.rb +1 -1
- data/spec/unit/models/lookup_error_schema_meta_spec.rb +1 -1
- data/spec/unit/models/lookup_error_schema_spec.rb +1 -1
- data/spec/unit/models/lookup_result_spec.rb +1 -1
- data/spec/unit/models/machine_detection_complete_callback_spec.rb +1 -1
- data/spec/unit/models/machine_detection_configuration_spec.rb +1 -1
- data/spec/unit/models/machine_detection_result_spec.rb +1 -1
- data/spec/unit/models/media_spec.rb +1 -1
- data/spec/unit/models/message_request_spec.rb +1 -1
- data/spec/unit/models/message_spec.rb +1 -1
- data/spec/unit/models/messages_list_spec.rb +1 -1
- data/spec/unit/models/messaging_code_response_spec.rb +1 -1
- data/spec/unit/models/messaging_request_error_spec.rb +1 -1
- data/spec/unit/models/mfa_forbidden_request_error_spec.rb +1 -1
- data/spec/unit/models/mfa_request_error_spec.rb +1 -1
- data/spec/unit/models/mfa_unauthorized_request_error_spec.rb +1 -1
- data/spec/unit/models/mms_message_content_file_spec.rb +1 -1
- data/spec/unit/models/mms_message_content_spec.rb +1 -1
- data/spec/unit/models/multi_channel_action_calendar_event_spec.rb +1 -1
- data/spec/unit/models/multi_channel_channel_list_mms_object_spec.rb +1 -1
- data/spec/unit/models/multi_channel_channel_list_mms_response_object_spec.rb +1 -1
- data/spec/unit/models/multi_channel_channel_list_object_base_spec.rb +1 -1
- data/spec/unit/models/multi_channel_channel_list_owner_object_spec.rb +1 -1
- data/spec/unit/models/multi_channel_channel_list_rbm_object_spec.rb +1 -1
- data/spec/unit/models/multi_channel_channel_list_rbm_response_object_spec.rb +1 -1
- data/spec/unit/models/multi_channel_channel_list_sms_object_spec.rb +1 -1
- data/spec/unit/models/multi_channel_channel_list_sms_response_object_spec.rb +1 -1
- data/spec/unit/models/multi_channel_error_spec.rb +1 -1
- data/spec/unit/models/multi_channel_message_content_spec.rb +1 -1
- data/spec/unit/models/multi_channel_message_request_spec.rb +1 -1
- data/spec/unit/models/multi_channel_message_response_data_spec.rb +1 -1
- data/spec/unit/models/opt_in_workflow_spec.rb +1 -1
- data/spec/unit/models/page_info_spec.rb +1 -1
- data/spec/unit/models/page_spec.rb +1 -1
- data/spec/unit/models/rbm_action_base_spec.rb +1 -1
- data/spec/unit/models/rbm_action_dial_spec.rb +1 -1
- data/spec/unit/models/rbm_action_open_url_spec.rb +1 -1
- data/spec/unit/models/rbm_action_view_location_spec.rb +1 -1
- data/spec/unit/models/rbm_card_content_media_spec.rb +1 -1
- data/spec/unit/models/rbm_card_content_spec.rb +1 -1
- data/spec/unit/models/rbm_location_response_spec.rb +1 -1
- data/spec/unit/models/rbm_message_carousel_card_spec.rb +1 -1
- data/spec/unit/models/rbm_message_content_file_spec.rb +1 -1
- data/spec/unit/models/rbm_message_content_text_spec.rb +1 -1
- data/spec/unit/models/rbm_message_media_spec.rb +1 -1
- data/spec/unit/models/rbm_standalone_card_spec.rb +1 -1
- data/spec/unit/models/rbm_suggestion_response_spec.rb +1 -1
- data/spec/unit/models/recording_available_callback_spec.rb +1 -1
- data/spec/unit/models/recording_complete_callback_spec.rb +1 -1
- data/spec/unit/models/recording_transcription_clip_spec.rb +1 -1
- data/spec/unit/models/recording_transcription_metadata_spec.rb +1 -1
- data/spec/unit/models/recording_transcriptions_spec.rb +1 -1
- data/spec/unit/models/redirect_callback_spec.rb +1 -1
- data/spec/unit/models/refer_call_status_enum_spec.rb +31 -0
- data/spec/unit/models/refer_complete_callback_spec.rb +123 -0
- data/spec/unit/models/sip_connection_metadata_spec.rb +1 -1
- data/spec/unit/models/sip_credentials_spec.rb +1 -1
- data/spec/unit/models/sms_message_content_spec.rb +1 -1
- data/spec/unit/models/status_callback_message_spec.rb +1 -1
- data/spec/unit/models/status_callback_spec.rb +1 -1
- data/spec/unit/models/stir_shaken_spec.rb +1 -1
- data/spec/unit/models/sync_lookup_request_spec.rb +1 -1
- data/spec/unit/models/telephone_number_spec.rb +1 -1
- data/spec/unit/models/tfv_basic_authentication_spec.rb +1 -1
- data/spec/unit/models/tfv_error_spec.rb +1 -1
- data/spec/unit/models/tfv_status_spec.rb +1 -1
- data/spec/unit/models/tfv_submission_info_spec.rb +1 -1
- data/spec/unit/models/tfv_submission_wrapper_spec.rb +1 -1
- data/spec/unit/models/transcribe_recording_spec.rb +1 -1
- data/spec/unit/models/transcription_available_callback_spec.rb +1 -1
- data/spec/unit/models/transcription_spec.rb +1 -1
- data/spec/unit/models/transfer_answer_callback_spec.rb +1 -1
- data/spec/unit/models/transfer_complete_callback_spec.rb +1 -1
- data/spec/unit/models/transfer_disconnect_callback_spec.rb +1 -1
- data/spec/unit/models/update_call_recording_spec.rb +1 -1
- data/spec/unit/models/update_call_spec.rb +1 -1
- data/spec/unit/models/update_conference_member_spec.rb +1 -1
- data/spec/unit/models/update_conference_spec.rb +1 -1
- data/spec/unit/models/verification_denial_webhook_spec.rb +1 -1
- data/spec/unit/models/verification_request_spec.rb +1 -1
- data/spec/unit/models/verification_update_request_spec.rb +1 -1
- data/spec/unit/models/verification_webhook_spec.rb +1 -1
- data/spec/unit/models/verify_code_request_spec.rb +1 -1
- data/spec/unit/models/verify_code_response_spec.rb +1 -1
- data/spec/unit/models/voice_api_error_spec.rb +1 -1
- data/spec/unit/models/voice_code_response_spec.rb +1 -1
- data/spec/unit/models/webhook_subscription_basic_authentication_spec.rb +1 -1
- data/spec/unit/models/webhook_subscription_error_spec.rb +1 -1
- data/spec/unit/models/webhook_subscription_request_schema_spec.rb +1 -1
- data/spec/unit/models/webhook_subscription_spec.rb +1 -1
- data/spec/unit/models/webhook_subscriptions_list_body_spec.rb +1 -1
- metadata +241 -227
|
@@ -65,6 +65,10 @@ module {{moduleName}}
|
|
|
65
65
|
# Defines the access token (Bearer) used with OAuth2.
|
|
66
66
|
attr_accessor :access_token
|
|
67
67
|
|
|
68
|
+
# Defines the URL used to obtain access tokens (Bearer) used with OAuth2.
|
|
69
|
+
# @return [String]
|
|
70
|
+
attr_accessor :access_token_url
|
|
71
|
+
|
|
68
72
|
# Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
|
|
69
73
|
# Overrides the access_token if set
|
|
70
74
|
# @return [Proc]
|
|
@@ -175,6 +179,7 @@ module {{moduleName}}
|
|
|
175
179
|
{{#authMethods}}
|
|
176
180
|
{{#isOAuth}}
|
|
177
181
|
@access_token_expiration = nil
|
|
182
|
+
@access_token_url = '{{tokenUrl}}'
|
|
178
183
|
@access_token_getter = Proc.new {
|
|
179
184
|
access_token_valid = @access_token && (@access_token_expiration.nil? || @access_token_expiration > Time.now + 60)
|
|
180
185
|
next @access_token if access_token_valid
|
|
@@ -182,9 +187,8 @@ module {{moduleName}}
|
|
|
182
187
|
|
|
183
188
|
puts "Refreshing access token..." if @debugging
|
|
184
189
|
# obtain new access token using client credentials
|
|
185
|
-
token_url = '{{tokenUrl}}'
|
|
186
190
|
auth_header = 'Basic ' + ["#{@client_id}:#{@client_secret}"].pack('m').delete("\r\n")
|
|
187
|
-
conn = Faraday.new(url:
|
|
191
|
+
conn = Faraday.new(url: @access_token_url) do |faraday|
|
|
188
192
|
faraday.request :url_encoded
|
|
189
193
|
faraday.adapter Faraday.default_adapter
|
|
190
194
|
end
|
|
@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
|
|
|
27
27
|
{{^isFaraday}}
|
|
28
28
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
|
29
29
|
{{/isFaraday}}
|
|
30
|
-
s.add_runtime_dependency 'ox', '~> 2.14'
|
|
30
|
+
s.add_runtime_dependency 'ox', '~> 2.14', '>= 2.14.28'
|
|
31
31
|
s.add_runtime_dependency 'marcel'
|
|
32
32
|
|
|
33
33
|
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
data/docs/AnswerCallback.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -18,6 +18,7 @@
|
|
|
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
20
|
| **machine_detection_result** | [**MachineDetectionResult**](MachineDetectionResult.md) | | [optional] |
|
|
21
|
+
| **sip_call_id** | **String** | (optional) The SIP Call-ID of the call's current SIP dialog with Bandwidth's SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. | [optional] |
|
|
21
22
|
|
|
22
23
|
## Example
|
|
23
24
|
|
|
@@ -38,7 +39,8 @@ instance = Bandwidth::AnswerCallback.new(
|
|
|
38
39
|
start_time: 2022-06-17T22:19:40.375Z,
|
|
39
40
|
answer_time: 2022-06-17T22:20Z,
|
|
40
41
|
tag: exampleTag,
|
|
41
|
-
machine_detection_result: null
|
|
42
|
+
machine_detection_result: null,
|
|
43
|
+
sip_call_id: c95ac8d6e1a31c52eb38f419893c151633ec68f8d@sbc.bandwidth.com
|
|
42
44
|
)
|
|
43
45
|
```
|
|
44
46
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
data/docs/DisconnectCallback.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -21,6 +21,8 @@
|
|
|
21
21
|
| **error_message** | **String** | Text explaining the reason that caused the call to fail in case of errors. | [optional] |
|
|
22
22
|
| **error_id** | **String** | Bandwidth's internal id that references the error event. | [optional] |
|
|
23
23
|
| **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] |
|
|
24
|
+
| **sip_call_id** | **String** | (optional) The SIP Call-ID of the call's current SIP dialog with Bandwidth's SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. | [optional] |
|
|
25
|
+
| **sip_response_code** | **Integer** | (optional) The SIP status code returned by Bandwidth's SBC when it rejected an outbound call's INVITE (e.g. 486 for busy, 603 for decline). Present only when an outbound call was rejected by the SBC. | [optional] |
|
|
24
26
|
|
|
25
27
|
## Example
|
|
26
28
|
|
|
@@ -44,7 +46,9 @@ instance = Bandwidth::DisconnectCallback.new(
|
|
|
44
46
|
cause: busy,
|
|
45
47
|
error_message: Call c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f is already bridged with another call,
|
|
46
48
|
error_id: 4642074b-7b58-478b-96e4-3a60955c6765,
|
|
47
|
-
tag: exampleTag
|
|
49
|
+
tag: exampleTag,
|
|
50
|
+
sip_call_id: c95ac8d6e1a31c52eb38f419893c151633ec68f8d@sbc.bandwidth.com,
|
|
51
|
+
sip_response_code: 486
|
|
48
52
|
)
|
|
49
53
|
```
|
|
50
54
|
|
data/docs/DtmfCallback.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
data/docs/GatherCallback.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
data/docs/InitiateCallback.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -17,6 +17,8 @@
|
|
|
17
17
|
| **diversion** | [**Diversion**](Diversion.md) | | [optional] |
|
|
18
18
|
| **stir_shaken** | [**StirShaken**](StirShaken.md) | | [optional] |
|
|
19
19
|
| **uui** | **String** | The value of the `User-To-User` header to send within the initial `INVITE`. Must include the encoding parameter as specified in RFC 7433. Only `base64`, `jwt` and `hex` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. | [optional] |
|
|
20
|
+
| **sip_call_id** | **String** | (optional) The SIP Call-ID of the call's current SIP dialog with Bandwidth's SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. | [optional] |
|
|
21
|
+
| **sip_headers** | **Hash<String, String>** | (optional) Map of customer-supplied X-* headers from the original INVITE. Keys are lowercase (SIP headers are case-insensitive). Present only for inbound SIP URI calls with custom headers. Note - keys preserve the original SIP header name in lowercase rather than Bandwidth's usual camelCase JSON convention, since these are passthrough values from the caller's SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept. | [optional] |
|
|
20
22
|
|
|
21
23
|
## Example
|
|
22
24
|
|
|
@@ -36,7 +38,9 @@ instance = Bandwidth::InitiateCallback.new(
|
|
|
36
38
|
start_time: 2022-06-17T22:19:40.375Z,
|
|
37
39
|
diversion: null,
|
|
38
40
|
stir_shaken: null,
|
|
39
|
-
uui: bXktdXVp
|
|
41
|
+
uui: bXktdXVp,
|
|
42
|
+
sip_call_id: c95ac8d6e1a31c52eb38f419893c151633ec68f8d@sbc.bandwidth.com,
|
|
43
|
+
sip_headers: {"x-custom-header":"customer-value","x-session-id":"sess-12345"}
|
|
40
44
|
)
|
|
41
45
|
```
|
|
42
46
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
data/docs/MediaApi.md
CHANGED
|
@@ -34,7 +34,7 @@ Bandwidth.configure do |config|
|
|
|
34
34
|
end
|
|
35
35
|
|
|
36
36
|
api_instance = Bandwidth::MediaApi.new
|
|
37
|
-
account_id = '9900000' # String |
|
|
37
|
+
account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
38
38
|
media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve.
|
|
39
39
|
|
|
40
40
|
begin
|
|
@@ -67,7 +67,7 @@ end
|
|
|
67
67
|
|
|
68
68
|
| Name | Type | Description | Notes |
|
|
69
69
|
| ---- | ---- | ----------- | ----- |
|
|
70
|
-
| **account_id** | **String** |
|
|
70
|
+
| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | |
|
|
71
71
|
| **media_id** | **String** | Media ID to retrieve. | |
|
|
72
72
|
|
|
73
73
|
### Return type
|
|
@@ -108,7 +108,7 @@ Bandwidth.configure do |config|
|
|
|
108
108
|
end
|
|
109
109
|
|
|
110
110
|
api_instance = Bandwidth::MediaApi.new
|
|
111
|
-
account_id = '9900000' # String |
|
|
111
|
+
account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
112
112
|
media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve.
|
|
113
113
|
|
|
114
114
|
begin
|
|
@@ -142,7 +142,7 @@ end
|
|
|
142
142
|
|
|
143
143
|
| Name | Type | Description | Notes |
|
|
144
144
|
| ---- | ---- | ----------- | ----- |
|
|
145
|
-
| **account_id** | **String** |
|
|
145
|
+
| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | |
|
|
146
146
|
| **media_id** | **String** | Media ID to retrieve. | |
|
|
147
147
|
|
|
148
148
|
### Return type
|
|
@@ -183,7 +183,7 @@ Bandwidth.configure do |config|
|
|
|
183
183
|
end
|
|
184
184
|
|
|
185
185
|
api_instance = Bandwidth::MediaApi.new
|
|
186
|
-
account_id = '9900000' # String |
|
|
186
|
+
account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
187
187
|
opts = {
|
|
188
188
|
continuation_token: '1XEi2tsFtLo1JbtLwETnM1ZJ+PqAa8w6ENvC5QKvwyrCDYII663Gy5M4s40owR1tjkuWUif6qbWvFtQJR5/ipqbUnfAqL254LKNlPy6tATCzioKSuHuOqgzloDkSwRtX0LtcL2otHS69hK343m+SjdL+vlj71tT39' # String | Continuation token used to retrieve subsequent media.
|
|
189
189
|
}
|
|
@@ -219,7 +219,7 @@ end
|
|
|
219
219
|
|
|
220
220
|
| Name | Type | Description | Notes |
|
|
221
221
|
| ---- | ---- | ----------- | ----- |
|
|
222
|
-
| **account_id** | **String** |
|
|
222
|
+
| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | |
|
|
223
223
|
| **continuation_token** | **String** | Continuation token used to retrieve subsequent media. | [optional] |
|
|
224
224
|
|
|
225
225
|
### Return type
|
|
@@ -260,7 +260,7 @@ Bandwidth.configure do |config|
|
|
|
260
260
|
end
|
|
261
261
|
|
|
262
262
|
api_instance = Bandwidth::MediaApi.new
|
|
263
|
-
account_id = '9900000' # String |
|
|
263
|
+
account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
264
264
|
media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve.
|
|
265
265
|
body = File.new('/path/to/some/file') # File |
|
|
266
266
|
opts = {
|
|
@@ -298,7 +298,7 @@ end
|
|
|
298
298
|
|
|
299
299
|
| Name | Type | Description | Notes |
|
|
300
300
|
| ---- | ---- | ----------- | ----- |
|
|
301
|
-
| **account_id** | **String** |
|
|
301
|
+
| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | |
|
|
302
302
|
| **media_id** | **String** | Media ID to retrieve. | |
|
|
303
303
|
| **body** | **File** | | |
|
|
304
304
|
| **content_type** | **String** | The media type of the entity-body. | [optional] |
|
data/docs/MessagesApi.md
CHANGED
|
@@ -32,7 +32,7 @@ Bandwidth.configure do |config|
|
|
|
32
32
|
end
|
|
33
33
|
|
|
34
34
|
api_instance = Bandwidth::MessagesApi.new
|
|
35
|
-
account_id = '9900000' # String |
|
|
35
|
+
account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
36
36
|
message_request = Bandwidth::MessageRequest.new({application_id: '93de2206-9669-4e07-948d-329f4b722ee2', to: ["+15554443333", "+15552223333"], from: '+15551113333'}) # MessageRequest |
|
|
37
37
|
|
|
38
38
|
begin
|
|
@@ -66,7 +66,7 @@ end
|
|
|
66
66
|
|
|
67
67
|
| Name | Type | Description | Notes |
|
|
68
68
|
| ---- | ---- | ----------- | ----- |
|
|
69
|
-
| **account_id** | **String** |
|
|
69
|
+
| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | |
|
|
70
70
|
| **message_request** | [**MessageRequest**](MessageRequest.md) | | |
|
|
71
71
|
|
|
72
72
|
### Return type
|
|
@@ -107,7 +107,7 @@ Bandwidth.configure do |config|
|
|
|
107
107
|
end
|
|
108
108
|
|
|
109
109
|
api_instance = Bandwidth::MessagesApi.new
|
|
110
|
-
account_id = '9900000' # String |
|
|
110
|
+
account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
111
111
|
opts = {
|
|
112
112
|
message_id: '9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6', # String | The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
|
|
113
113
|
source_tn: '%2B15554443333', # String | The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919').
|
|
@@ -169,7 +169,7 @@ end
|
|
|
169
169
|
|
|
170
170
|
| Name | Type | Description | Notes |
|
|
171
171
|
| ---- | ---- | ----------- | ----- |
|
|
172
|
-
| **account_id** | **String** |
|
|
172
|
+
| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | |
|
|
173
173
|
| **message_id** | **String** | The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. | [optional] |
|
|
174
174
|
| **source_tn** | **String** | The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). | [optional] |
|
|
175
175
|
| **destination_tn** | **String** | The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). | [optional] |
|
data/docs/MultiChannelApi.md
CHANGED
|
@@ -31,7 +31,7 @@ Bandwidth.configure do |config|
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
api_instance = Bandwidth::MultiChannelApi.new
|
|
34
|
-
account_id = '9900000' # String |
|
|
34
|
+
account_id = '9900000' # String | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
|
|
35
35
|
multi_channel_message_request = Bandwidth::MultiChannelMessageRequest.new({to: '+15552223333', channel_list: [Bandwidth::MultiChannelChannelListRequestObject.new({from: 'BandwidthRBM', application_id: '93de2206-9669-4e07-948d-329f4b722ee2', channel: Bandwidth::MultiChannelMessageChannelEnum::RBM, content: Bandwidth::MmsMessageContent.new})]}) # MultiChannelMessageRequest |
|
|
36
36
|
|
|
37
37
|
begin
|
|
@@ -65,7 +65,7 @@ end
|
|
|
65
65
|
|
|
66
66
|
| Name | Type | Description | Notes |
|
|
67
67
|
| ---- | ---- | ----------- | ----- |
|
|
68
|
-
| **account_id** | **String** |
|
|
68
|
+
| **account_id** | **String** | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | |
|
|
69
69
|
| **multi_channel_message_request** | [**MultiChannelMessageRequest**](MultiChannelMessageRequest.md) | | |
|
|
70
70
|
|
|
71
71
|
### Return type
|
data/docs/RbmActionBase.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
data/docs/RedirectCallback.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Bandwidth::ReferCallStatusEnum
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'bandwidth-sdk'
|
|
12
|
+
|
|
13
|
+
instance = Bandwidth::ReferCallStatusEnum.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Bandwidth::ReferCompleteCallback
|
|
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, referComplete, 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. Must be a phone number in E.164 format (e.g. +15555555555). | [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
|
+
| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
|
|
17
|
+
| **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
|
|
18
|
+
| **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] |
|
|
19
|
+
| **refer_call_status** | [**ReferCallStatusEnum**](ReferCallStatusEnum.md) | | [optional] |
|
|
20
|
+
| **refer_sip_response_code** | **Integer** | (optional) The SIP response code returned for the REFER request itself (e.g. 202, 405, 603). Present when a SIP response was received for the REFER. | [optional] |
|
|
21
|
+
| **notify_sip_response_code** | **Integer** | (optional) The final SIP response code reported via NOTIFY (message/sipfrag body). Present only when the caller's endpoint sent a final NOTIFY (e.g. 200, 404, 486, 503). Not present on NOTIFY timeout or when the REFER was rejected before a subscription was established. | [optional] |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'bandwidth-sdk'
|
|
27
|
+
|
|
28
|
+
instance = Bandwidth::ReferCompleteCallback.new(
|
|
29
|
+
event_type: bridgeComplete,
|
|
30
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
|
31
|
+
account_id: 9900000,
|
|
32
|
+
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
|
33
|
+
from: +15555555555,
|
|
34
|
+
to: +15555555555,
|
|
35
|
+
direction: null,
|
|
36
|
+
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
37
|
+
call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
38
|
+
start_time: 2022-06-17T22:19:40.375Z,
|
|
39
|
+
answer_time: 2022-06-17T22:20Z,
|
|
40
|
+
tag: exampleTag,
|
|
41
|
+
refer_call_status: null,
|
|
42
|
+
refer_sip_response_code: 202,
|
|
43
|
+
notify_sip_response_code: 200
|
|
44
|
+
)
|
|
45
|
+
```
|
|
46
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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] |
|
|
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, referComplete, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
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] |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: letstalk@bandwidth.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -49,7 +49,7 @@ module Bandwidth
|
|
|
49
49
|
fail ArgumentError, "Missing the required parameter 'create_call' when calling CallsApi.create_call"
|
|
50
50
|
end
|
|
51
51
|
# resource path
|
|
52
|
-
local_var_path = '/accounts/{accountId}/calls'.sub('{
|
|
52
|
+
local_var_path = '/accounts/{accountId}/calls'.sub('{accountId}', CGI.escape(account_id.to_s))
|
|
53
53
|
|
|
54
54
|
# query parameters
|
|
55
55
|
query_params = opts[:query_params] || {}
|
|
@@ -123,7 +123,7 @@ module Bandwidth
|
|
|
123
123
|
fail ArgumentError, "Missing the required parameter 'call_id' when calling CallsApi.get_call_state"
|
|
124
124
|
end
|
|
125
125
|
# resource path
|
|
126
|
-
local_var_path = '/accounts/{accountId}/calls/{callId}'.sub('{
|
|
126
|
+
local_var_path = '/accounts/{accountId}/calls/{callId}'.sub('{accountId}', CGI.escape(account_id.to_s)).sub('{callId}', CGI.escape(call_id.to_s))
|
|
127
127
|
|
|
128
128
|
# query parameters
|
|
129
129
|
query_params = opts[:query_params] || {}
|
|
@@ -208,7 +208,7 @@ module Bandwidth
|
|
|
208
208
|
end
|
|
209
209
|
|
|
210
210
|
# resource path
|
|
211
|
-
local_var_path = '/accounts/{accountId}/calls'.sub('{
|
|
211
|
+
local_var_path = '/accounts/{accountId}/calls'.sub('{accountId}', CGI.escape(account_id.to_s))
|
|
212
212
|
|
|
213
213
|
# query parameters
|
|
214
214
|
query_params = opts[:query_params] || {}
|
|
@@ -290,7 +290,7 @@ module Bandwidth
|
|
|
290
290
|
fail ArgumentError, "Missing the required parameter 'update_call' when calling CallsApi.update_call"
|
|
291
291
|
end
|
|
292
292
|
# resource path
|
|
293
|
-
local_var_path = '/accounts/{accountId}/calls/{callId}'.sub('{
|
|
293
|
+
local_var_path = '/accounts/{accountId}/calls/{callId}'.sub('{accountId}', CGI.escape(account_id.to_s)).sub('{callId}', CGI.escape(call_id.to_s))
|
|
294
294
|
|
|
295
295
|
# query parameters
|
|
296
296
|
query_params = opts[:query_params] || {}
|
|
@@ -370,7 +370,7 @@ module Bandwidth
|
|
|
370
370
|
fail ArgumentError, "Missing the required parameter 'body' when calling CallsApi.update_call_bxml"
|
|
371
371
|
end
|
|
372
372
|
# resource path
|
|
373
|
-
local_var_path = '/accounts/{accountId}/calls/{callId}/bxml'.sub('{
|
|
373
|
+
local_var_path = '/accounts/{accountId}/calls/{callId}/bxml'.sub('{accountId}', CGI.escape(account_id.to_s)).sub('{callId}', CGI.escape(call_id.to_s))
|
|
374
374
|
|
|
375
375
|
# query parameters
|
|
376
376
|
query_params = opts[:query_params] || {}
|