freeclimb 5.0.0 → 5.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/CHANGELOG.md +21 -1
- data/Gemfile +4 -4
- data/Gemfile.lock +34 -15
- data/README.md +5 -4
- data/Rakefile +1 -1
- data/docs/CreateConferenceRequest.md +1 -1
- data/docs/DefaultApi.md +1 -1
- data/docs/MessageResult.md +7 -1
- data/docs/TFNCampaign.md +34 -0
- data/freeclimb.gemspec +21 -26
- data/lib/freeclimb/api/default_api.rb +878 -878
- data/lib/freeclimb/api_client.rb +78 -83
- data/lib/freeclimb/api_error.rb +17 -19
- data/lib/freeclimb/configuration.rb +28 -31
- data/lib/freeclimb/models/account_request.rb +36 -41
- data/lib/freeclimb/models/account_result.rb +88 -92
- data/lib/freeclimb/models/account_status.rb +12 -14
- data/lib/freeclimb/models/account_type.rb +12 -14
- data/lib/freeclimb/models/add_to_conference.rb +81 -85
- data/lib/freeclimb/models/add_to_conference_notification_webhook.rb +99 -103
- data/lib/freeclimb/models/add_to_queue_notification_webhook.rb +78 -82
- data/lib/freeclimb/models/answered_by.rb +12 -14
- data/lib/freeclimb/models/application_list.rb +74 -78
- data/lib/freeclimb/models/application_request.rb +66 -70
- data/lib/freeclimb/models/application_result.rb +100 -104
- data/lib/freeclimb/models/available_number.rb +66 -70
- data/lib/freeclimb/models/available_number_list.rb +74 -78
- data/lib/freeclimb/models/barge_in_reason.rb +12 -14
- data/lib/freeclimb/models/buy_incoming_number_request.rb +41 -45
- data/lib/freeclimb/models/call_control_webhook.rb +56 -61
- data/lib/freeclimb/models/call_direction.rb +12 -14
- data/lib/freeclimb/models/call_ended_reason.rb +12 -14
- data/lib/freeclimb/models/call_list.rb +74 -78
- data/lib/freeclimb/models/call_result.rb +142 -146
- data/lib/freeclimb/models/call_status.rb +12 -14
- data/lib/freeclimb/models/call_status_webhook.rb +84 -88
- data/lib/freeclimb/models/capabilities.rb +55 -59
- data/lib/freeclimb/models/completion_request.rb +32 -36
- data/lib/freeclimb/models/completion_result.rb +36 -40
- data/lib/freeclimb/models/completion_result_status.rb +12 -14
- data/lib/freeclimb/models/conference_list.rb +74 -78
- data/lib/freeclimb/models/conference_participant_list.rb +74 -78
- data/lib/freeclimb/models/conference_participant_result.rb +88 -92
- data/lib/freeclimb/models/conference_recording_status_webhook.rb +99 -103
- data/lib/freeclimb/models/conference_result.rb +106 -110
- data/lib/freeclimb/models/conference_status.rb +12 -14
- data/lib/freeclimb/models/conference_status_webhook.rb +102 -106
- data/lib/freeclimb/models/create_conference.rb +60 -63
- data/lib/freeclimb/models/create_conference_request.rb +55 -54
- data/lib/freeclimb/models/create_conference_webhook.rb +102 -106
- data/lib/freeclimb/models/create_web_rtc_token.rb +42 -46
- data/lib/freeclimb/models/dequeue.rb +30 -37
- data/lib/freeclimb/models/dequeue_webhook.rb +89 -93
- data/lib/freeclimb/models/enqueue.rb +48 -52
- data/lib/freeclimb/models/filter_logs_request.rb +31 -35
- data/lib/freeclimb/models/get_digits.rb +73 -77
- data/lib/freeclimb/models/get_digits_reason.rb +12 -14
- data/lib/freeclimb/models/get_digits_webhook.rb +93 -97
- data/lib/freeclimb/models/get_speech.rb +94 -97
- data/lib/freeclimb/models/get_speech_reason.rb +12 -14
- data/lib/freeclimb/models/get_speech_webhook.rb +118 -122
- data/lib/freeclimb/models/grammar_file_built_in.rb +12 -14
- data/lib/freeclimb/models/grammar_type.rb +12 -14
- data/lib/freeclimb/models/hangup.rb +34 -39
- data/lib/freeclimb/models/if_machine.rb +12 -14
- data/lib/freeclimb/models/inbound_call_webhook.rb +85 -89
- data/lib/freeclimb/models/incoming_number_list.rb +74 -78
- data/lib/freeclimb/models/incoming_number_request.rb +41 -45
- data/lib/freeclimb/models/incoming_number_result.rb +122 -126
- data/lib/freeclimb/models/language.rb +12 -14
- data/lib/freeclimb/models/leave_conference_webhook.rb +79 -83
- data/lib/freeclimb/models/log_level.rb +12 -14
- data/lib/freeclimb/models/log_list.rb +74 -78
- data/lib/freeclimb/models/log_result.rb +67 -71
- data/lib/freeclimb/models/machine_detected_webhook.rb +89 -93
- data/lib/freeclimb/models/machine_type.rb +12 -14
- data/lib/freeclimb/models/make_call_request.rb +77 -81
- data/lib/freeclimb/models/message_delivery_webhook.rb +81 -86
- data/lib/freeclimb/models/message_direction.rb +12 -14
- data/lib/freeclimb/models/message_request.rb +72 -75
- data/lib/freeclimb/models/message_result.rb +150 -123
- data/lib/freeclimb/models/message_status.rb +12 -14
- data/lib/freeclimb/models/message_status_webhook.rb +86 -90
- data/lib/freeclimb/models/messages_list.rb +74 -78
- data/lib/freeclimb/models/mutable_resource_model.rb +46 -51
- data/lib/freeclimb/models/out_dial.rb +80 -84
- data/lib/freeclimb/models/out_dial_api_connect_webhook.rb +84 -88
- data/lib/freeclimb/models/out_dial_connect_webhook.rb +84 -88
- data/lib/freeclimb/models/out_dial_start_webhook.rb +90 -94
- data/lib/freeclimb/models/pagination_model.rb +67 -71
- data/lib/freeclimb/models/park.rb +44 -48
- data/lib/freeclimb/models/pause.rb +33 -37
- data/lib/freeclimb/models/percl_command.rb +36 -40
- data/lib/freeclimb/models/percl_script.rb +32 -36
- data/lib/freeclimb/models/play.rb +44 -48
- data/lib/freeclimb/models/play_beep.rb +12 -14
- data/lib/freeclimb/models/play_early_media.rb +33 -37
- data/lib/freeclimb/models/queue_list.rb +74 -78
- data/lib/freeclimb/models/queue_member.rb +55 -59
- data/lib/freeclimb/models/queue_member_list.rb +74 -78
- data/lib/freeclimb/models/queue_request.rb +37 -42
- data/lib/freeclimb/models/queue_result.rb +88 -92
- data/lib/freeclimb/models/queue_result_status.rb +12 -14
- data/lib/freeclimb/models/queue_wait_webhook.rb +94 -98
- data/lib/freeclimb/models/record_utterance.rb +63 -67
- data/lib/freeclimb/models/record_utterance_term_reason.rb +12 -14
- data/lib/freeclimb/models/record_webhook.rb +119 -123
- data/lib/freeclimb/models/recording_list.rb +74 -78
- data/lib/freeclimb/models/recording_result.rb +76 -80
- data/lib/freeclimb/models/redirect.rb +33 -37
- data/lib/freeclimb/models/redirect_webhook.rb +84 -88
- data/lib/freeclimb/models/reject.rb +34 -39
- data/lib/freeclimb/models/remove_from_conference.rb +30 -37
- data/lib/freeclimb/models/remove_from_queue_notification_webhook.rb +89 -93
- data/lib/freeclimb/models/request_type.rb +12 -14
- data/lib/freeclimb/models/say.rb +49 -53
- data/lib/freeclimb/models/send_digits.rb +43 -47
- data/lib/freeclimb/models/set_dtmf_pass_through.rb +34 -39
- data/lib/freeclimb/models/set_listen.rb +34 -39
- data/lib/freeclimb/models/set_talk.rb +34 -39
- data/lib/freeclimb/models/sms.rb +48 -52
- data/lib/freeclimb/models/sms_ten_dlc_brand.rb +187 -190
- data/lib/freeclimb/models/sms_ten_dlc_brand_alt_business_id_type.rb +12 -14
- data/lib/freeclimb/models/sms_ten_dlc_brand_entity_type.rb +12 -14
- data/lib/freeclimb/models/sms_ten_dlc_brand_identity_status.rb +12 -14
- data/lib/freeclimb/models/sms_ten_dlc_brand_relationship.rb +12 -14
- data/lib/freeclimb/models/sms_ten_dlc_brand_stock_exchange.rb +12 -14
- data/lib/freeclimb/models/sms_ten_dlc_brands_list_result.rb +74 -78
- data/lib/freeclimb/models/sms_ten_dlc_campaign.rb +226 -229
- data/lib/freeclimb/models/sms_ten_dlc_campaign_status.rb +12 -14
- data/lib/freeclimb/models/sms_ten_dlc_campaigns_list_result.rb +74 -78
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaign.rb +186 -189
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaign_brand.rb +84 -87
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaign_status.rb +12 -14
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaigns_list_result.rb +74 -78
- data/lib/freeclimb/models/sms_toll_free_campaign.rb +61 -64
- data/lib/freeclimb/models/sms_toll_free_campaign_registration_status.rb +12 -14
- data/lib/freeclimb/models/sms_toll_free_campaigns_list_result.rb +74 -78
- data/lib/freeclimb/models/start_record_call.rb +30 -37
- data/lib/freeclimb/models/terminate_conference.rb +30 -37
- data/lib/freeclimb/models/tfn.rb +31 -35
- data/lib/freeclimb/models/tfn_campaign.rb +367 -0
- data/lib/freeclimb/models/transcribe_reason.rb +12 -14
- data/lib/freeclimb/models/transcribe_term_reason.rb +12 -14
- data/lib/freeclimb/models/transcribe_utterance.rb +61 -65
- data/lib/freeclimb/models/transcribe_utterance_record.rb +43 -47
- data/lib/freeclimb/models/transcribe_webhook.rb +150 -154
- data/lib/freeclimb/models/unpark.rb +30 -37
- data/lib/freeclimb/models/update_call_request.rb +31 -35
- data/lib/freeclimb/models/update_call_request_status.rb +12 -14
- data/lib/freeclimb/models/update_conference_participant_request.rb +41 -46
- data/lib/freeclimb/models/update_conference_request.rb +41 -45
- data/lib/freeclimb/models/update_conference_request_status.rb +12 -14
- data/lib/freeclimb/models/webhook.rb +32 -37
- data/lib/freeclimb/utils/request_verifier.rb +14 -14
- data/lib/freeclimb/utils/signature_information.rb +8 -8
- data/lib/freeclimb/version.rb +10 -12
- data/lib/freeclimb.rb +156 -157
- data/openapi.json +96 -38
- data/package.json +1 -1
- data/spec/api/default_api_spec.rb +531 -793
- data/spec/api_client_spec.rb +100 -102
- data/spec/configuration_spec.rb +16 -18
- data/spec/models/account_request_spec.rb +106 -124
- data/spec/models/account_result_spec.rb +396 -453
- data/spec/models/account_status_spec.rb +28 -30
- data/spec/models/account_type_spec.rb +25 -27
- data/spec/models/add_to_conference_notification_webhook_spec.rb +465 -549
- data/spec/models/add_to_conference_spec.rb +355 -382
- data/spec/models/add_to_queue_notification_webhook_spec.rb +342 -402
- data/spec/models/answered_by_spec.rb +25 -27
- data/spec/models/application_list_spec.rb +290 -326
- data/spec/models/application_request_spec.rb +266 -289
- data/spec/models/application_result_spec.rb +445 -476
- data/spec/models/available_number_list_spec.rb +290 -326
- data/spec/models/available_number_spec.rb +279 -299
- data/spec/models/barge_in_reason_spec.rb +28 -30
- data/spec/models/buy_incoming_number_request_spec.rb +137 -156
- data/spec/models/call_control_webhook_spec.rb +204 -225
- data/spec/models/call_direction_spec.rb +28 -30
- data/spec/models/call_ended_reason_spec.rb +108 -110
- data/spec/models/call_list_spec.rb +290 -326
- data/spec/models/call_result_spec.rb +684 -772
- data/spec/models/call_status_spec.rb +48 -50
- data/spec/models/call_status_webhook_spec.rb +414 -492
- data/spec/models/capabilities_spec.rb +203 -223
- data/spec/models/completion_request_spec.rb +76 -92
- data/spec/models/completion_result_spec.rb +107 -143
- data/spec/models/completion_result_status_spec.rb +25 -27
- data/spec/models/conference_list_spec.rb +290 -326
- data/spec/models/conference_participant_list_spec.rb +290 -326
- data/spec/models/conference_participant_result_spec.rb +385 -414
- data/spec/models/conference_recording_status_webhook_spec.rb +465 -549
- data/spec/models/conference_result_spec.rb +492 -553
- data/spec/models/conference_status_spec.rb +32 -34
- data/spec/models/conference_status_webhook_spec.rb +465 -549
- data/spec/models/create_conference_request_spec.rb +205 -245
- data/spec/models/create_conference_spec.rb +237 -278
- data/spec/models/create_conference_webhook_spec.rb +465 -549
- data/spec/models/create_web_rtc_token_spec.rb +137 -159
- data/spec/models/dequeue_spec.rb +15 -17
- data/spec/models/dequeue_webhook_spec.rb +401 -465
- data/spec/models/enqueue_spec.rb +170 -190
- data/spec/models/filter_logs_request_spec.rb +74 -91
- data/spec/models/get_digits_reason_spec.rb +32 -34
- data/spec/models/get_digits_spec.rb +327 -361
- data/spec/models/get_digits_webhook_spec.rb +436 -517
- data/spec/models/get_speech_reason_spec.rb +40 -42
- data/spec/models/get_speech_spec.rb +400 -492
- data/spec/models/get_speech_webhook_spec.rb +608 -698
- data/spec/models/grammar_file_built_in_spec.rb +76 -78
- data/spec/models/grammar_type_spec.rb +25 -27
- data/spec/models/hangup_spec.rb +74 -91
- data/spec/models/if_machine_spec.rb +25 -27
- data/spec/models/inbound_call_webhook_spec.rb +372 -433
- data/spec/models/incoming_number_list_spec.rb +290 -326
- data/spec/models/incoming_number_request_spec.rb +137 -156
- data/spec/models/incoming_number_result_spec.rb +584 -613
- data/spec/models/language_spec.rb +121 -123
- data/spec/models/leave_conference_webhook_spec.rb +342 -402
- data/spec/models/log_level_spec.rb +28 -30
- data/spec/models/log_list_spec.rb +290 -326
- data/spec/models/log_result_spec.rb +275 -311
- data/spec/models/machine_detected_webhook_spec.rb +402 -482
- data/spec/models/machine_type_spec.rb +25 -27
- data/spec/models/make_call_request_spec.rb +354 -383
- data/spec/models/message_delivery_webhook_spec.rb +358 -384
- data/spec/models/message_direction_spec.rb +25 -27
- data/spec/models/message_request_spec.rb +325 -352
- data/spec/models/message_result_spec.rb +674 -598
- data/spec/models/message_status_spec.rb +61 -63
- data/spec/models/message_status_webhook_spec.rb +406 -451
- data/spec/models/messages_list_spec.rb +290 -326
- data/spec/models/mutable_resource_model_spec.rb +169 -191
- data/spec/models/out_dial_api_connect_webhook_spec.rb +372 -433
- data/spec/models/out_dial_connect_webhook_spec.rb +372 -433
- data/spec/models/out_dial_spec.rb +355 -401
- data/spec/models/out_dial_start_webhook_spec.rb +402 -464
- data/spec/models/pagination_model_spec.rb +260 -295
- data/spec/models/park_spec.rb +137 -156
- data/spec/models/pause_spec.rb +73 -92
- data/spec/models/percl_command_spec.rb +77 -94
- data/spec/models/percl_script_spec.rb +74 -91
- data/spec/models/play_beep_spec.rb +32 -34
- data/spec/models/play_early_media_spec.rb +74 -91
- data/spec/models/play_spec.rb +136 -157
- data/spec/models/queue_list_spec.rb +290 -326
- data/spec/models/queue_member_list_spec.rb +290 -326
- data/spec/models/queue_member_spec.rb +200 -225
- data/spec/models/queue_request_spec.rb +105 -125
- data/spec/models/queue_result_spec.rb +391 -419
- data/spec/models/queue_result_status_spec.rb +32 -34
- data/spec/models/queue_wait_webhook_spec.rb +430 -497
- data/spec/models/record_utterance_spec.rb +264 -291
- data/spec/models/record_utterance_term_reason_spec.rb +32 -34
- data/spec/models/record_webhook_spec.rb +605 -693
- data/spec/models/recording_list_spec.rb +290 -326
- data/spec/models/recording_result_spec.rb +324 -353
- data/spec/models/redirect_spec.rb +74 -91
- data/spec/models/redirect_webhook_spec.rb +372 -433
- data/spec/models/reject_spec.rb +74 -91
- data/spec/models/remove_from_conference_spec.rb +15 -17
- data/spec/models/remove_from_queue_notification_webhook_spec.rb +405 -487
- data/spec/models/request_type_spec.rb +108 -110
- data/spec/models/say_spec.rb +169 -191
- data/spec/models/send_digits_spec.rb +136 -157
- data/spec/models/set_dtmf_pass_through_spec.rb +75 -91
- data/spec/models/set_listen_spec.rb +75 -91
- data/spec/models/set_talk_spec.rb +75 -91
- data/spec/models/sms_spec.rb +170 -190
- data/spec/models/sms_ten_dlc_brand_alt_business_id_type_spec.rb +32 -34
- data/spec/models/sms_ten_dlc_brand_entity_type_spec.rb +36 -38
- data/spec/models/sms_ten_dlc_brand_identity_status_spec.rb +32 -34
- data/spec/models/sms_ten_dlc_brand_relationship_spec.rb +36 -38
- data/spec/models/sms_ten_dlc_brand_spec.rb +1083 -1201
- data/spec/models/sms_ten_dlc_brand_stock_exchange_spec.rb +125 -127
- data/spec/models/sms_ten_dlc_brands_list_result_spec.rb +290 -326
- data/spec/models/sms_ten_dlc_campaign_spec.rb +1140 -1208
- data/spec/models/sms_ten_dlc_campaign_status_spec.rb +25 -27
- data/spec/models/sms_ten_dlc_campaigns_list_result_spec.rb +290 -326
- data/spec/models/sms_ten_dlc_partner_campaign_brand_spec.rb +407 -425
- data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +965 -1015
- data/spec/models/sms_ten_dlc_partner_campaign_status_spec.rb +25 -27
- data/spec/models/sms_ten_dlc_partner_campaigns_list_result_spec.rb +290 -326
- data/spec/models/sms_toll_free_campaign_registration_status_spec.rb +36 -38
- data/spec/models/sms_toll_free_campaign_spec.rb +271 -314
- data/spec/models/sms_toll_free_campaigns_list_result_spec.rb +290 -326
- data/spec/models/start_record_call_spec.rb +15 -17
- data/spec/models/terminate_conference_spec.rb +15 -17
- data/spec/models/tfn_campaign_spec.rb +561 -0
- data/spec/models/tfn_spec.rb +74 -91
- data/spec/models/transcribe_reason_spec.rb +36 -38
- data/spec/models/transcribe_term_reason_spec.rb +25 -27
- data/spec/models/transcribe_utterance_record_spec.rb +135 -158
- data/spec/models/transcribe_utterance_spec.rb +245 -265
- data/spec/models/transcribe_webhook_spec.rb +750 -874
- data/spec/models/unpark_spec.rb +15 -17
- data/spec/models/update_call_request_spec.rb +75 -109
- data/spec/models/update_call_request_status_spec.rb +25 -27
- data/spec/models/update_conference_participant_request_spec.rb +138 -156
- data/spec/models/update_conference_request_spec.rb +141 -195
- data/spec/models/update_conference_request_status_spec.rb +25 -27
- data/spec/models/webhook_spec.rb +69 -86
- data/spec/quickstart_spec.rb +5 -5
- data/spec/spec_helper.rb +92 -100
- data/spec/utils/request_verifier_spec.rb +70 -71
- data/spec/utils/signature_information_spec.rb +23 -23
- data/yarn.lock +9 -0
- metadata +9 -153
@@ -1,17 +1,15 @@
|
|
1
|
-
|
2
|
-
#
|
3
|
-
|
4
|
-
#
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
require 'date'
|
14
|
-
require 'time'
|
1
|
+
# #FreeClimb API
|
2
|
+
#
|
3
|
+
# FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
|
4
|
+
#
|
5
|
+
# The version of the OpenAPI document: 1.0.0
|
6
|
+
# Contact: support@freeclimb.com
|
7
|
+
# Generated by: https://openapi-generator.tech
|
8
|
+
# OpenAPI Generator version: 7.9.0
|
9
|
+
#
|
10
|
+
|
11
|
+
require "date"
|
12
|
+
require "time"
|
15
13
|
|
16
14
|
module Freeclimb
|
17
15
|
# A POST request with the following fields will be sent to the actionUrl provided in your GetDigits command.
|
@@ -19,8 +17,8 @@ module Freeclimb
|
|
19
17
|
def self.deserialize(payload)
|
20
18
|
return nil if payload.nil? || payload.empty?
|
21
19
|
data = JSON.parse("[#{payload}]")[0]
|
22
|
-
inverted_attributes =
|
23
|
-
hash =
|
20
|
+
inverted_attributes = attribute_map.invert
|
21
|
+
hash = acceptable_attributes.uniq.map { |k| [inverted_attributes[k], data[k.to_s]] }.to_h
|
24
22
|
GetDigitsWebhook.new(hash)
|
25
23
|
end
|
26
24
|
# Context or reason why this request is being made. Will be getDigits - The GetDigits command has completed and its actionUrl is being invoked.
|
@@ -81,18 +79,18 @@ module Freeclimb
|
|
81
79
|
# Attribute mapping from ruby-style variable name to JSON key.
|
82
80
|
def self.attribute_map
|
83
81
|
{
|
84
|
-
:
|
85
|
-
:
|
86
|
-
:
|
87
|
-
:
|
88
|
-
:
|
89
|
-
:
|
90
|
-
:
|
91
|
-
:
|
92
|
-
:
|
93
|
-
:
|
94
|
-
:
|
95
|
-
:
|
82
|
+
request_type: :requestType,
|
83
|
+
call_id: :callId,
|
84
|
+
account_id: :accountId,
|
85
|
+
from: :from,
|
86
|
+
to: :to,
|
87
|
+
call_status: :callStatus,
|
88
|
+
direction: :direction,
|
89
|
+
conference_id: :conferenceId,
|
90
|
+
queue_id: :queueId,
|
91
|
+
digits: :digits,
|
92
|
+
reason: :reason,
|
93
|
+
parent_call_id: :parentCallId
|
96
94
|
}
|
97
95
|
end
|
98
96
|
|
@@ -104,145 +102,143 @@ module Freeclimb
|
|
104
102
|
# Attribute type mapping.
|
105
103
|
def self.openapi_types
|
106
104
|
{
|
107
|
-
:
|
108
|
-
:
|
109
|
-
:
|
110
|
-
:
|
111
|
-
:
|
112
|
-
:
|
113
|
-
:
|
114
|
-
:
|
115
|
-
:
|
116
|
-
:
|
117
|
-
:
|
118
|
-
:
|
105
|
+
request_type: :String,
|
106
|
+
call_id: :String,
|
107
|
+
account_id: :String,
|
108
|
+
from: :String,
|
109
|
+
to: :String,
|
110
|
+
call_status: :CallStatus,
|
111
|
+
direction: :CallDirection,
|
112
|
+
conference_id: :String,
|
113
|
+
queue_id: :String,
|
114
|
+
digits: :String,
|
115
|
+
reason: :GetDigitsReason,
|
116
|
+
parent_call_id: :String
|
119
117
|
}
|
120
118
|
end
|
121
119
|
|
122
120
|
# List of attributes with nullable: true
|
123
121
|
def self.openapi_nullable
|
124
122
|
Set.new([
|
125
|
-
:
|
126
|
-
:
|
127
|
-
:
|
123
|
+
:call_status,
|
124
|
+
:direction,
|
125
|
+
:queue_id
|
128
126
|
])
|
129
127
|
end
|
130
128
|
|
131
129
|
# List of class defined in allOf (OpenAPI v3)
|
132
130
|
def self.openapi_all_of
|
133
131
|
[
|
134
|
-
|
132
|
+
:Webhook
|
135
133
|
]
|
136
134
|
end
|
137
135
|
|
138
136
|
# Initializes the object
|
139
137
|
# @param [Hash] attributes Model attributes in the form of hash
|
140
138
|
def initialize(attributes = {})
|
141
|
-
if
|
139
|
+
if !attributes.is_a?(Hash)
|
142
140
|
fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::GetDigitsWebhook` initialize method"
|
143
141
|
end
|
144
142
|
|
145
143
|
# check to see if the attribute exists and convert string to symbol for hash key
|
146
144
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
147
|
-
if
|
145
|
+
if !self.class.attribute_map.key?(k.to_sym)
|
148
146
|
fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::GetDigitsWebhook`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
149
147
|
end
|
150
148
|
h[k.to_sym] = v
|
151
149
|
}
|
152
150
|
|
153
151
|
# call parent's initialize
|
154
|
-
super
|
152
|
+
super
|
155
153
|
|
156
|
-
if attributes.key?(:
|
157
|
-
self.request_type = attributes[:
|
154
|
+
if attributes.key?(:request_type)
|
155
|
+
self.request_type = attributes[:request_type]
|
158
156
|
end
|
159
157
|
|
160
|
-
if attributes.key?(:
|
161
|
-
self.call_id = attributes[:
|
158
|
+
if attributes.key?(:call_id)
|
159
|
+
self.call_id = attributes[:call_id]
|
162
160
|
end
|
163
161
|
|
164
|
-
if attributes.key?(:
|
165
|
-
self.account_id = attributes[:
|
162
|
+
if attributes.key?(:account_id)
|
163
|
+
self.account_id = attributes[:account_id]
|
166
164
|
end
|
167
165
|
|
168
|
-
if attributes.key?(:
|
169
|
-
self.from = attributes[:
|
166
|
+
if attributes.key?(:from)
|
167
|
+
self.from = attributes[:from]
|
170
168
|
end
|
171
169
|
|
172
|
-
if attributes.key?(:
|
173
|
-
self.to = attributes[:
|
170
|
+
if attributes.key?(:to)
|
171
|
+
self.to = attributes[:to]
|
174
172
|
end
|
175
173
|
|
176
|
-
if attributes.key?(:
|
177
|
-
self.call_status = attributes[:
|
174
|
+
if attributes.key?(:call_status)
|
175
|
+
self.call_status = attributes[:call_status]
|
178
176
|
end
|
179
177
|
|
180
|
-
if attributes.key?(:
|
181
|
-
self.direction = attributes[:
|
178
|
+
if attributes.key?(:direction)
|
179
|
+
self.direction = attributes[:direction]
|
182
180
|
end
|
183
181
|
|
184
|
-
if attributes.key?(:
|
185
|
-
self.conference_id = attributes[:
|
182
|
+
if attributes.key?(:conference_id)
|
183
|
+
self.conference_id = attributes[:conference_id]
|
186
184
|
end
|
187
185
|
|
188
|
-
if attributes.key?(:
|
189
|
-
self.queue_id = attributes[:
|
186
|
+
if attributes.key?(:queue_id)
|
187
|
+
self.queue_id = attributes[:queue_id]
|
190
188
|
end
|
191
189
|
|
192
|
-
if attributes.key?(:
|
193
|
-
self.digits = attributes[:
|
190
|
+
if attributes.key?(:digits)
|
191
|
+
self.digits = attributes[:digits]
|
194
192
|
end
|
195
193
|
|
196
|
-
if attributes.key?(:
|
197
|
-
self.reason = attributes[:
|
194
|
+
if attributes.key?(:reason)
|
195
|
+
self.reason = attributes[:reason]
|
198
196
|
end
|
199
197
|
|
200
|
-
if attributes.key?(:
|
201
|
-
self.parent_call_id = attributes[:
|
198
|
+
if attributes.key?(:parent_call_id)
|
199
|
+
self.parent_call_id = attributes[:parent_call_id]
|
202
200
|
end
|
203
201
|
end
|
204
202
|
|
205
203
|
# Show invalid properties with the reasons. Usually used together with valid?
|
206
204
|
# @return Array for valid properties with the reasons
|
207
205
|
def list_invalid_properties
|
208
|
-
|
209
|
-
invalid_properties
|
206
|
+
super
|
210
207
|
end
|
211
208
|
|
212
209
|
# Check to see if the all the properties in the model are valid
|
213
210
|
# @return true if the model is valid
|
214
211
|
def valid?
|
215
|
-
|
216
212
|
if @request_type.nil?
|
217
213
|
false
|
218
214
|
else
|
219
|
-
list_invalid_properties.length
|
215
|
+
list_invalid_properties.length == 0
|
220
216
|
end
|
221
217
|
end
|
222
218
|
|
223
219
|
# Checks equality by comparing each attribute.
|
224
220
|
# @param [Object] Object to be compared
|
225
|
-
def ==(
|
226
|
-
return true if
|
227
|
-
self.class ==
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
221
|
+
def ==(other)
|
222
|
+
return true if equal?(other)
|
223
|
+
self.class == other.class &&
|
224
|
+
request_type == other.request_type &&
|
225
|
+
call_id == other.call_id &&
|
226
|
+
account_id == other.account_id &&
|
227
|
+
from == other.from &&
|
228
|
+
to == other.to &&
|
229
|
+
call_status == other.call_status &&
|
230
|
+
direction == other.direction &&
|
231
|
+
conference_id == other.conference_id &&
|
232
|
+
queue_id == other.queue_id &&
|
233
|
+
digits == other.digits &&
|
234
|
+
reason == other.reason &&
|
235
|
+
parent_call_id == other.parent_call_id && super
|
240
236
|
end
|
241
237
|
|
242
238
|
# @see the `==` method
|
243
239
|
# @param [Object] Object to be compared
|
244
|
-
def eql?(
|
245
|
-
self ==
|
240
|
+
def eql?(other)
|
241
|
+
self == other
|
246
242
|
end
|
247
243
|
|
248
244
|
# Calculates hash code according to all attributes.
|
@@ -263,18 +259,18 @@ module Freeclimb
|
|
263
259
|
# @return [Object] Returns the model itself
|
264
260
|
def build_from_hash(attributes)
|
265
261
|
return nil unless attributes.is_a?(Hash)
|
266
|
-
super
|
262
|
+
super
|
267
263
|
self.class.openapi_types.each_pair do |key, type|
|
268
264
|
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
269
|
-
|
265
|
+
send(:"#{key}=", nil)
|
270
266
|
elsif type =~ /\AArray<(.*)>/i
|
271
267
|
# check to ensure the input is an array given that the attribute
|
272
268
|
# is documented as an array but the input is not
|
273
269
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
274
|
-
|
270
|
+
send(:"#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
275
271
|
end
|
276
272
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
277
|
-
|
273
|
+
send(:"#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
278
274
|
end
|
279
275
|
end
|
280
276
|
|
@@ -341,7 +337,7 @@ module Freeclimb
|
|
341
337
|
def to_hash
|
342
338
|
hash = super
|
343
339
|
self.class.attribute_map.each_pair do |attr, param|
|
344
|
-
value =
|
340
|
+
value = send(attr)
|
345
341
|
if value.nil?
|
346
342
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
347
343
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
@@ -1,17 +1,15 @@
|
|
1
|
-
|
2
|
-
#
|
3
|
-
|
4
|
-
#
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
require 'date'
|
14
|
-
require 'time'
|
1
|
+
# #FreeClimb API
|
2
|
+
#
|
3
|
+
# FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
|
4
|
+
#
|
5
|
+
# The version of the OpenAPI document: 1.0.0
|
6
|
+
# Contact: support@freeclimb.com
|
7
|
+
# Generated by: https://openapi-generator.tech
|
8
|
+
# OpenAPI Generator version: 7.9.0
|
9
|
+
#
|
10
|
+
|
11
|
+
require "date"
|
12
|
+
require "time"
|
15
13
|
|
16
14
|
module Freeclimb
|
17
15
|
# The `GetSpeech` command enables the Caller to respond to the application using a supported language. Unlike DTMF entry, which implicitly restricts the user to using the available buttons on the phone key pad, speech input allows for flexible audio inputs based on grammar. FreeClimb supports grammars written using GRXML compatible with the Microsoft Speech Platform. `GetSpeech` is only supported on a single call leg. It is not supported when there are two or more call legs connected (as in within a Conference).
|
@@ -42,7 +40,7 @@ module Freeclimb
|
|
42
40
|
# When a recognition resource recognizes a spoken phrase, it associates a confidence level with that match. Parameter `confidenceThreshold` specifies what confidence level is considered a successful match. Values are between 0.0 and 1.0.
|
43
41
|
attr_accessor :confidence_threshold
|
44
42
|
|
45
|
-
# The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0
|
43
|
+
# The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0
|
46
44
|
attr_accessor :sensitivity_level
|
47
45
|
|
48
46
|
# Parameter `speechCompleteTimeoutMs` specifies the length of silence required following user speech before the speech recognizer finalizes a result. This timeout applies when the recognizer currently has a complete match against an active grammar. Reasonable speech complete timeout values are typically in the range of 0.3 seconds to 1.0 seconds.
|
@@ -79,19 +77,19 @@ module Freeclimb
|
|
79
77
|
# Attribute mapping from ruby-style variable name to JSON key.
|
80
78
|
def self.attribute_map
|
81
79
|
{
|
82
|
-
:
|
83
|
-
:
|
84
|
-
:
|
85
|
-
:
|
86
|
-
:
|
87
|
-
:
|
88
|
-
:
|
89
|
-
:
|
90
|
-
:
|
91
|
-
:
|
92
|
-
:
|
93
|
-
:
|
94
|
-
:
|
80
|
+
action_url: :actionUrl,
|
81
|
+
grammar_type: :grammarType,
|
82
|
+
grammar_file: :grammarFile,
|
83
|
+
grammar_rule: :grammarRule,
|
84
|
+
play_beep: :playBeep,
|
85
|
+
prompts: :prompts,
|
86
|
+
no_input_timeout_ms: :noInputTimeoutMs,
|
87
|
+
recognition_timeout_ms: :recognitionTimeoutMs,
|
88
|
+
confidence_threshold: :confidenceThreshold,
|
89
|
+
sensitivity_level: :sensitivityLevel,
|
90
|
+
speech_complete_timeout_ms: :speechCompleteTimeoutMs,
|
91
|
+
speech_incomplete_timeout_ms: :speechIncompleteTimeoutMs,
|
92
|
+
privacy_mode: :privacyMode
|
95
93
|
}
|
96
94
|
end
|
97
95
|
|
@@ -103,106 +101,106 @@ module Freeclimb
|
|
103
101
|
# Attribute type mapping.
|
104
102
|
def self.openapi_types
|
105
103
|
{
|
106
|
-
:
|
107
|
-
:
|
108
|
-
:
|
109
|
-
:
|
110
|
-
:
|
111
|
-
:
|
112
|
-
:
|
113
|
-
:
|
114
|
-
:
|
115
|
-
:
|
116
|
-
:
|
117
|
-
:
|
118
|
-
:
|
104
|
+
action_url: :String,
|
105
|
+
grammar_type: :GrammarType,
|
106
|
+
grammar_file: :String,
|
107
|
+
grammar_rule: :String,
|
108
|
+
play_beep: :Boolean,
|
109
|
+
prompts: :"Array<PerclCommand>",
|
110
|
+
no_input_timeout_ms: :Integer,
|
111
|
+
recognition_timeout_ms: :Integer,
|
112
|
+
confidence_threshold: :Float,
|
113
|
+
sensitivity_level: :Float,
|
114
|
+
speech_complete_timeout_ms: :Integer,
|
115
|
+
speech_incomplete_timeout_ms: :Integer,
|
116
|
+
privacy_mode: :Boolean
|
119
117
|
}
|
120
118
|
end
|
121
119
|
|
122
120
|
# List of attributes with nullable: true
|
123
121
|
def self.openapi_nullable
|
124
122
|
Set.new([
|
125
|
-
:
|
123
|
+
:grammar_type
|
126
124
|
])
|
127
125
|
end
|
128
126
|
|
129
127
|
# List of class defined in allOf (OpenAPI v3)
|
130
128
|
def self.openapi_all_of
|
131
129
|
[
|
132
|
-
|
130
|
+
:PerclCommand
|
133
131
|
]
|
134
132
|
end
|
135
133
|
|
136
134
|
# Initializes the object
|
137
135
|
# @param [Hash] attributes Model attributes in the form of hash
|
138
136
|
def initialize(attributes = {})
|
139
|
-
if
|
137
|
+
if !attributes.is_a?(Hash)
|
140
138
|
fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::GetSpeech` initialize method"
|
141
139
|
end
|
142
140
|
|
143
141
|
# check to see if the attribute exists and convert string to symbol for hash key
|
144
142
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
145
|
-
if
|
143
|
+
if !self.class.attribute_map.key?(k.to_sym)
|
146
144
|
fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::GetSpeech`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
147
145
|
end
|
148
146
|
h[k.to_sym] = v
|
149
147
|
}
|
150
148
|
|
151
149
|
# call parent's initialize
|
152
|
-
super
|
150
|
+
super
|
153
151
|
|
154
|
-
if attributes.key?(:
|
155
|
-
self.action_url = attributes[:
|
152
|
+
if attributes.key?(:action_url)
|
153
|
+
self.action_url = attributes[:action_url]
|
156
154
|
end
|
157
155
|
|
158
|
-
if attributes.key?(:
|
159
|
-
self.grammar_type = attributes[:
|
156
|
+
if attributes.key?(:grammar_type)
|
157
|
+
self.grammar_type = attributes[:grammar_type]
|
160
158
|
end
|
161
159
|
|
162
|
-
if attributes.key?(:
|
163
|
-
self.grammar_file = attributes[:
|
160
|
+
if attributes.key?(:grammar_file)
|
161
|
+
self.grammar_file = attributes[:grammar_file]
|
164
162
|
end
|
165
163
|
|
166
|
-
if attributes.key?(:
|
167
|
-
self.grammar_rule = attributes[:
|
164
|
+
if attributes.key?(:grammar_rule)
|
165
|
+
self.grammar_rule = attributes[:grammar_rule]
|
168
166
|
end
|
169
167
|
|
170
|
-
if attributes.key?(:
|
171
|
-
self.play_beep = attributes[:
|
168
|
+
if attributes.key?(:play_beep)
|
169
|
+
self.play_beep = attributes[:play_beep]
|
172
170
|
end
|
173
171
|
|
174
|
-
if attributes.key?(:
|
175
|
-
if (value = attributes[:
|
172
|
+
if attributes.key?(:prompts)
|
173
|
+
if (value = attributes[:prompts]).is_a?(Array)
|
176
174
|
self.prompts = value
|
177
175
|
end
|
178
176
|
end
|
179
177
|
|
180
|
-
if attributes.key?(:
|
181
|
-
self.no_input_timeout_ms = attributes[:
|
178
|
+
if attributes.key?(:no_input_timeout_ms)
|
179
|
+
self.no_input_timeout_ms = attributes[:no_input_timeout_ms]
|
182
180
|
end
|
183
181
|
|
184
|
-
if attributes.key?(:
|
185
|
-
self.recognition_timeout_ms = attributes[:
|
182
|
+
if attributes.key?(:recognition_timeout_ms)
|
183
|
+
self.recognition_timeout_ms = attributes[:recognition_timeout_ms]
|
186
184
|
end
|
187
185
|
|
188
|
-
if attributes.key?(:
|
189
|
-
self.confidence_threshold = attributes[:
|
186
|
+
if attributes.key?(:confidence_threshold)
|
187
|
+
self.confidence_threshold = attributes[:confidence_threshold]
|
190
188
|
end
|
191
189
|
|
192
|
-
if attributes.key?(:
|
193
|
-
self.sensitivity_level = attributes[:
|
190
|
+
if attributes.key?(:sensitivity_level)
|
191
|
+
self.sensitivity_level = attributes[:sensitivity_level]
|
194
192
|
end
|
195
193
|
|
196
|
-
if attributes.key?(:
|
197
|
-
self.speech_complete_timeout_ms = attributes[:
|
194
|
+
if attributes.key?(:speech_complete_timeout_ms)
|
195
|
+
self.speech_complete_timeout_ms = attributes[:speech_complete_timeout_ms]
|
198
196
|
end
|
199
197
|
|
200
|
-
if attributes.key?(:
|
201
|
-
self.speech_incomplete_timeout_ms = attributes[:
|
198
|
+
if attributes.key?(:speech_incomplete_timeout_ms)
|
199
|
+
self.speech_incomplete_timeout_ms = attributes[:speech_incomplete_timeout_ms]
|
202
200
|
end
|
203
201
|
|
204
|
-
if attributes.key?(:
|
205
|
-
self.privacy_mode = attributes[:
|
202
|
+
if attributes.key?(:privacy_mode)
|
203
|
+
self.privacy_mode = attributes[:privacy_mode]
|
206
204
|
end
|
207
205
|
self.command = "GetSpeech"
|
208
206
|
end
|
@@ -225,38 +223,37 @@ module Freeclimb
|
|
225
223
|
# Check to see if the all the properties in the model are valid
|
226
224
|
# @return true if the model is valid
|
227
225
|
def valid?
|
228
|
-
|
229
226
|
if @action_url.nil?
|
230
227
|
false
|
231
228
|
else
|
232
|
-
list_invalid_properties.length
|
229
|
+
list_invalid_properties.length == 0
|
233
230
|
end
|
234
231
|
end
|
235
232
|
|
236
233
|
# Checks equality by comparing each attribute.
|
237
234
|
# @param [Object] Object to be compared
|
238
|
-
def ==(
|
239
|
-
return true if
|
240
|
-
self.class ==
|
241
|
-
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
235
|
+
def ==(other)
|
236
|
+
return true if equal?(other)
|
237
|
+
self.class == other.class &&
|
238
|
+
action_url == other.action_url &&
|
239
|
+
grammar_type == other.grammar_type &&
|
240
|
+
grammar_file == other.grammar_file &&
|
241
|
+
grammar_rule == other.grammar_rule &&
|
242
|
+
play_beep == other.play_beep &&
|
243
|
+
prompts == other.prompts &&
|
244
|
+
no_input_timeout_ms == other.no_input_timeout_ms &&
|
245
|
+
recognition_timeout_ms == other.recognition_timeout_ms &&
|
246
|
+
confidence_threshold == other.confidence_threshold &&
|
247
|
+
sensitivity_level == other.sensitivity_level &&
|
248
|
+
speech_complete_timeout_ms == other.speech_complete_timeout_ms &&
|
249
|
+
speech_incomplete_timeout_ms == other.speech_incomplete_timeout_ms &&
|
250
|
+
privacy_mode == other.privacy_mode && super
|
254
251
|
end
|
255
252
|
|
256
253
|
# @see the `==` method
|
257
254
|
# @param [Object] Object to be compared
|
258
|
-
def eql?(
|
259
|
-
self ==
|
255
|
+
def eql?(other)
|
256
|
+
self == other
|
260
257
|
end
|
261
258
|
|
262
259
|
# Calculates hash code according to all attributes.
|
@@ -277,18 +274,18 @@ module Freeclimb
|
|
277
274
|
# @return [Object] Returns the model itself
|
278
275
|
def build_from_hash(attributes)
|
279
276
|
return nil unless attributes.is_a?(Hash)
|
280
|
-
super
|
277
|
+
super
|
281
278
|
self.class.openapi_types.each_pair do |key, type|
|
282
279
|
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
283
|
-
|
280
|
+
send(:"#{key}=", nil)
|
284
281
|
elsif type =~ /\AArray<(.*)>/i
|
285
282
|
# check to ensure the input is an array given that the attribute
|
286
283
|
# is documented as an array but the input is not
|
287
284
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
288
|
-
|
285
|
+
send(:"#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
289
286
|
end
|
290
287
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
291
|
-
|
288
|
+
send(:"#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
292
289
|
end
|
293
290
|
end
|
294
291
|
|
@@ -355,7 +352,7 @@ module Freeclimb
|
|
355
352
|
def to_hash
|
356
353
|
hash = super
|
357
354
|
self.class.attribute_map.each_pair do |attr, param|
|
358
|
-
value =
|
355
|
+
value = send(attr)
|
359
356
|
if value.nil?
|
360
357
|
is_nullable = self.class.openapi_nullable.include?(attr)
|
361
358
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|