freeclimb 2.1.2 → 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 +27 -0
- data/Gemfile +0 -1
- data/README.md +6 -5
- data/docs/AccountResult.md +2 -2
- data/docs/AccountResultAllOf.md +2 -2
- data/docs/AddToConference.md +1 -1
- data/docs/AddToConferenceAllOf.md +1 -1
- data/docs/AvailableNumber.md +0 -2
- data/docs/DefaultApi.md +73 -51
- data/lib/freeclimb/api/default_api.rb +33 -3
- data/lib/freeclimb/api_client.rb +1 -1
- data/lib/freeclimb/models/account_result.rb +8 -8
- data/lib/freeclimb/models/account_result_all_of.rb +8 -8
- data/lib/freeclimb/models/add_to_conference.rb +0 -5
- data/lib/freeclimb/models/add_to_conference_all_of.rb +0 -5
- data/lib/freeclimb/models/available_number.rb +1 -11
- data/lib/freeclimb/models/percl_command.rb +1 -0
- data/lib/freeclimb/utils.rb +34 -0
- data/lib/freeclimb/version.rb +1 -1
- data/spec/api/default_api_spec.rb +119 -675
- data/spec/api/web_mocks.rb +1 -1
- 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 +85 -5
- data/freeclimb-2.0.3.gem +0 -0
- data/freeclimb-2.1.0.gem +0 -0
- data/freeclimb-2.1.1.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,33 @@ 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
|
+
|
18
|
+
<a name="3.0.1"></a>
|
19
|
+
## [3.0.1] - 2021-11-02
|
20
|
+
### Added
|
21
|
+
- Add `active` property to CallResult
|
22
|
+
|
23
|
+
### Changed
|
24
|
+
- Small instances of `token` to `key`
|
25
|
+
- Call ID is not required to `AddToConference`
|
26
|
+
|
27
|
+
<a name="3.0.0"></a>
|
28
|
+
## [3.0.0] - 2021-05-03
|
29
|
+
### Added
|
30
|
+
- Add `verify_request` utility function
|
31
|
+
|
32
|
+
<a name="2.2.0"></a>
|
33
|
+
## [2.2.0] - 2021-04-12
|
34
|
+
### Changed
|
35
|
+
- Replace any language instance of `auth_token` or similar speech to `api_key`
|
36
|
+
|
10
37
|
<a name="2.1.2"></a>
|
11
38
|
## [2.1.2] - 2021-03-10
|
12
39
|
### 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:
|
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-
|
24
|
+
gem install ./freeclimb-3.0.2.gem
|
25
25
|
```
|
26
26
|
|
27
|
-
(for development, run `gem install --dev ./freeclimb-
|
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', '~>
|
33
|
+
gem 'freeclimb', '~> 3.0.2'
|
34
34
|
|
35
35
|
### Install from Ruby gems
|
36
36
|
```shell
|
@@ -63,7 +63,7 @@ require 'freeclimb'
|
|
63
63
|
Freeclimb.configure do |config|
|
64
64
|
# Configure HTTP basic authorization: fc
|
65
65
|
config.username = 'ACCOUNT_ID'
|
66
|
-
config.password = '
|
66
|
+
config.password = 'API_KEY'
|
67
67
|
end
|
68
68
|
|
69
69
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -259,6 +259,7 @@ Class | Method | HTTP request | Description
|
|
259
259
|
|
260
260
|
- **Type**: HTTP basic authentication
|
261
261
|
|
262
|
+
|
262
263
|
## Getting Help
|
263
264
|
|
264
265
|
If you are experiencing difficulties, [contact support](https://freeclimb.com/support).
|
data/docs/AccountResult.md
CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
|
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
|
+
**api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional]
|
13
13
|
**_alias** | **String** | A description for this account. | [optional]
|
14
14
|
**label** | **String** | A string that identifies a category or group to which the account belongs. | [optional]
|
15
15
|
**type** | **String** | The type of this account. It is one of: trial or full. | [optional]
|
@@ -26,7 +26,7 @@ instance = Freeclimb::AccountResult.new(uri: nil,
|
|
26
26
|
date_updated: nil,
|
27
27
|
revision: nil,
|
28
28
|
account_id: nil,
|
29
|
-
|
29
|
+
api_key: nil,
|
30
30
|
_alias: nil,
|
31
31
|
label: nil,
|
32
32
|
type: nil,
|
data/docs/AccountResultAllOf.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**account_id** | **String** | String that uniquely identifies this account resource. | [optional]
|
8
|
-
**
|
8
|
+
**api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional]
|
9
9
|
**_alias** | **String** | A description for this account. | [optional]
|
10
10
|
**label** | **String** | A string that identifies a category or group to which the account belongs. | [optional]
|
11
11
|
**type** | **String** | The type of this account. It is one of: trial or full. | [optional]
|
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
|
|
18
18
|
require 'freeclimb'
|
19
19
|
|
20
20
|
instance = Freeclimb::AccountResultAllOf.new(account_id: nil,
|
21
|
-
|
21
|
+
api_key: nil,
|
22
22
|
_alias: nil,
|
23
23
|
label: nil,
|
24
24
|
type: nil,
|
data/docs/AddToConference.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the `callControlUrl`. Only digits plus '*', and '#' may be used. | [optional]
|
9
9
|
**call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the `callControlSequence` attribute. | [optional]
|
10
10
|
**conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. |
|
11
|
-
**call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. |
|
11
|
+
**call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. | [optional]
|
12
12
|
**leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional]
|
13
13
|
**listen** | **Boolean** | If `true`, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or `SetListen` PerCL command. | [optional]
|
14
14
|
**notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the `callControlUrl`. Only digits plus '*', and '#' may be used. | [optional]
|
9
9
|
**call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the `callControlSequence` attribute. | [optional]
|
10
10
|
**conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. |
|
11
|
-
**call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. |
|
11
|
+
**call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. | [optional]
|
12
12
|
**leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional]
|
13
13
|
**listen** | **Boolean** | If `true`, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or `SetListen` PerCL command. | [optional]
|
14
14
|
**notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
|
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/DefaultApi.md
CHANGED
@@ -68,7 +68,7 @@ require 'freeclimb'
|
|
68
68
|
Freeclimb.configure do |config|
|
69
69
|
# Configure HTTP basic authorization: fc
|
70
70
|
config.username = 'ACCOUNT ID'
|
71
|
-
config.password = '
|
71
|
+
config.password = 'API KEY'
|
72
72
|
end
|
73
73
|
|
74
74
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -115,7 +115,7 @@ require 'freeclimb'
|
|
115
115
|
Freeclimb.configure do |config|
|
116
116
|
# Configure HTTP basic authorization: fc
|
117
117
|
config.username = 'ACCOUNT ID'
|
118
|
-
config.password = '
|
118
|
+
config.password = 'API KEY'
|
119
119
|
end
|
120
120
|
|
121
121
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -166,7 +166,7 @@ require 'freeclimb'
|
|
166
166
|
Freeclimb.configure do |config|
|
167
167
|
# Configure HTTP basic authorization: fc
|
168
168
|
config.username = 'ACCOUNT ID'
|
169
|
-
config.password = '
|
169
|
+
config.password = 'API KEY'
|
170
170
|
end
|
171
171
|
|
172
172
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -219,7 +219,7 @@ require 'freeclimb'
|
|
219
219
|
Freeclimb.configure do |config|
|
220
220
|
# Configure HTTP basic authorization: fc
|
221
221
|
config.username = 'ACCOUNT ID'
|
222
|
-
config.password = '
|
222
|
+
config.password = 'API KEY'
|
223
223
|
end
|
224
224
|
|
225
225
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -272,7 +272,7 @@ require 'freeclimb'
|
|
272
272
|
Freeclimb.configure do |config|
|
273
273
|
# Configure HTTP basic authorization: fc
|
274
274
|
config.username = 'ACCOUNT ID'
|
275
|
-
config.password = '
|
275
|
+
config.password = 'API KEY'
|
276
276
|
end
|
277
277
|
|
278
278
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -325,7 +325,7 @@ require 'freeclimb'
|
|
325
325
|
Freeclimb.configure do |config|
|
326
326
|
# Configure HTTP basic authorization: fc
|
327
327
|
config.username = 'ACCOUNT ID'
|
328
|
-
config.password = '
|
328
|
+
config.password = 'API KEY'
|
329
329
|
end
|
330
330
|
|
331
331
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -375,7 +375,7 @@ require 'freeclimb'
|
|
375
375
|
Freeclimb.configure do |config|
|
376
376
|
# Configure HTTP basic authorization: fc
|
377
377
|
config.username = 'ACCOUNT ID'
|
378
|
-
config.password = '
|
378
|
+
config.password = 'API KEY'
|
379
379
|
end
|
380
380
|
|
381
381
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -425,7 +425,7 @@ require 'freeclimb'
|
|
425
425
|
Freeclimb.configure do |config|
|
426
426
|
# Configure HTTP basic authorization: fc
|
427
427
|
config.username = 'ACCOUNT ID'
|
428
|
-
config.password = '
|
428
|
+
config.password = 'API KEY'
|
429
429
|
end
|
430
430
|
|
431
431
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -475,7 +475,7 @@ require 'freeclimb'
|
|
475
475
|
Freeclimb.configure do |config|
|
476
476
|
# Configure HTTP basic authorization: fc
|
477
477
|
config.username = 'ACCOUNT ID'
|
478
|
-
config.password = '
|
478
|
+
config.password = 'API KEY'
|
479
479
|
end
|
480
480
|
|
481
481
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -528,7 +528,7 @@ require 'freeclimb'
|
|
528
528
|
Freeclimb.configure do |config|
|
529
529
|
# Configure HTTP basic authorization: fc
|
530
530
|
config.username = 'ACCOUNT ID'
|
531
|
-
config.password = '
|
531
|
+
config.password = 'API KEY'
|
532
532
|
end
|
533
533
|
|
534
534
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -579,7 +579,7 @@ require 'freeclimb'
|
|
579
579
|
Freeclimb.configure do |config|
|
580
580
|
# Configure HTTP basic authorization: fc
|
581
581
|
config.username = 'ACCOUNT ID'
|
582
|
-
config.password = '
|
582
|
+
config.password = 'API KEY'
|
583
583
|
end
|
584
584
|
|
585
585
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -630,7 +630,7 @@ require 'freeclimb'
|
|
630
630
|
Freeclimb.configure do |config|
|
631
631
|
# Configure HTTP basic authorization: fc
|
632
632
|
config.username = 'ACCOUNT ID'
|
633
|
-
config.password = '
|
633
|
+
config.password = 'API KEY'
|
634
634
|
end
|
635
635
|
|
636
636
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -681,7 +681,7 @@ require 'freeclimb'
|
|
681
681
|
Freeclimb.configure do |config|
|
682
682
|
# Configure HTTP basic authorization: fc
|
683
683
|
config.username = 'ACCOUNT ID'
|
684
|
-
config.password = '
|
684
|
+
config.password = 'API KEY'
|
685
685
|
end
|
686
686
|
|
687
687
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -732,7 +732,7 @@ require 'freeclimb'
|
|
732
732
|
Freeclimb.configure do |config|
|
733
733
|
# Configure HTTP basic authorization: fc
|
734
734
|
config.username = 'ACCOUNT ID'
|
735
|
-
config.password = '
|
735
|
+
config.password = 'API KEY'
|
736
736
|
end
|
737
737
|
|
738
738
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -783,7 +783,7 @@ require 'freeclimb'
|
|
783
783
|
Freeclimb.configure do |config|
|
784
784
|
# Configure HTTP basic authorization: fc
|
785
785
|
config.username = 'ACCOUNT ID'
|
786
|
-
config.password = '
|
786
|
+
config.password = 'API KEY'
|
787
787
|
end
|
788
788
|
|
789
789
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -836,7 +836,7 @@ require 'freeclimb'
|
|
836
836
|
Freeclimb.configure do |config|
|
837
837
|
# Configure HTTP basic authorization: fc
|
838
838
|
config.username = 'ACCOUNT ID'
|
839
|
-
config.password = '
|
839
|
+
config.password = 'API KEY'
|
840
840
|
end
|
841
841
|
|
842
842
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -889,7 +889,7 @@ require 'freeclimb'
|
|
889
889
|
Freeclimb.configure do |config|
|
890
890
|
# Configure HTTP basic authorization: fc
|
891
891
|
config.username = 'ACCOUNT ID'
|
892
|
-
config.password = '
|
892
|
+
config.password = 'API KEY'
|
893
893
|
end
|
894
894
|
|
895
895
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -940,7 +940,7 @@ require 'freeclimb'
|
|
940
940
|
Freeclimb.configure do |config|
|
941
941
|
# Configure HTTP basic authorization: fc
|
942
942
|
config.username = 'ACCOUNT ID'
|
943
|
-
config.password = '
|
943
|
+
config.password = 'API KEY'
|
944
944
|
end
|
945
945
|
|
946
946
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -991,7 +991,7 @@ require 'freeclimb'
|
|
991
991
|
Freeclimb.configure do |config|
|
992
992
|
# Configure HTTP basic authorization: fc
|
993
993
|
config.username = 'ACCOUNT ID'
|
994
|
-
config.password = '
|
994
|
+
config.password = 'API KEY'
|
995
995
|
end
|
996
996
|
|
997
997
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -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
|
|
@@ -1042,15 +1042,23 @@ require 'freeclimb'
|
|
1042
1042
|
Freeclimb.configure do |config|
|
1043
1043
|
# Configure HTTP basic authorization: fc
|
1044
1044
|
config.username = 'ACCOUNT ID'
|
1045
|
-
config.password = '
|
1045
|
+
config.password = 'API KEY'
|
1046
1046
|
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
|
|
@@ -1093,7 +1107,7 @@ require 'freeclimb'
|
|
1093
1107
|
Freeclimb.configure do |config|
|
1094
1108
|
# Configure HTTP basic authorization: fc
|
1095
1109
|
config.username = 'ACCOUNT ID'
|
1096
|
-
config.password = '
|
1110
|
+
config.password = 'API KEY'
|
1097
1111
|
end
|
1098
1112
|
|
1099
1113
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1144,7 +1158,7 @@ require 'freeclimb'
|
|
1144
1158
|
Freeclimb.configure do |config|
|
1145
1159
|
# Configure HTTP basic authorization: fc
|
1146
1160
|
config.username = 'ACCOUNT ID'
|
1147
|
-
config.password = '
|
1161
|
+
config.password = 'API KEY'
|
1148
1162
|
end
|
1149
1163
|
|
1150
1164
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1195,7 +1209,7 @@ require 'freeclimb'
|
|
1195
1209
|
Freeclimb.configure do |config|
|
1196
1210
|
# Configure HTTP basic authorization: fc
|
1197
1211
|
config.username = 'ACCOUNT ID'
|
1198
|
-
config.password = '
|
1212
|
+
config.password = 'API KEY'
|
1199
1213
|
end
|
1200
1214
|
|
1201
1215
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1248,7 +1262,7 @@ require 'freeclimb'
|
|
1248
1262
|
Freeclimb.configure do |config|
|
1249
1263
|
# Configure HTTP basic authorization: fc
|
1250
1264
|
config.username = 'ACCOUNT ID'
|
1251
|
-
config.password = '
|
1265
|
+
config.password = 'API KEY'
|
1252
1266
|
end
|
1253
1267
|
|
1254
1268
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1295,7 +1309,7 @@ require 'freeclimb'
|
|
1295
1309
|
Freeclimb.configure do |config|
|
1296
1310
|
# Configure HTTP basic authorization: fc
|
1297
1311
|
config.username = 'ACCOUNT ID'
|
1298
|
-
config.password = '
|
1312
|
+
config.password = 'API KEY'
|
1299
1313
|
end
|
1300
1314
|
|
1301
1315
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1348,13 +1362,16 @@ require 'freeclimb'
|
|
1348
1362
|
Freeclimb.configure do |config|
|
1349
1363
|
# Configure HTTP basic authorization: fc
|
1350
1364
|
config.username = 'ACCOUNT ID'
|
1351
|
-
config.password = '
|
1365
|
+
config.password = 'API KEY'
|
1352
1366
|
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
|
|
@@ -1403,7 +1423,7 @@ require 'freeclimb'
|
|
1403
1423
|
Freeclimb.configure do |config|
|
1404
1424
|
# Configure HTTP basic authorization: fc
|
1405
1425
|
config.username = 'ACCOUNT ID'
|
1406
|
-
config.password = '
|
1426
|
+
config.password = 'API KEY'
|
1407
1427
|
end
|
1408
1428
|
|
1409
1429
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1454,7 +1474,7 @@ require 'freeclimb'
|
|
1454
1474
|
Freeclimb.configure do |config|
|
1455
1475
|
# Configure HTTP basic authorization: fc
|
1456
1476
|
config.username = 'ACCOUNT ID'
|
1457
|
-
config.password = '
|
1477
|
+
config.password = 'API KEY'
|
1458
1478
|
end
|
1459
1479
|
|
1460
1480
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1509,11 +1529,12 @@ require 'freeclimb'
|
|
1509
1529
|
Freeclimb.configure do |config|
|
1510
1530
|
# Configure HTTP basic authorization: fc
|
1511
1531
|
config.username = 'ACCOUNT ID'
|
1512
|
-
config.password = '
|
1532
|
+
config.password = 'API KEY'
|
1513
1533
|
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]
|
@@ -1572,7 +1594,7 @@ require 'freeclimb'
|
|
1572
1594
|
Freeclimb.configure do |config|
|
1573
1595
|
# Configure HTTP basic authorization: fc
|
1574
1596
|
config.username = 'ACCOUNT ID'
|
1575
|
-
config.password = '
|
1597
|
+
config.password = 'API KEY'
|
1576
1598
|
end
|
1577
1599
|
|
1578
1600
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1631,7 +1653,7 @@ require 'freeclimb'
|
|
1631
1653
|
Freeclimb.configure do |config|
|
1632
1654
|
# Configure HTTP basic authorization: fc
|
1633
1655
|
config.username = 'ACCOUNT ID'
|
1634
|
-
config.password = '
|
1656
|
+
config.password = 'API KEY'
|
1635
1657
|
end
|
1636
1658
|
|
1637
1659
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1686,7 +1708,7 @@ require 'freeclimb'
|
|
1686
1708
|
Freeclimb.configure do |config|
|
1687
1709
|
# Configure HTTP basic authorization: fc
|
1688
1710
|
config.username = 'ACCOUNT ID'
|
1689
|
-
config.password = '
|
1711
|
+
config.password = 'API KEY'
|
1690
1712
|
end
|
1691
1713
|
|
1692
1714
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1737,7 +1759,7 @@ require 'freeclimb'
|
|
1737
1759
|
Freeclimb.configure do |config|
|
1738
1760
|
# Configure HTTP basic authorization: fc
|
1739
1761
|
config.username = 'ACCOUNT ID'
|
1740
|
-
config.password = '
|
1762
|
+
config.password = 'API KEY'
|
1741
1763
|
end
|
1742
1764
|
|
1743
1765
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1794,7 +1816,7 @@ require 'freeclimb'
|
|
1794
1816
|
Freeclimb.configure do |config|
|
1795
1817
|
# Configure HTTP basic authorization: fc
|
1796
1818
|
config.username = 'ACCOUNT ID'
|
1797
|
-
config.password = '
|
1819
|
+
config.password = 'API KEY'
|
1798
1820
|
end
|
1799
1821
|
|
1800
1822
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1851,7 +1873,7 @@ require 'freeclimb'
|
|
1851
1873
|
Freeclimb.configure do |config|
|
1852
1874
|
# Configure HTTP basic authorization: fc
|
1853
1875
|
config.username = 'ACCOUNT ID'
|
1854
|
-
config.password = '
|
1876
|
+
config.password = 'API KEY'
|
1855
1877
|
end
|
1856
1878
|
|
1857
1879
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1914,7 +1936,7 @@ require 'freeclimb'
|
|
1914
1936
|
Freeclimb.configure do |config|
|
1915
1937
|
# Configure HTTP basic authorization: fc
|
1916
1938
|
config.username = 'ACCOUNT ID'
|
1917
|
-
config.password = '
|
1939
|
+
config.password = 'API KEY'
|
1918
1940
|
end
|
1919
1941
|
|
1920
1942
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -1967,7 +1989,7 @@ require 'freeclimb'
|
|
1967
1989
|
Freeclimb.configure do |config|
|
1968
1990
|
# Configure HTTP basic authorization: fc
|
1969
1991
|
config.username = 'ACCOUNT ID'
|
1970
|
-
config.password = '
|
1992
|
+
config.password = 'API KEY'
|
1971
1993
|
end
|
1972
1994
|
|
1973
1995
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -2019,7 +2041,7 @@ require 'freeclimb'
|
|
2019
2041
|
Freeclimb.configure do |config|
|
2020
2042
|
# Configure HTTP basic authorization: fc
|
2021
2043
|
config.username = 'ACCOUNT ID'
|
2022
|
-
config.password = '
|
2044
|
+
config.password = 'API KEY'
|
2023
2045
|
end
|
2024
2046
|
|
2025
2047
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -2070,7 +2092,7 @@ require 'freeclimb'
|
|
2070
2092
|
Freeclimb.configure do |config|
|
2071
2093
|
# Configure HTTP basic authorization: fc
|
2072
2094
|
config.username = 'ACCOUNT ID'
|
2073
|
-
config.password = '
|
2095
|
+
config.password = 'API KEY'
|
2074
2096
|
end
|
2075
2097
|
|
2076
2098
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -2121,7 +2143,7 @@ require 'freeclimb'
|
|
2121
2143
|
Freeclimb.configure do |config|
|
2122
2144
|
# Configure HTTP basic authorization: fc
|
2123
2145
|
config.username = 'ACCOUNT ID'
|
2124
|
-
config.password = '
|
2146
|
+
config.password = 'API KEY'
|
2125
2147
|
end
|
2126
2148
|
|
2127
2149
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -2176,7 +2198,7 @@ require 'freeclimb'
|
|
2176
2198
|
Freeclimb.configure do |config|
|
2177
2199
|
# Configure HTTP basic authorization: fc
|
2178
2200
|
config.username = 'ACCOUNT ID'
|
2179
|
-
config.password = '
|
2201
|
+
config.password = 'API KEY'
|
2180
2202
|
end
|
2181
2203
|
|
2182
2204
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -2228,7 +2250,7 @@ require 'freeclimb'
|
|
2228
2250
|
Freeclimb.configure do |config|
|
2229
2251
|
# Configure HTTP basic authorization: fc
|
2230
2252
|
config.username = 'ACCOUNT ID'
|
2231
|
-
config.password = '
|
2253
|
+
config.password = 'API KEY'
|
2232
2254
|
end
|
2233
2255
|
|
2234
2256
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -2285,7 +2307,7 @@ require 'freeclimb'
|
|
2285
2307
|
Freeclimb.configure do |config|
|
2286
2308
|
# Configure HTTP basic authorization: fc
|
2287
2309
|
config.username = 'ACCOUNT ID'
|
2288
|
-
config.password = '
|
2310
|
+
config.password = 'API KEY'
|
2289
2311
|
end
|
2290
2312
|
|
2291
2313
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -2340,7 +2362,7 @@ require 'freeclimb'
|
|
2340
2362
|
Freeclimb.configure do |config|
|
2341
2363
|
# Configure HTTP basic authorization: fc
|
2342
2364
|
config.username = 'ACCOUNT ID'
|
2343
|
-
config.password = '
|
2365
|
+
config.password = 'API KEY'
|
2344
2366
|
end
|
2345
2367
|
|
2346
2368
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -2392,7 +2414,7 @@ require 'freeclimb'
|
|
2392
2414
|
Freeclimb.configure do |config|
|
2393
2415
|
# Configure HTTP basic authorization: fc
|
2394
2416
|
config.username = 'ACCOUNT ID'
|
2395
|
-
config.password = '
|
2417
|
+
config.password = 'API KEY'
|
2396
2418
|
end
|
2397
2419
|
|
2398
2420
|
api_instance = Freeclimb::DefaultApi.new
|
@@ -2447,7 +2469,7 @@ require 'freeclimb'
|
|
2447
2469
|
Freeclimb.configure do |config|
|
2448
2470
|
# Configure HTTP basic authorization: fc
|
2449
2471
|
config.username = 'ACCOUNT ID'
|
2450
|
-
config.password = '
|
2472
|
+
config.password = 'API KEY'
|
2451
2473
|
end
|
2452
2474
|
|
2453
2475
|
api_instance = Freeclimb::DefaultApi.new
|