freeclimb 3.0.1 → 3.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/Gemfile +0 -1
- data/README.md +4 -4
- data/docs/AvailableNumber.md +0 -2
- data/docs/CallResult.md +0 -2
- data/docs/CallResultAllOf.md +0 -2
- data/docs/DefaultApi.md +27 -5
- data/lib/freeclimb/api/default_api.rb +33 -3
- data/lib/freeclimb/api_client.rb +1 -1
- data/lib/freeclimb/models/available_number.rb +1 -11
- data/lib/freeclimb/models/call_result.rb +1 -13
- data/lib/freeclimb/models/call_result_all_of.rb +1 -13
- data/lib/freeclimb/models/percl_command.rb +1 -0
- data/lib/freeclimb/version.rb +1 -1
- data/lib/freeclimb.rb +0 -1
- data/spec/api/default_api_spec.rb +119 -675
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +18 -10
- data/spec/models/account_request_spec.rb +19 -5
- data/spec/models/account_result_all_of_spec.rb +81 -0
- data/spec/models/account_result_spec.rb +77 -5
- data/spec/models/add_to_conference_all_of_spec.rb +95 -0
- data/spec/models/add_to_conference_spec.rb +2 -2
- data/spec/models/application_list_all_of_spec.rb +41 -0
- data/spec/models/application_list_spec.rb +55 -5
- data/spec/models/application_request_spec.rb +49 -5
- data/spec/models/application_result_all_of_spec.rb +89 -0
- data/spec/models/application_result_spec.rb +85 -5
- data/spec/models/available_number_list_all_of_spec.rb +41 -0
- data/spec/models/available_number_list_spec.rb +55 -6
- data/spec/models/available_number_spec.rb +37 -5
- data/spec/models/buy_incoming_number_request_spec.rb +25 -5
- data/spec/models/call_list_all_of_spec.rb +41 -0
- data/spec/models/call_list_spec.rb +55 -6
- data/spec/models/call_result_all_of_spec.rb +129 -0
- data/spec/models/call_result_spec.rb +124 -5
- data/spec/models/conference_list_all_of_spec.rb +41 -0
- data/spec/models/conference_list_spec.rb +55 -5
- data/spec/models/conference_participant_list_all_of_spec.rb +41 -0
- data/spec/models/conference_participant_list_spec.rb +55 -5
- data/spec/models/conference_participant_result_all_of_spec.rb +71 -0
- data/spec/models/conference_participant_result_spec.rb +67 -5
- data/spec/models/conference_result_all_of_spec.rb +103 -0
- data/spec/models/conference_result_spec.rb +99 -6
- data/spec/models/create_conference_all_of_spec.rb +71 -0
- data/spec/models/create_conference_request_spec.rb +41 -6
- data/spec/models/create_conference_spec.rb +2 -2
- data/spec/models/dequeue_spec.rb +2 -2
- data/spec/models/enqueue_all_of_spec.rb +59 -0
- data/spec/models/enqueue_spec.rb +2 -2
- data/spec/models/filter_logs_request_spec.rb +13 -5
- data/spec/models/get_digits_all_of_spec.rb +89 -0
- data/spec/models/get_digits_spec.rb +8 -2
- data/spec/models/get_speech_all_of_spec.rb +113 -0
- data/spec/models/get_speech_spec.rb +3 -3
- data/spec/models/hangup_all_of_spec.rb +41 -0
- data/spec/models/incoming_number_list_all_of_spec.rb +41 -0
- data/spec/models/incoming_number_list_spec.rb +55 -6
- data/spec/models/incoming_number_request_spec.rb +19 -5
- data/spec/models/incoming_number_result_all_of_spec.rb +89 -0
- data/spec/models/incoming_number_result_spec.rb +85 -6
- data/spec/models/log_list_all_of_spec.rb +41 -0
- data/spec/models/log_list_spec.rb +55 -5
- data/spec/models/log_result_spec.rb +53 -5
- data/spec/models/make_call_request_spec.rb +67 -5
- data/spec/models/message_request_all_of_spec.rb +65 -0
- data/spec/models/message_request_spec.rb +61 -6
- data/spec/models/message_result_all_of_spec.rb +87 -0
- data/spec/models/message_result_spec.rb +83 -5
- data/spec/models/messages_list_all_of_spec.rb +41 -0
- data/spec/models/messages_list_spec.rb +55 -5
- data/spec/models/mutable_resource_model_spec.rb +31 -6
- data/spec/models/out_dial_all_of_spec.rb +95 -0
- data/spec/models/out_dial_spec.rb +8 -2
- data/spec/models/pagination_model_spec.rb +49 -5
- data/spec/models/pause_all_of_spec.rb +41 -0
- data/spec/models/pause_spec.rb +2 -2
- data/spec/models/percl_command_spec.rb +2 -2
- data/spec/models/percl_script_spec.rb +2 -2
- data/spec/models/play_all_of_spec.rb +59 -0
- data/spec/models/play_early_media_all_of_spec.rb +41 -0
- data/spec/models/play_early_media_spec.rb +2 -2
- data/spec/models/play_spec.rb +8 -2
- data/spec/models/queue_list_all_of_spec.rb +41 -0
- data/spec/models/queue_list_spec.rb +54 -5
- data/spec/models/queue_member_list_all_of_spec.rb +41 -0
- data/spec/models/queue_member_list_spec.rb +55 -5
- data/spec/models/queue_member_spec.rb +37 -6
- data/spec/models/queue_request_spec.rb +19 -6
- data/spec/models/queue_result_all_of_spec.rb +77 -0
- data/spec/models/queue_result_spec.rb +73 -5
- data/spec/models/record_utterance_all_of_spec.rb +77 -0
- data/spec/models/record_utterance_spec.rb +8 -2
- data/spec/models/recording_list_all_of_spec.rb +41 -0
- data/spec/models/recording_list_spec.rb +55 -5
- data/spec/models/recording_result_all_of_spec.rb +65 -0
- data/spec/models/recording_result_spec.rb +61 -5
- data/spec/models/redirect_all_of_spec.rb +41 -0
- data/spec/models/redirect_spec.rb +2 -2
- data/spec/models/reject_all_of_spec.rb +41 -0
- data/spec/models/remove_from_conference_all_of_spec.rb +41 -0
- data/spec/models/remove_from_conference_spec.rb +2 -2
- data/spec/models/say_all_of_spec.rb +65 -0
- data/spec/models/say_spec.rb +3 -3
- data/spec/models/send_digits_all_of_spec.rb +53 -0
- data/spec/models/send_digits_spec.rb +8 -2
- data/spec/models/set_listen_all_of_spec.rb +47 -0
- data/spec/models/set_listen_spec.rb +2 -2
- data/spec/models/set_talk_all_of_spec.rb +47 -0
- data/spec/models/set_talk_spec.rb +2 -2
- data/spec/models/sms_all_of_spec.rb +59 -0
- data/spec/models/sms_spec.rb +2 -2
- data/spec/models/start_record_call_spec.rb +2 -2
- data/spec/models/terminate_conference_all_of_spec.rb +41 -0
- data/spec/models/terminate_conference_spec.rb +2 -2
- data/spec/models/update_call_request_spec.rb +17 -5
- data/spec/models/update_conference_participant_request_spec.rb +19 -5
- data/spec/models/update_conference_request_spec.rb +29 -5
- data/spec/spec_helper.rb +4 -7
- metadata +87 -11
- data/freeclimb-2.0.3.gem +0 -0
- data/freeclimb-2.1.0.gem +0 -0
- data/freeclimb-2.1.1.gem +0 -0
- data/freeclimb-2.1.2.gem +0 -0
- data/freeclimb-2.2.0.gem +0 -0
- data/freeclimb-3.0.0.gem +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '069c922f287aeabc9c072a2c22db8c7ca517795a364ac0d568b190eb39ac1694'
|
4
|
+
data.tar.gz: 4b1e0e739ea1863ce89aaa4561b01d664dba6a30116eeac6aef1a9c078cd60d6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0f22afadb1f796a173e2d7baaf9a8f1053e9e7b293b62408a9300540f3fec4f1cf974ea5c539dc77d43db6b1a825fb69b71cfabebacc53ef972821794834c930
|
7
|
+
data.tar.gz: 7577278b4e7529626b58ff49605af8428ab61ae5f595a203667233365ddfd75efde5297aeed67877cf3196c7fbd0a7d1bf019f1680c2757fd9695b92e85a4831
|
data/CHANGELOG.md
CHANGED
@@ -7,6 +7,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
|
|
7
7
|
## [Unreleased]
|
8
8
|
None
|
9
9
|
|
10
|
+
<a name="3.0.2"></a>
|
11
|
+
## [3.0.2] - 2021-12-06
|
12
|
+
### Changed
|
13
|
+
-remove alias from accepted query parameters when listing AvailablePhoneNumbers
|
14
|
+
-Add country, region, smsEnabled, and voiceEnabled as accepted query parameters for AvailablePhoneNumbers
|
15
|
+
-Add smsEnabled to AvailablePhoneNumbers response schema
|
16
|
+
-Add applicationId, country, region, smsEnabled, voiceEnabled, and hasApplication as accepted query parameters for IncomingPhoneNumber.
|
17
|
+
|
10
18
|
<a name="3.0.1"></a>
|
11
19
|
## [3.0.1] - 2021-11-02
|
12
20
|
### Added
|
data/Gemfile
CHANGED
data/README.md
CHANGED
@@ -5,7 +5,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
|
|
5
5
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
6
6
|
|
7
7
|
- API version: 1.0.0
|
8
|
-
- Package version: 3.0.
|
8
|
+
- Package version: 3.0.2
|
9
9
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
10
10
|
|
11
11
|
## Installation
|
@@ -21,16 +21,16 @@ gem build freeclimb.gemspec
|
|
21
21
|
Then either install the gem locally:
|
22
22
|
|
23
23
|
```shell
|
24
|
-
gem install ./freeclimb-3.0.
|
24
|
+
gem install ./freeclimb-3.0.2.gem
|
25
25
|
```
|
26
26
|
|
27
|
-
(for development, run `gem install --dev ./freeclimb-3.0.
|
27
|
+
(for development, run `gem install --dev ./freeclimb-3.0.2.gem` to install the development dependencies)
|
28
28
|
|
29
29
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
30
30
|
|
31
31
|
Finally add this to the Gemfile:
|
32
32
|
|
33
|
-
gem 'freeclimb', '~> 3.0.
|
33
|
+
gem 'freeclimb', '~> 3.0.2'
|
34
34
|
|
35
35
|
### Install from Ruby gems
|
36
36
|
```shell
|
data/docs/AvailableNumber.md
CHANGED
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
|
|
7
7
|
**phone_number** | **String** | The phone number, in E.164 format (+ country code and phone number: +18003608245). | [optional]
|
8
8
|
**voice_enabled** | **Boolean** | Typically set to true for all numbers. | [optional]
|
9
9
|
**sms_enabled** | **Boolean** | Indicates whether the phone number can send and receive SMS messages. | [optional]
|
10
|
-
**_alias** | **String** | A nicely-formatted version of the phone number. | [optional]
|
11
10
|
**region** | **String** | The state or province of this phone number. | [optional]
|
12
11
|
**country** | **String** | The country of this phone number. | [optional]
|
13
12
|
|
@@ -19,7 +18,6 @@ require 'freeclimb'
|
|
19
18
|
instance = Freeclimb::AvailableNumber.new(phone_number: nil,
|
20
19
|
voice_enabled: nil,
|
21
20
|
sms_enabled: nil,
|
22
|
-
_alias: nil,
|
23
21
|
region: nil,
|
24
22
|
country: nil)
|
25
23
|
```
|
data/docs/CallResult.md
CHANGED
@@ -14,7 +14,6 @@ Name | Type | Description | Notes
|
|
14
14
|
**from** | **String** | Phone number that initiated this Call. | [optional]
|
15
15
|
**to** | **String** | Phone number that received this Call. | [optional]
|
16
16
|
**phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional]
|
17
|
-
**active** | **Boolean** | Whether the call is currently active or has concluded. | [optional] [default to false]
|
18
17
|
**status** | **String** | * `queued` &ndash; Call is ready and waiting in line before going out. * `ringing` &ndash; Call is currently ringing. * `inProgress` &ndash; Call was answered and is currently in progress. * `canceled` &ndash; Call was hung up while it was queued or ringing. * `completed` &ndash; Call was answered and has ended normally. * `busy` &ndash; Caller received a busy signal. * `failed` &ndash; Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` &ndash; Call ended without being answered. | [optional]
|
19
18
|
**start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional]
|
20
19
|
**connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional]
|
@@ -40,7 +39,6 @@ instance = Freeclimb::CallResult.new(uri: nil,
|
|
40
39
|
from: nil,
|
41
40
|
to: nil,
|
42
41
|
phone_number_id: nil,
|
43
|
-
active: nil,
|
44
42
|
status: nil,
|
45
43
|
start_time: nil,
|
46
44
|
connect_time: nil,
|
data/docs/CallResultAllOf.md
CHANGED
@@ -10,7 +10,6 @@ Name | Type | Description | Notes
|
|
10
10
|
**from** | **String** | Phone number that initiated this Call. | [optional]
|
11
11
|
**to** | **String** | Phone number that received this Call. | [optional]
|
12
12
|
**phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional]
|
13
|
-
**active** | **Boolean** | Whether the call is currently active or has concluded. | [optional] [default to false]
|
14
13
|
**status** | **String** | * `queued` &ndash; Call is ready and waiting in line before going out. * `ringing` &ndash; Call is currently ringing. * `inProgress` &ndash; Call was answered and is currently in progress. * `canceled` &ndash; Call was hung up while it was queued or ringing. * `completed` &ndash; Call was answered and has ended normally. * `busy` &ndash; Caller received a busy signal. * `failed` &ndash; Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` &ndash; Call ended without being answered. | [optional]
|
15
14
|
**start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional]
|
16
15
|
**connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional]
|
@@ -32,7 +31,6 @@ instance = Freeclimb::CallResultAllOf.new(call_id: nil,
|
|
32
31
|
from: nil,
|
33
32
|
to: nil,
|
34
33
|
phone_number_id: nil,
|
35
|
-
active: nil,
|
36
34
|
status: nil,
|
37
35
|
start_time: nil,
|
38
36
|
connect_time: nil,
|
data/docs/DefaultApi.md
CHANGED
@@ -1029,7 +1029,7 @@ Name | Type | Description | Notes
|
|
1029
1029
|
|
1030
1030
|
## get_an_incoming_number
|
1031
1031
|
|
1032
|
-
> IncomingNumberResult get_an_incoming_number(phone_number_id)
|
1032
|
+
> IncomingNumberResult get_an_incoming_number(phone_number_id, opts)
|
1033
1033
|
|
1034
1034
|
Get an Incoming Number
|
1035
1035
|
|
@@ -1047,10 +1047,18 @@ end
|
|
1047
1047
|
|
1048
1048
|
api_instance = Freeclimb::DefaultApi.new
|
1049
1049
|
phone_number_id = 'phone_number_id_example' # String | String that uniquely identifies this phone number resource.
|
1050
|
+
opts = {
|
1051
|
+
region: 'region_example', # String | State or province of this phone number.
|
1052
|
+
country: 'country_example', # String | Country of this phone number.
|
1053
|
+
voice_enabled: true, # Boolean | Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
|
1054
|
+
sms_enabled: true, # Boolean | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
|
1055
|
+
application_id: 'application_id_example', # String | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.
|
1056
|
+
has_application: false # Boolean | Indication of whether the phone number has an application linked to it.
|
1057
|
+
}
|
1050
1058
|
|
1051
1059
|
begin
|
1052
1060
|
#Get an Incoming Number
|
1053
|
-
result = api_instance.get_an_incoming_number(phone_number_id)
|
1061
|
+
result = api_instance.get_an_incoming_number(phone_number_id, opts)
|
1054
1062
|
p result
|
1055
1063
|
rescue Freeclimb::ApiError => e
|
1056
1064
|
puts "Exception when calling DefaultApi->get_an_incoming_number: #{e}"
|
@@ -1063,6 +1071,12 @@ end
|
|
1063
1071
|
Name | Type | Description | Notes
|
1064
1072
|
------------- | ------------- | ------------- | -------------
|
1065
1073
|
**phone_number_id** | **String**| String that uniquely identifies this phone number resource. |
|
1074
|
+
**region** | **String**| State or province of this phone number. | [optional]
|
1075
|
+
**country** | **String**| Country of this phone number. | [optional]
|
1076
|
+
**voice_enabled** | **Boolean**| Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] [default to true]
|
1077
|
+
**sms_enabled** | **Boolean**| Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] [default to true]
|
1078
|
+
**application_id** | **String**| ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId. | [optional]
|
1079
|
+
**has_application** | **Boolean**| Indication of whether the phone number has an application linked to it. | [optional] [default to false]
|
1066
1080
|
|
1067
1081
|
### Return type
|
1068
1082
|
|
@@ -1353,8 +1367,11 @@ end
|
|
1353
1367
|
|
1354
1368
|
api_instance = Freeclimb::DefaultApi.new
|
1355
1369
|
opts = {
|
1356
|
-
|
1357
|
-
|
1370
|
+
phone_number: 'phone_number_example', # String | PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format.
|
1371
|
+
region: 'region_example', # String | State or province of this phone number.
|
1372
|
+
country: 'country_example', # String | Country of this phone number.
|
1373
|
+
voice_enabled: true, # Boolean | Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
|
1374
|
+
sms_enabled: true # Boolean | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
|
1358
1375
|
}
|
1359
1376
|
|
1360
1377
|
begin
|
@@ -1371,8 +1388,11 @@ end
|
|
1371
1388
|
|
1372
1389
|
Name | Type | Description | Notes
|
1373
1390
|
------------- | ------------- | ------------- | -------------
|
1374
|
-
**_alias** | **String**| Filter on numbers based on the formatted string of the phone number. | [optional]
|
1375
1391
|
**phone_number** | **String**| PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format. | [optional]
|
1392
|
+
**region** | **String**| State or province of this phone number. | [optional]
|
1393
|
+
**country** | **String**| Country of this phone number. | [optional]
|
1394
|
+
**voice_enabled** | **Boolean**| Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] [default to true]
|
1395
|
+
**sms_enabled** | **Boolean**| Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] [default to true]
|
1376
1396
|
|
1377
1397
|
### Return type
|
1378
1398
|
|
@@ -1514,6 +1534,7 @@ end
|
|
1514
1534
|
|
1515
1535
|
api_instance = Freeclimb::DefaultApi.new
|
1516
1536
|
opts = {
|
1537
|
+
active: false, # Boolean | If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query.
|
1517
1538
|
to: 'to_example', # String | Only show Calls to this phone number.
|
1518
1539
|
from: 'from_example', # String | Only show Calls from this phone number.
|
1519
1540
|
status: 'status_example', # String | Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`.
|
@@ -1536,6 +1557,7 @@ end
|
|
1536
1557
|
|
1537
1558
|
Name | Type | Description | Notes
|
1538
1559
|
------------- | ------------- | ------------- | -------------
|
1560
|
+
**active** | **Boolean**| If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. | [optional] [default to false]
|
1539
1561
|
**to** | **String**| Only show Calls to this phone number. | [optional]
|
1540
1562
|
**from** | **String**| Only show Calls from this phone number. | [optional]
|
1541
1563
|
**status** | **String**| Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`. | [optional]
|
@@ -1171,6 +1171,12 @@ module Freeclimb
|
|
1171
1171
|
# Get an Incoming Number
|
1172
1172
|
# @param phone_number_id [String] String that uniquely identifies this phone number resource.
|
1173
1173
|
# @param [Hash] opts the optional parameters
|
1174
|
+
# @option opts [String] :region State or province of this phone number.
|
1175
|
+
# @option opts [String] :country Country of this phone number.
|
1176
|
+
# @option opts [Boolean] :voice_enabled Indicates whether the phone number can handle Calls. Typically set to true for all numbers. (default to true)
|
1177
|
+
# @option opts [Boolean] :sms_enabled Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. (default to true)
|
1178
|
+
# @option opts [String] :application_id ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.
|
1179
|
+
# @option opts [Boolean] :has_application Indication of whether the phone number has an application linked to it. (default to false)
|
1174
1180
|
# @return [IncomingNumberResult]
|
1175
1181
|
def get_an_incoming_number(phone_number_id, opts = {})
|
1176
1182
|
data, _status_code, _headers = get_an_incoming_number_with_http_info(phone_number_id, opts)
|
@@ -1180,6 +1186,12 @@ module Freeclimb
|
|
1180
1186
|
# Get an Incoming Number
|
1181
1187
|
# @param phone_number_id [String] String that uniquely identifies this phone number resource.
|
1182
1188
|
# @param [Hash] opts the optional parameters
|
1189
|
+
# @option opts [String] :region State or province of this phone number.
|
1190
|
+
# @option opts [String] :country Country of this phone number.
|
1191
|
+
# @option opts [Boolean] :voice_enabled Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
|
1192
|
+
# @option opts [Boolean] :sms_enabled Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
|
1193
|
+
# @option opts [String] :application_id ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.
|
1194
|
+
# @option opts [Boolean] :has_application Indication of whether the phone number has an application linked to it.
|
1183
1195
|
# @return [Array<(IncomingNumberResult, Integer, Hash)>] IncomingNumberResult data, response status code and response headers
|
1184
1196
|
def get_an_incoming_number_with_http_info(phone_number_id, opts = {})
|
1185
1197
|
if @api_client.config.debugging
|
@@ -1194,6 +1206,12 @@ module Freeclimb
|
|
1194
1206
|
|
1195
1207
|
# query parameters
|
1196
1208
|
query_params = opts[:query_params] || {}
|
1209
|
+
query_params[:'region'] = opts[:'region'] if !opts[:'region'].nil?
|
1210
|
+
query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
|
1211
|
+
query_params[:'voiceEnabled'] = opts[:'voice_enabled'] if !opts[:'voice_enabled'].nil?
|
1212
|
+
query_params[:'smsEnabled'] = opts[:'sms_enabled'] if !opts[:'sms_enabled'].nil?
|
1213
|
+
query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
|
1214
|
+
query_params[:'hasApplication'] = opts[:'has_application'] if !opts[:'has_application'].nil?
|
1197
1215
|
|
1198
1216
|
# header parameters
|
1199
1217
|
header_params = opts[:header_params] || {}
|
@@ -1518,8 +1536,11 @@ module Freeclimb
|
|
1518
1536
|
|
1519
1537
|
# List available numbers
|
1520
1538
|
# @param [Hash] opts the optional parameters
|
1521
|
-
# @option opts [String] :_alias Filter on numbers based on the formatted string of the phone number.
|
1522
1539
|
# @option opts [String] :phone_number PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format.
|
1540
|
+
# @option opts [String] :region State or province of this phone number.
|
1541
|
+
# @option opts [String] :country Country of this phone number.
|
1542
|
+
# @option opts [Boolean] :voice_enabled Indicates whether the phone number can handle Calls. Typically set to true for all numbers. (default to true)
|
1543
|
+
# @option opts [Boolean] :sms_enabled Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. (default to true)
|
1523
1544
|
# @return [AvailableNumberList]
|
1524
1545
|
def list_available_numbers(opts = {})
|
1525
1546
|
data, _status_code, _headers = list_available_numbers_with_http_info(opts)
|
@@ -1528,8 +1549,11 @@ module Freeclimb
|
|
1528
1549
|
|
1529
1550
|
# List available numbers
|
1530
1551
|
# @param [Hash] opts the optional parameters
|
1531
|
-
# @option opts [String] :_alias Filter on numbers based on the formatted string of the phone number.
|
1532
1552
|
# @option opts [String] :phone_number PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format.
|
1553
|
+
# @option opts [String] :region State or province of this phone number.
|
1554
|
+
# @option opts [String] :country Country of this phone number.
|
1555
|
+
# @option opts [Boolean] :voice_enabled Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
|
1556
|
+
# @option opts [Boolean] :sms_enabled Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
|
1533
1557
|
# @return [Array<(AvailableNumberList, Integer, Hash)>] AvailableNumberList data, response status code and response headers
|
1534
1558
|
def list_available_numbers_with_http_info(opts = {})
|
1535
1559
|
if @api_client.config.debugging
|
@@ -1540,8 +1564,11 @@ module Freeclimb
|
|
1540
1564
|
|
1541
1565
|
# query parameters
|
1542
1566
|
query_params = opts[:query_params] || {}
|
1543
|
-
query_params[:'alias'] = opts[:'_alias'] if !opts[:'_alias'].nil?
|
1544
1567
|
query_params[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].nil?
|
1568
|
+
query_params[:'region'] = opts[:'region'] if !opts[:'region'].nil?
|
1569
|
+
query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
|
1570
|
+
query_params[:'voiceEnabled'] = opts[:'voice_enabled'] if !opts[:'voice_enabled'].nil?
|
1571
|
+
query_params[:'smsEnabled'] = opts[:'sms_enabled'] if !opts[:'sms_enabled'].nil?
|
1545
1572
|
|
1546
1573
|
# header parameters
|
1547
1574
|
header_params = opts[:header_params] || {}
|
@@ -1701,6 +1728,7 @@ module Freeclimb
|
|
1701
1728
|
|
1702
1729
|
# List Calls
|
1703
1730
|
# @param [Hash] opts the optional parameters
|
1731
|
+
# @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)
|
1704
1732
|
# @option opts [String] :to Only show Calls to this phone number.
|
1705
1733
|
# @option opts [String] :from Only show Calls from this phone number.
|
1706
1734
|
# @option opts [String] :status Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`.
|
@@ -1715,6 +1743,7 @@ module Freeclimb
|
|
1715
1743
|
|
1716
1744
|
# List Calls
|
1717
1745
|
# @param [Hash] opts the optional parameters
|
1746
|
+
# @option opts [Boolean] :active If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query.
|
1718
1747
|
# @option opts [String] :to Only show Calls to this phone number.
|
1719
1748
|
# @option opts [String] :from Only show Calls from this phone number.
|
1720
1749
|
# @option opts [String] :status Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`.
|
@@ -1731,6 +1760,7 @@ module Freeclimb
|
|
1731
1760
|
|
1732
1761
|
# query parameters
|
1733
1762
|
query_params = opts[:query_params] || {}
|
1763
|
+
query_params[:'active'] = opts[:'active'] if !opts[:'active'].nil?
|
1734
1764
|
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
1735
1765
|
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
1736
1766
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
data/lib/freeclimb/api_client.rb
CHANGED
@@ -30,7 +30,7 @@ module Freeclimb
|
|
30
30
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
31
31
|
def initialize(config = Configuration.default)
|
32
32
|
@config = config
|
33
|
-
@user_agent = "FreeClimbSDK/3.0.
|
33
|
+
@user_agent = "FreeClimbSDK/3.0.2/ruby"
|
34
34
|
@default_headers = {
|
35
35
|
'Content-Type' => 'application/json',
|
36
36
|
'User-Agent' => @user_agent
|
@@ -23,9 +23,6 @@ module Freeclimb
|
|
23
23
|
# Indicates whether the phone number can send and receive SMS messages.
|
24
24
|
attr_accessor :sms_enabled
|
25
25
|
|
26
|
-
# A nicely-formatted version of the phone number.
|
27
|
-
attr_accessor :_alias
|
28
|
-
|
29
26
|
# The state or province of this phone number.
|
30
27
|
attr_accessor :region
|
31
28
|
|
@@ -38,7 +35,6 @@ module Freeclimb
|
|
38
35
|
:'phone_number' => :'phoneNumber',
|
39
36
|
:'voice_enabled' => :'voiceEnabled',
|
40
37
|
:'sms_enabled' => :'smsEnabled',
|
41
|
-
:'_alias' => :'alias',
|
42
38
|
:'region' => :'region',
|
43
39
|
:'country' => :'country'
|
44
40
|
}
|
@@ -50,7 +46,6 @@ module Freeclimb
|
|
50
46
|
:'phone_number' => :'String',
|
51
47
|
:'voice_enabled' => :'Boolean',
|
52
48
|
:'sms_enabled' => :'Boolean',
|
53
|
-
:'_alias' => :'String',
|
54
49
|
:'region' => :'String',
|
55
50
|
:'country' => :'String'
|
56
51
|
}
|
@@ -89,10 +84,6 @@ module Freeclimb
|
|
89
84
|
self.sms_enabled = attributes[:'sms_enabled']
|
90
85
|
end
|
91
86
|
|
92
|
-
if attributes.key?(:'_alias')
|
93
|
-
self._alias = attributes[:'_alias']
|
94
|
-
end
|
95
|
-
|
96
87
|
if attributes.key?(:'region')
|
97
88
|
self.region = attributes[:'region']
|
98
89
|
end
|
@@ -123,7 +114,6 @@ module Freeclimb
|
|
123
114
|
phone_number == o.phone_number &&
|
124
115
|
voice_enabled == o.voice_enabled &&
|
125
116
|
sms_enabled == o.sms_enabled &&
|
126
|
-
_alias == o._alias &&
|
127
117
|
region == o.region &&
|
128
118
|
country == o.country
|
129
119
|
end
|
@@ -137,7 +127,7 @@ module Freeclimb
|
|
137
127
|
# Calculates hash code according to all attributes.
|
138
128
|
# @return [Integer] Hash code
|
139
129
|
def hash
|
140
|
-
[phone_number, voice_enabled, sms_enabled,
|
130
|
+
[phone_number, voice_enabled, sms_enabled, region, country].hash
|
141
131
|
end
|
142
132
|
|
143
133
|
# Builds the object from hash
|
@@ -44,9 +44,6 @@ module Freeclimb
|
|
44
44
|
# If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI).
|
45
45
|
attr_accessor :phone_number_id
|
46
46
|
|
47
|
-
# Whether the call is currently active or has concluded.
|
48
|
-
attr_accessor :active
|
49
|
-
|
50
47
|
# * `queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered.
|
51
48
|
attr_accessor :status
|
52
49
|
|
@@ -109,7 +106,6 @@ module Freeclimb
|
|
109
106
|
:'from' => :'from',
|
110
107
|
:'to' => :'to',
|
111
108
|
:'phone_number_id' => :'phoneNumberId',
|
112
|
-
:'active' => :'active',
|
113
109
|
:'status' => :'status',
|
114
110
|
:'start_time' => :'startTime',
|
115
111
|
:'connect_time' => :'connectTime',
|
@@ -135,7 +131,6 @@ module Freeclimb
|
|
135
131
|
:'from' => :'String',
|
136
132
|
:'to' => :'String',
|
137
133
|
:'phone_number_id' => :'String',
|
138
|
-
:'active' => :'Boolean',
|
139
134
|
:'status' => :'String',
|
140
135
|
:'start_time' => :'String',
|
141
136
|
:'connect_time' => :'String',
|
@@ -217,12 +212,6 @@ module Freeclimb
|
|
217
212
|
self.phone_number_id = attributes[:'phone_number_id']
|
218
213
|
end
|
219
214
|
|
220
|
-
if attributes.key?(:'active')
|
221
|
-
self.active = attributes[:'active']
|
222
|
-
else
|
223
|
-
self.active = false
|
224
|
-
end
|
225
|
-
|
226
215
|
if attributes.key?(:'status')
|
227
216
|
self.status = attributes[:'status']
|
228
217
|
end
|
@@ -300,7 +289,6 @@ module Freeclimb
|
|
300
289
|
from == o.from &&
|
301
290
|
to == o.to &&
|
302
291
|
phone_number_id == o.phone_number_id &&
|
303
|
-
active == o.active &&
|
304
292
|
status == o.status &&
|
305
293
|
start_time == o.start_time &&
|
306
294
|
connect_time == o.connect_time &&
|
@@ -321,7 +309,7 @@ module Freeclimb
|
|
321
309
|
# Calculates hash code according to all attributes.
|
322
310
|
# @return [Integer] Hash code
|
323
311
|
def hash
|
324
|
-
[uri, date_created, date_updated, revision, call_id, parent_call_id, account_id, from, to, phone_number_id,
|
312
|
+
[uri, date_created, date_updated, revision, call_id, parent_call_id, account_id, from, to, phone_number_id, status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris].hash
|
325
313
|
end
|
326
314
|
|
327
315
|
# Builds the object from hash
|
@@ -32,9 +32,6 @@ module Freeclimb
|
|
32
32
|
# If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI).
|
33
33
|
attr_accessor :phone_number_id
|
34
34
|
|
35
|
-
# Whether the call is currently active or has concluded.
|
36
|
-
attr_accessor :active
|
37
|
-
|
38
35
|
# * `queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered.
|
39
36
|
attr_accessor :status
|
40
37
|
|
@@ -93,7 +90,6 @@ module Freeclimb
|
|
93
90
|
:'from' => :'from',
|
94
91
|
:'to' => :'to',
|
95
92
|
:'phone_number_id' => :'phoneNumberId',
|
96
|
-
:'active' => :'active',
|
97
93
|
:'status' => :'status',
|
98
94
|
:'start_time' => :'startTime',
|
99
95
|
:'connect_time' => :'connectTime',
|
@@ -115,7 +111,6 @@ module Freeclimb
|
|
115
111
|
:'from' => :'String',
|
116
112
|
:'to' => :'String',
|
117
113
|
:'phone_number_id' => :'String',
|
118
|
-
:'active' => :'Boolean',
|
119
114
|
:'status' => :'String',
|
120
115
|
:'start_time' => :'String',
|
121
116
|
:'connect_time' => :'String',
|
@@ -173,12 +168,6 @@ module Freeclimb
|
|
173
168
|
self.phone_number_id = attributes[:'phone_number_id']
|
174
169
|
end
|
175
170
|
|
176
|
-
if attributes.key?(:'active')
|
177
|
-
self.active = attributes[:'active']
|
178
|
-
else
|
179
|
-
self.active = false
|
180
|
-
end
|
181
|
-
|
182
171
|
if attributes.key?(:'status')
|
183
172
|
self.status = attributes[:'status']
|
184
173
|
end
|
@@ -252,7 +241,6 @@ module Freeclimb
|
|
252
241
|
from == o.from &&
|
253
242
|
to == o.to &&
|
254
243
|
phone_number_id == o.phone_number_id &&
|
255
|
-
active == o.active &&
|
256
244
|
status == o.status &&
|
257
245
|
start_time == o.start_time &&
|
258
246
|
connect_time == o.connect_time &&
|
@@ -273,7 +261,7 @@ module Freeclimb
|
|
273
261
|
# Calculates hash code according to all attributes.
|
274
262
|
# @return [Integer] Hash code
|
275
263
|
def hash
|
276
|
-
[call_id, parent_call_id, account_id, from, to, phone_number_id,
|
264
|
+
[call_id, parent_call_id, account_id, from, to, phone_number_id, status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris].hash
|
277
265
|
end
|
278
266
|
|
279
267
|
# Builds the object from hash
|
data/lib/freeclimb/version.rb
CHANGED