freeclimb 4.0.4 → 4.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +99 -9
- data/Gemfile.lock +1 -1
- data/README.md +25 -4
- data/docs/AccountResult.md +2 -2
- data/docs/AccountResultAllOf.md +2 -2
- data/docs/AccountStatus.md +18 -0
- data/docs/AccountType.md +17 -0
- data/docs/AnsweredBy.md +17 -0
- data/docs/CallDirection.md +18 -0
- data/docs/CallResult.md +3 -3
- data/docs/CallResultAllOf.md +3 -3
- data/docs/CallStatus.md +23 -0
- data/docs/ConferenceResult.md +2 -2
- data/docs/ConferenceResultAllOf.md +2 -2
- data/docs/ConferenceStatus.md +19 -0
- data/docs/CreateConference.md +2 -2
- data/docs/CreateConferenceAllOf.md +2 -2
- data/docs/CreateConferenceRequest.md +1 -1
- data/docs/DefaultApi.md +5 -5
- data/docs/Dequeue.md +1 -1
- data/docs/GetSpeech.md +3 -3
- data/docs/GetSpeechAllOf.md +3 -3
- data/docs/GetSpeechReason.md +21 -0
- data/docs/GrammarFileBuiltIn.md +30 -0
- data/docs/GrammarType.md +17 -0
- data/docs/IfMachine.md +17 -0
- data/docs/Language.md +41 -0
- data/docs/LogLevel.md +18 -0
- data/docs/LogResult.md +1 -1
- data/docs/MachineType.md +17 -0
- data/docs/MessageDirection.md +17 -0
- data/docs/MessageResult.md +1 -1
- data/docs/MessageResultAllOf.md +1 -1
- data/docs/MessageStatus.md +26 -0
- data/docs/OutDial.md +1 -1
- data/docs/OutDialAllOf.md +1 -1
- data/docs/PlayBeep.md +19 -0
- data/docs/QueueResultStatus.md +19 -0
- data/docs/RecordUtteranceTermReason.md +19 -0
- data/docs/RequestType.md +38 -0
- data/docs/StartRecordCall.md +1 -1
- data/docs/Unpark.md +1 -1
- data/docs/UpdateCallRequest.md +1 -1
- data/docs/UpdateCallRequestStatus.md +17 -0
- data/docs/UpdateConferenceRequest.md +2 -2
- data/docs/UpdateConferenceRequestStatus.md +17 -0
- data/lib/freeclimb/api/default_api.rb +4 -8
- data/lib/freeclimb/models/account_result.rb +2 -52
- data/lib/freeclimb/models/account_result_all_of.rb +2 -52
- data/lib/freeclimb/models/account_status.rb +38 -0
- data/lib/freeclimb/models/account_type.rb +37 -0
- data/lib/freeclimb/models/answered_by.rb +37 -0
- data/lib/freeclimb/models/application_request.rb +6 -0
- data/lib/freeclimb/models/call_direction.rb +38 -0
- data/lib/freeclimb/models/call_result.rb +3 -43
- data/lib/freeclimb/models/call_result_all_of.rb +3 -43
- data/lib/freeclimb/models/call_status.rb +43 -0
- data/lib/freeclimb/models/conference_result.rb +4 -52
- data/lib/freeclimb/models/conference_result_all_of.rb +4 -52
- data/lib/freeclimb/models/conference_status.rb +39 -0
- data/lib/freeclimb/models/create_conference.rb +4 -3
- data/lib/freeclimb/models/create_conference_all_of.rb +4 -3
- data/lib/freeclimb/models/create_conference_request.rb +1 -36
- data/lib/freeclimb/models/get_speech.rb +3 -4
- data/lib/freeclimb/models/get_speech_all_of.rb +3 -4
- data/lib/freeclimb/models/get_speech_reason.rb +41 -0
- data/lib/freeclimb/models/grammar_file_built_in.rb +50 -0
- data/lib/freeclimb/models/grammar_type.rb +37 -0
- data/lib/freeclimb/models/if_machine.rb +37 -0
- data/lib/freeclimb/models/language.rb +61 -0
- data/lib/freeclimb/models/log_level.rb +38 -0
- data/lib/freeclimb/models/log_result.rb +1 -37
- data/lib/freeclimb/models/machine_type.rb +37 -0
- data/lib/freeclimb/models/message_direction.rb +37 -0
- data/lib/freeclimb/models/message_result.rb +1 -37
- data/lib/freeclimb/models/message_result_all_of.rb +1 -37
- data/lib/freeclimb/models/message_status.rb +46 -0
- data/lib/freeclimb/models/out_dial.rb +1 -2
- data/lib/freeclimb/models/out_dial_all_of.rb +1 -2
- data/lib/freeclimb/models/play_beep.rb +39 -0
- data/lib/freeclimb/models/queue_result_status.rb +39 -0
- data/lib/freeclimb/models/record_utterance_term_reason.rb +39 -0
- data/lib/freeclimb/models/request_type.rb +58 -0
- data/lib/freeclimb/models/update_call_request.rb +1 -36
- data/lib/freeclimb/models/update_call_request_status.rb +37 -0
- data/lib/freeclimb/models/update_conference_request.rb +2 -50
- data/lib/freeclimb/models/update_conference_request_status.rb +37 -0
- data/lib/freeclimb/version.rb +1 -1
- data/lib/freeclimb.rb +21 -0
- data/openapi.json +4226 -0
- data/spec/api/default_api_spec.rb +532 -700
- data/spec/configuration_spec.rb +2 -1
- data/spec/models/account_result_spec.rb +0 -8
- data/spec/models/account_status_spec.rb +43 -0
- data/spec/models/account_type_spec.rb +38 -0
- data/spec/models/answered_by_spec.rb +38 -0
- data/spec/models/available_number_spec.rb +6 -0
- data/spec/models/call_direction_spec.rb +43 -0
- data/spec/models/call_result_spec.rb +0 -4
- data/spec/models/call_status_spec.rb +68 -0
- data/spec/models/conference_result_spec.rb +0 -8
- data/spec/models/conference_status_spec.rb +48 -0
- data/spec/models/create_conference_request_spec.rb +0 -4
- data/spec/models/get_speech_reason_spec.rb +58 -0
- data/spec/models/grammar_file_built_in_spec.rb +103 -0
- data/spec/models/grammar_type_spec.rb +38 -0
- data/spec/models/if_machine_spec.rb +38 -0
- data/spec/models/incoming_number_result_spec.rb +12 -0
- data/spec/models/language_spec.rb +158 -0
- data/spec/models/log_level_spec.rb +43 -0
- data/spec/models/log_result_spec.rb +0 -4
- data/spec/models/machine_type_spec.rb +38 -0
- data/spec/models/message_direction_spec.rb +38 -0
- data/spec/models/message_result_spec.rb +0 -4
- data/spec/models/message_status_spec.rb +83 -0
- data/spec/models/play_beep_spec.rb +48 -0
- data/spec/models/queue_result_spec.rb +1 -1
- data/spec/models/queue_result_status_spec.rb +48 -0
- data/spec/models/record_utterance_term_reason_spec.rb +48 -0
- data/spec/models/request_type_spec.rb +143 -0
- data/spec/models/update_call_request_spec.rb +0 -4
- data/spec/models/update_call_request_status_spec.rb +38 -0
- data/spec/models/update_conference_request_spec.rb +0 -4
- data/spec/models/update_conference_request_status_spec.rb +38 -0
- metadata +138 -53
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **_alias** | **String** | A description for this Conference. Maximum 64 characters. | [optional] |
|
8
|
-
| **play_beep** | **
|
8
|
+
| **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional][default to 'always'] |
|
9
9
|
| **record** | **Boolean** | Setting to `true` records the entire Conference. | [optional] |
|
10
10
|
| **wait_url** | **String** | If specified, a URL for the audio file that provides custom hold music for the Conference when it is in the populated state. Otherwise, FreeClimb uses a system default audio file. This is always fetched using HTTP GET and is fetched just once — when the Conference is created. | [optional] |
|
11
11
|
| **status_callback_url** | **String** | This URL is invoked when the status of the Conference changes. For more information, see **statusCallbackUrl** (below). | [optional] |
|
data/docs/DefaultApi.md
CHANGED
@@ -2101,7 +2101,7 @@ opts = {
|
|
2101
2101
|
active: true, # Boolean | If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query.
|
2102
2102
|
to: 'to_example', # String | Only show Calls to this phone number.
|
2103
2103
|
from: 'from_example', # String | Only show Calls from this phone number.
|
2104
|
-
status:
|
2104
|
+
status: Freeclimb::CallStatus::QUEUED, # CallStatus | Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`.
|
2105
2105
|
start_time: 'start_time_example', # String | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss.
|
2106
2106
|
end_time: 'end_time_example', # String | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.
|
2107
2107
|
parent_call_id: 'parent_call_id_example' # String | Only show Calls spawned by the call with this ID.
|
@@ -2146,7 +2146,7 @@ end
|
|
2146
2146
|
|
2147
2147
|
| **from** | **String** | Only show Calls from this phone number. | [optional] |
|
2148
2148
|
|
2149
|
-
| **status** | **
|
2149
|
+
| **status** | [**CallStatus**](.md) | Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`. | [optional] |
|
2150
2150
|
|
2151
2151
|
| **start_time** | **String** | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] |
|
2152
2152
|
|
@@ -2612,7 +2612,7 @@ opts = {
|
|
2612
2612
|
from: 'from_example', # String | Only show Messages from this phone number.
|
2613
2613
|
begin_time: 'begin_time_example', # String | Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*.
|
2614
2614
|
end_time: 'end_time_example', # String | Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*..
|
2615
|
-
direction:
|
2615
|
+
direction: Freeclimb::MessageDirection::INBOUND # MessageDirection | Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb.
|
2616
2616
|
}
|
2617
2617
|
|
2618
2618
|
begin
|
@@ -2656,7 +2656,7 @@ end
|
|
2656
2656
|
|
2657
2657
|
| **end_time** | **String** | Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*.. | [optional] |
|
2658
2658
|
|
2659
|
-
| **direction** | **
|
2659
|
+
| **direction** | [**MessageDirection**](.md) | Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb. | [optional] |
|
2660
2660
|
|
2661
2661
|
|
2662
2662
|
### Return type
|
@@ -3057,7 +3057,7 @@ api_instance = Freeclimb::DefaultApi.new
|
|
3057
3057
|
|
3058
3058
|
call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
|
3059
3059
|
|
3060
|
-
update_call_request = Freeclimb::UpdateCallRequest.new({status:
|
3060
|
+
update_call_request = Freeclimb::UpdateCallRequest.new({status: Freeclimb::UpdateCallRequestStatus::CANCELED}) # UpdateCallRequest | Call details to update
|
3061
3061
|
|
3062
3062
|
|
3063
3063
|
begin
|
data/docs/Dequeue.md
CHANGED
data/docs/GetSpeech.md
CHANGED
@@ -5,10 +5,10 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **action_url** | **String** | When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call. | |
|
8
|
-
| **grammar_type** | **
|
8
|
+
| **grammar_type** | [**GrammarType**](GrammarType.md) | | [optional] |
|
9
9
|
| **grammar_file** | **String** | The grammar file to use for speech recognition. If grammarType is set to URL, this attribute is specified as a download URL. | |
|
10
|
-
| **grammar_rule** | **
|
11
|
-
| **play_beep** | **
|
10
|
+
| **grammar_rule** | **String** | The grammar rule within the specified grammar file to use for speech recognition. This attribute is optional if `grammarType` is `URL` and ignored if `grammarType` is `BUILTIN`. | [optional] |
|
11
|
+
| **play_beep** | **Boolean** | Indicates whether a beep should be played just before speech recognition is initiated so that the speaker can start to speak. | [optional] |
|
12
12
|
| **prompts** | [**Array<PerclCommand>**](PerclCommand.md) | The JSON array of PerCL commands to nest within the `GetSpeech` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the caller. This allows for playing menu options to the caller and to prompt for the expected input. These commands stop executing when the caller begins to input speech. | [optional] |
|
13
13
|
| **no_input_timeout_ms** | **Integer** | When recognition is started and there is no speech detected for `noInputTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. | [optional] |
|
14
14
|
| **recognition_timeout_ms** | **Integer** | When playback of prompts ends and there is no match for `recognitionTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. | [optional] |
|
data/docs/GetSpeechAllOf.md
CHANGED
@@ -5,10 +5,10 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **action_url** | **String** | When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call. | |
|
8
|
-
| **grammar_type** | **
|
8
|
+
| **grammar_type** | [**GrammarType**](GrammarType.md) | | [optional] |
|
9
9
|
| **grammar_file** | **String** | The grammar file to use for speech recognition. If grammarType is set to URL, this attribute is specified as a download URL. | |
|
10
|
-
| **grammar_rule** | **
|
11
|
-
| **play_beep** | **
|
10
|
+
| **grammar_rule** | **String** | The grammar rule within the specified grammar file to use for speech recognition. This attribute is optional if `grammarType` is `URL` and ignored if `grammarType` is `BUILTIN`. | [optional] |
|
11
|
+
| **play_beep** | **Boolean** | Indicates whether a beep should be played just before speech recognition is initiated so that the speaker can start to speak. | [optional] |
|
12
12
|
| **prompts** | [**Array<PerclCommand>**](PerclCommand.md) | The JSON array of PerCL commands to nest within the `GetSpeech` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the caller. This allows for playing menu options to the caller and to prompt for the expected input. These commands stop executing when the caller begins to input speech. | [optional] |
|
13
13
|
| **no_input_timeout_ms** | **Integer** | When recognition is started and there is no speech detected for `noInputTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. | [optional] |
|
14
14
|
| **recognition_timeout_ms** | **Integer** | When playback of prompts ends and there is no match for `recognitionTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. | [optional] |
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# Freeclimb::GetSpeechReason
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ERROR** | **GetSpeechReason** | | Represented in Ruby as "error" |
|
8
|
+
| **HANGUP** | **GetSpeechReason** | | Represented in Ruby as "hangup" |
|
9
|
+
| **DIGIT** | **GetSpeechReason** | | Represented in Ruby as "digit" |
|
10
|
+
| **NO_INPUT** | **GetSpeechReason** | | Represented in Ruby as "noInput" |
|
11
|
+
| **NO_MATCH** | **GetSpeechReason** | | Represented in Ruby as "noMatch" |
|
12
|
+
| **RECOGNITION** | **GetSpeechReason** | | Represented in Ruby as "recognition" |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'freeclimb'
|
18
|
+
|
19
|
+
instance = Freeclimb::GetSpeechReason::[NAME OF ENUM]
|
20
|
+
```
|
21
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# Freeclimb::GrammarFileBuiltIn
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ALPHNUM6** | **GrammarFileBuiltIn** | | Represented in Ruby as "ALPHNUM6" |
|
8
|
+
| **ANY_DIG** | **GrammarFileBuiltIn** | | Represented in Ruby as "ANY_DIG" |
|
9
|
+
| **DIG1** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG1" |
|
10
|
+
| **DIG2** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG2" |
|
11
|
+
| **DIG3** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG3" |
|
12
|
+
| **DIG4** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG4" |
|
13
|
+
| **DIG5** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG5" |
|
14
|
+
| **DIG6** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG6" |
|
15
|
+
| **DIG7** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG7" |
|
16
|
+
| **DIG8** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG8" |
|
17
|
+
| **DIG9** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG9" |
|
18
|
+
| **DIG10** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG10" |
|
19
|
+
| **DIG11** | **GrammarFileBuiltIn** | | Represented in Ruby as "DIG11" |
|
20
|
+
| **UP_TO_20_DIGIT_SEQUENCE** | **GrammarFileBuiltIn** | | Represented in Ruby as "UP_TO_20_DIGIT_SEQUENCE" |
|
21
|
+
| **VERSAY_YESNO** | **GrammarFileBuiltIn** | | Represented in Ruby as "VERSAY_YESNO" |
|
22
|
+
|
23
|
+
## Example
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'freeclimb'
|
27
|
+
|
28
|
+
instance = Freeclimb::GrammarFileBuiltIn::[NAME OF ENUM]
|
29
|
+
```
|
30
|
+
|
data/docs/GrammarType.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Freeclimb::GrammarType
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **URL** | **GrammarType** | | Represented in Ruby as "URL" |
|
8
|
+
| **BUILT_IN** | **GrammarType** | | Represented in Ruby as "BUILTIN" |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'freeclimb'
|
14
|
+
|
15
|
+
instance = Freeclimb::GrammarType::[NAME OF ENUM]
|
16
|
+
```
|
17
|
+
|
data/docs/IfMachine.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Freeclimb::IfMachine
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **REDIRECT** | **IfMachine** | | Represented in Ruby as "redirect" |
|
8
|
+
| **HANGUP** | **IfMachine** | | Represented in Ruby as "hangup" |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'freeclimb'
|
14
|
+
|
15
|
+
instance = Freeclimb::IfMachine::[NAME OF ENUM]
|
16
|
+
```
|
17
|
+
|
data/docs/Language.md
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
# Freeclimb::Language
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **CATALAN** | **Language** | | Represented in Ruby as "ca-ES" |
|
8
|
+
| **DANISH** | **Language** | | Represented in Ruby as "da-DK" |
|
9
|
+
| **GERMAN** | **Language** | | Represented in Ruby as "de-DE" |
|
10
|
+
| **ENGLISH_AU** | **Language** | | Represented in Ruby as "en-AU" |
|
11
|
+
| **ENGLISH_CA** | **Language** | | Represented in Ruby as "en-CA" |
|
12
|
+
| **ENGLISH_UK** | **Language** | | Represented in Ruby as "en-GB" |
|
13
|
+
| **ENGLISH_IN** | **Language** | | Represented in Ruby as "en-IN" |
|
14
|
+
| **ENGLISH_US** | **Language** | | Represented in Ruby as "en-US" |
|
15
|
+
| **ENGLISH_ES** | **Language** | | Represented in Ruby as "es-ES" |
|
16
|
+
| **ENGLISH_MX** | **Language** | | Represented in Ruby as "es-MX" |
|
17
|
+
| **FINNISH** | **Language** | | Represented in Ruby as "fi-FI" |
|
18
|
+
| **FRENCH_CA** | **Language** | | Represented in Ruby as "fr-CA" |
|
19
|
+
| **FRENCH_FR** | **Language** | | Represented in Ruby as "fr-FR" |
|
20
|
+
| **ITALIAN** | **Language** | | Represented in Ruby as "it-IT" |
|
21
|
+
| **JAPANESE** | **Language** | | Represented in Ruby as "ja-JP" |
|
22
|
+
| **KOREAN** | **Language** | | Represented in Ruby as "ko-KR" |
|
23
|
+
| **NORWEGIAN** | **Language** | | Represented in Ruby as "nb-NO" |
|
24
|
+
| **DUTCH** | **Language** | | Represented in Ruby as "nl-NL" |
|
25
|
+
| **POLISH** | **Language** | | Represented in Ruby as "pl-PL" |
|
26
|
+
| **PORTUGESE_BR** | **Language** | | Represented in Ruby as "pt-BR" |
|
27
|
+
| **PORTUGESE_PT** | **Language** | | Represented in Ruby as "pt-PT" |
|
28
|
+
| **RUSSIAN** | **Language** | | Represented in Ruby as "ru-RU" |
|
29
|
+
| **SWEDISH** | **Language** | | Represented in Ruby as "sv-SE" |
|
30
|
+
| **CHINESE_CN** | **Language** | | Represented in Ruby as "zh-CN" |
|
31
|
+
| **CHINESE_HK** | **Language** | | Represented in Ruby as "zh-HK" |
|
32
|
+
| **CHINESE_TW** | **Language** | | Represented in Ruby as "zh-TW" |
|
33
|
+
|
34
|
+
## Example
|
35
|
+
|
36
|
+
```ruby
|
37
|
+
require 'freeclimb'
|
38
|
+
|
39
|
+
instance = Freeclimb::Language::[NAME OF ENUM]
|
40
|
+
```
|
41
|
+
|
data/docs/LogLevel.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# Freeclimb::LogLevel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **INFO** | **LogLevel** | | Represented in Ruby as "info" |
|
8
|
+
| **WARNING** | **LogLevel** | | Represented in Ruby as "warning" |
|
9
|
+
| **ERROR** | **LogLevel** | | Represented in Ruby as "error" |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'freeclimb'
|
15
|
+
|
16
|
+
instance = Freeclimb::LogLevel::[NAME OF ENUM]
|
17
|
+
```
|
18
|
+
|
data/docs/LogResult.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **timestamp** | **Integer** | Time that the log was generated. The time is represented as microseconds since the Unix Epoch. | [optional] |
|
8
|
-
| **level** | **
|
8
|
+
| **level** | [**LogLevel**](LogLevel.md) | | [optional] |
|
9
9
|
| **request_id** | **String** | ID of the request associated with the log. The requestId is propagated across all logs generated by FreeClimb when processing a request. | [optional] |
|
10
10
|
| **account_id** | **String** | ID of the account that this log was generated under. | [optional] |
|
11
11
|
| **call_id** | **String** | ID of the Call associated with the log. Can be set to null if the log was generated without regard to a specific Call. | [optional] |
|
data/docs/MachineType.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Freeclimb::MachineType
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ANSWERING_MACHINE** | **MachineType** | | Represented in Ruby as "answeringMachine" |
|
8
|
+
| **FAX_MACHINE** | **MachineType** | | Represented in Ruby as "faxMachine" |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'freeclimb'
|
14
|
+
|
15
|
+
instance = Freeclimb::MachineType::[NAME OF ENUM]
|
16
|
+
```
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Freeclimb::MessageDirection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **INBOUND** | **MessageDirection** | | Represented in Ruby as "inbound" |
|
8
|
+
| **OUTBOUND** | **MessageDirection** | | Represented in Ruby as "outbound" |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'freeclimb'
|
14
|
+
|
15
|
+
instance = Freeclimb::MessageDirection::[NAME OF ENUM]
|
16
|
+
```
|
17
|
+
|
data/docs/MessageResult.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
| **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] |
|
11
11
|
| **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
|
12
12
|
| **message_id** | **String** | String that uniquely identifies this message resource | [optional] |
|
13
|
-
| **status** | **
|
13
|
+
| **status** | [**MessageStatus**](MessageStatus.md) | | [optional] |
|
14
14
|
| **from** | **String** | Phone number in E.164 format that sent the message. | [optional] |
|
15
15
|
| **to** | **String** | Phone number in E.164 format that received the message. | [optional] |
|
16
16
|
| **text** | **String** | Message contents | [optional] |
|
data/docs/MessageResultAllOf.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
|
8
8
|
| **message_id** | **String** | String that uniquely identifies this message resource | [optional] |
|
9
|
-
| **status** | **
|
9
|
+
| **status** | [**MessageStatus**](MessageStatus.md) | | [optional] |
|
10
10
|
| **from** | **String** | Phone number in E.164 format that sent the message. | [optional] |
|
11
11
|
| **to** | **String** | Phone number in E.164 format that received the message. | [optional] |
|
12
12
|
| **text** | **String** | Message contents | [optional] |
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# Freeclimb::MessageStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **NEW** | **MessageStatus** | | Represented in Ruby as "new" |
|
8
|
+
| **QUEUED** | **MessageStatus** | | Represented in Ruby as "queued" |
|
9
|
+
| **REJECTED** | **MessageStatus** | | Represented in Ruby as "rejected" |
|
10
|
+
| **SENDING** | **MessageStatus** | | Represented in Ruby as "sending" |
|
11
|
+
| **SENT** | **MessageStatus** | | Represented in Ruby as "sent" |
|
12
|
+
| **FAILED** | **MessageStatus** | | Represented in Ruby as "failed" |
|
13
|
+
| **RECEIVED** | **MessageStatus** | | Represented in Ruby as "received" |
|
14
|
+
| **UNDELIVERED** | **MessageStatus** | | Represented in Ruby as "undelivered" |
|
15
|
+
| **EXPIRED** | **MessageStatus** | | Represented in Ruby as "expired" |
|
16
|
+
| **DELETED** | **MessageStatus** | | Represented in Ruby as "deleted" |
|
17
|
+
| **UNKNOWN** | **MessageStatus** | | Represented in Ruby as "unknown" |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'freeclimb'
|
23
|
+
|
24
|
+
instance = Freeclimb::MessageStatus::[NAME OF ENUM]
|
25
|
+
```
|
26
|
+
|
data/docs/OutDial.md
CHANGED
@@ -8,7 +8,7 @@
|
|
8
8
|
| **call_connect_url** | **String** | URL to which FreeClimb makes an HTTP POST request informing the result of the OutDial. | |
|
9
9
|
| **calling_number** | **Float** | he caller ID to show to the called party when FreeClimb calls. This can be one of the following: The To or From number provided in the first Webhook to your webserver. Any phone number you have purchased from FreeClimb. | |
|
10
10
|
| **destination** | **Float** | E.164 representation of the phone number to Call. | |
|
11
|
-
| **if_machine** | **
|
11
|
+
| **if_machine** | [**IfMachine**](IfMachine.md) | | [optional] |
|
12
12
|
| **if_machine_url** | **String** | When the `ifMachine` flag is set to `redirect`, this attribute specifies a URL to which FreeClimb makes a POST request when an answering machine or a fax machine is detected. This URL is required if the `ifMachine` flag is set to `redirect`. Otherwise, it should not be included. | [optional] |
|
13
13
|
| **send_digits** | **String** | DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension. | [optional] |
|
14
14
|
| **status_callback_url** | **String** | When the outdialed Call leg terminates, FreeClimb sends a `callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored. | [optional] |
|
data/docs/OutDialAllOf.md
CHANGED
@@ -8,7 +8,7 @@
|
|
8
8
|
| **call_connect_url** | **String** | URL to which FreeClimb makes an HTTP POST request informing the result of the OutDial. | |
|
9
9
|
| **calling_number** | **Float** | he caller ID to show to the called party when FreeClimb calls. This can be one of the following: The To or From number provided in the first Webhook to your webserver. Any phone number you have purchased from FreeClimb. | |
|
10
10
|
| **destination** | **Float** | E.164 representation of the phone number to Call. | |
|
11
|
-
| **if_machine** | **
|
11
|
+
| **if_machine** | [**IfMachine**](IfMachine.md) | | [optional] |
|
12
12
|
| **if_machine_url** | **String** | When the `ifMachine` flag is set to `redirect`, this attribute specifies a URL to which FreeClimb makes a POST request when an answering machine or a fax machine is detected. This URL is required if the `ifMachine` flag is set to `redirect`. Otherwise, it should not be included. | [optional] |
|
13
13
|
| **send_digits** | **String** | DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension. | [optional] |
|
14
14
|
| **status_callback_url** | **String** | When the outdialed Call leg terminates, FreeClimb sends a `callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored. | [optional] |
|
data/docs/PlayBeep.md
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# Freeclimb::PlayBeep
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ALWAYS** | **PlayBeep** | | Represented in Ruby as "always" |
|
8
|
+
| **NEVER** | **PlayBeep** | | Represented in Ruby as "never" |
|
9
|
+
| **ENTRY_ONLY** | **PlayBeep** | | Represented in Ruby as "entryOnly" |
|
10
|
+
| **EXIT_ONLY** | **PlayBeep** | | Represented in Ruby as "exitOnly" |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'freeclimb'
|
16
|
+
|
17
|
+
instance = Freeclimb::PlayBeep::[NAME OF ENUM]
|
18
|
+
```
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Freeclimb::QueueResultStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **QUEUE_FULL** | **QueueResultStatus** | | Represented in Ruby as "queueFull" |
|
8
|
+
| **DEQUEUED** | **QueueResultStatus** | | Represented in Ruby as "dequeued" |
|
9
|
+
| **HANGUP** | **QueueResultStatus** | | Represented in Ruby as "hangup" |
|
10
|
+
| **SYSTEM_ERROR** | **QueueResultStatus** | | Represented in Ruby as "systemError" |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'freeclimb'
|
16
|
+
|
17
|
+
instance = Freeclimb::QueueResultStatus::[NAME OF ENUM]
|
18
|
+
```
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Freeclimb::RecordUtteranceTermReason
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **FINISH_KEY** | **RecordUtteranceTermReason** | | Represented in Ruby as "finishKey" |
|
8
|
+
| **TIMEOUT** | **RecordUtteranceTermReason** | | Represented in Ruby as "timeout" |
|
9
|
+
| **HANGUP** | **RecordUtteranceTermReason** | | Represented in Ruby as "hangup" |
|
10
|
+
| **MAX_LENGTH** | **RecordUtteranceTermReason** | | Represented in Ruby as "maxLength" |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'freeclimb'
|
16
|
+
|
17
|
+
instance = Freeclimb::RecordUtteranceTermReason::[NAME OF ENUM]
|
18
|
+
```
|
19
|
+
|
data/docs/RequestType.md
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# Freeclimb::RequestType
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **INBOUND_CALL** | **RequestType** | | Represented in Ruby as "inboundCall" |
|
8
|
+
| **RECORD** | **RequestType** | | Represented in Ruby as "record" |
|
9
|
+
| **GET_DIGITS** | **RequestType** | | Represented in Ruby as "getDigits" |
|
10
|
+
| **GET_SPEECH** | **RequestType** | | Represented in Ruby as "getSpeech" |
|
11
|
+
| **REDIRECT** | **RequestType** | | Represented in Ruby as "redirect" |
|
12
|
+
| **PAUSE** | **RequestType** | | Represented in Ruby as "pause" |
|
13
|
+
| **OUT_DIAL_START** | **RequestType** | | Represented in Ruby as "outDialStart" |
|
14
|
+
| **OUT_DIAL_CONNECT** | **RequestType** | | Represented in Ruby as "outDialConnect" |
|
15
|
+
| **OUT_DIAL_API_CONNECT** | **RequestType** | | Represented in Ruby as "outDialApiConnect" |
|
16
|
+
| **MACHINE_DETECTED** | **RequestType** | | Represented in Ruby as "machineDetected" |
|
17
|
+
| **DEQUEUE** | **RequestType** | | Represented in Ruby as "dequeue" |
|
18
|
+
| **QUEUE_WAIT** | **RequestType** | | Represented in Ruby as "queueWait" |
|
19
|
+
| **ADD_TO_QUEUE_NOTIFICATION** | **RequestType** | | Represented in Ruby as "addToQueueNotification" |
|
20
|
+
| **REMOVE_FROM_QUEUE_NOTIFICATION** | **RequestType** | | Represented in Ruby as "removeFromQueueNotification" |
|
21
|
+
| **CALL_STATUS** | **RequestType** | | Represented in Ruby as "callStatus" |
|
22
|
+
| **CREATE_CONFERENCE** | **RequestType** | | Represented in Ruby as "createConference" |
|
23
|
+
| **CONFERENCE_STATUS** | **RequestType** | | Represented in Ruby as "conferenceStatus" |
|
24
|
+
| **LEAVE_CONFERENCE** | **RequestType** | | Represented in Ruby as "leaveConference" |
|
25
|
+
| **ADD_TO_CONFERENCE_NOTIFICATION** | **RequestType** | | Represented in Ruby as "addToConferenceNotification" |
|
26
|
+
| **CONFERENCE_RECORDING_STATUS** | **RequestType** | | Represented in Ruby as "conferenceRecordingStatus" |
|
27
|
+
| **CONFERENCE_CALL_CONTROL** | **RequestType** | | Represented in Ruby as "conferenceCallControl" |
|
28
|
+
| **MESSAGE_DELIVERY** | **RequestType** | | Represented in Ruby as "messageDelivery" |
|
29
|
+
| **MESSAGE_STATUS** | **RequestType** | | Represented in Ruby as "messageStatus" |
|
30
|
+
|
31
|
+
## Example
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
require 'freeclimb'
|
35
|
+
|
36
|
+
instance = Freeclimb::RequestType::[NAME OF ENUM]
|
37
|
+
```
|
38
|
+
|
data/docs/StartRecordCall.md
CHANGED
data/docs/Unpark.md
CHANGED
data/docs/UpdateCallRequest.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **status** | **
|
7
|
+
| **status** | [**UpdateCallRequestStatus**](UpdateCallRequestStatus.md) | | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Freeclimb::UpdateCallRequestStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **CANCELED** | **UpdateCallRequestStatus** | | Represented in Ruby as "canceled" |
|
8
|
+
| **COMPLETED** | **UpdateCallRequestStatus** | | Represented in Ruby as "completed" |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'freeclimb'
|
14
|
+
|
15
|
+
instance = Freeclimb::UpdateCallRequestStatus::[NAME OF ENUM]
|
16
|
+
```
|
17
|
+
|
@@ -5,8 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **_alias** | **String** | Description for this conference. Maximum 64 characters. | [optional] |
|
8
|
-
| **play_beep** | **
|
9
|
-
| **status** | **
|
8
|
+
| **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional][default to 'always'] |
|
9
|
+
| **status** | [**UpdateConferenceRequestStatus**](UpdateConferenceRequestStatus.md) | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Freeclimb::UpdateConferenceRequestStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **EMPTY** | **UpdateConferenceRequestStatus** | | Represented in Ruby as "empty" |
|
8
|
+
| **TERMINATED** | **UpdateConferenceRequestStatus** | | Represented in Ruby as "terminated" |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'freeclimb'
|
14
|
+
|
15
|
+
instance = Freeclimb::UpdateConferenceRequestStatus::[NAME OF ENUM]
|
16
|
+
```
|
17
|
+
|
@@ -1794,7 +1794,7 @@ module Freeclimb
|
|
1794
1794
|
# @option opts [Boolean] :active If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. (default to false)
|
1795
1795
|
# @option opts [String] :to Only show Calls to this phone number.
|
1796
1796
|
# @option opts [String] :from Only show Calls from this phone number.
|
1797
|
-
# @option opts [
|
1797
|
+
# @option opts [CallStatus] :status Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`.
|
1798
1798
|
# @option opts [String] :start_time Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss.
|
1799
1799
|
# @option opts [String] :end_time Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.
|
1800
1800
|
# @option opts [String] :parent_call_id Only show Calls spawned by the call with this ID.
|
@@ -1809,7 +1809,7 @@ module Freeclimb
|
|
1809
1809
|
# @option opts [Boolean] :active If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query.
|
1810
1810
|
# @option opts [String] :to Only show Calls to this phone number.
|
1811
1811
|
# @option opts [String] :from Only show Calls from this phone number.
|
1812
|
-
# @option opts [
|
1812
|
+
# @option opts [CallStatus] :status Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`.
|
1813
1813
|
# @option opts [String] :start_time Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss.
|
1814
1814
|
# @option opts [String] :end_time Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.
|
1815
1815
|
# @option opts [String] :parent_call_id Only show Calls spawned by the call with this ID.
|
@@ -2229,7 +2229,7 @@ module Freeclimb
|
|
2229
2229
|
# @option opts [String] :from Only show Messages from this phone number.
|
2230
2230
|
# @option opts [String] :begin_time Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*.
|
2231
2231
|
# @option opts [String] :end_time Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*..
|
2232
|
-
# @option opts [
|
2232
|
+
# @option opts [MessageDirection] :direction Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb.
|
2233
2233
|
# @return [MessagesList]
|
2234
2234
|
def list_sms_messages(opts = {})
|
2235
2235
|
data, _status_code, _headers = list_sms_messages_with_http_info(opts)
|
@@ -2242,16 +2242,12 @@ module Freeclimb
|
|
2242
2242
|
# @option opts [String] :from Only show Messages from this phone number.
|
2243
2243
|
# @option opts [String] :begin_time Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*.
|
2244
2244
|
# @option opts [String] :end_time Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*..
|
2245
|
-
# @option opts [
|
2245
|
+
# @option opts [MessageDirection] :direction Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb.
|
2246
2246
|
# @return [Array<(MessagesList, Integer, Hash)>] MessagesList data, response status code and response headers
|
2247
2247
|
def list_sms_messages_with_http_info(opts = {})
|
2248
2248
|
if @api_client.config.debugging
|
2249
2249
|
@api_client.config.logger.debug 'Calling API: DefaultApi.list_sms_messages ...'
|
2250
2250
|
end
|
2251
|
-
allowable_values = ["inbound", "outbound"]
|
2252
|
-
if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
|
2253
|
-
fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
|
2254
|
-
end
|
2255
2251
|
# resource path
|
2256
2252
|
local_var_path = '/Accounts/{accountId}/Messages'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
|
2257
2253
|
|