freeclimb 4.5.1 → 4.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/Gemfile.lock +58 -43
- data/README.md +13 -6
- data/docs/AddToConference.md +0 -2
- data/docs/AddToConferenceAllOf.md +0 -2
- data/docs/CreateWebRTCToken.md +22 -0
- data/docs/DefaultApi.md +302 -7
- data/docs/GetDigits.md +1 -1
- data/docs/GetDigitsAllOf.md +1 -1
- data/docs/IncomingNumberResult.md +3 -1
- data/docs/IncomingNumberResultAllOf.md +3 -1
- data/docs/MessageRequest.md +2 -2
- data/docs/MessageRequestAllOf.md +2 -2
- data/docs/MessageResult.md +3 -1
- data/docs/MessageResultAllOf.md +3 -1
- data/docs/Play.md +0 -2
- data/docs/PlayAllOf.md +0 -2
- data/docs/RemoveFromConference.md +1 -4
- data/docs/SMSTenDLCCampaign.md +10 -0
- data/docs/SMSTollFreeCampaign.md +30 -0
- data/docs/SMSTollFreeCampaignsListResult.md +32 -0
- data/docs/SMSTollFreeCampaignsListResultAllOf.md +18 -0
- data/docs/Say.md +0 -2
- data/docs/SayAllOf.md +0 -2
- data/docs/SetListen.md +0 -2
- data/docs/SetListenAllOf.md +0 -2
- data/docs/SetTalk.md +0 -2
- data/docs/SetTalkAllOf.md +0 -2
- data/docs/TFN.md +18 -0
- data/docs/TerminateConference.md +1 -4
- data/lib/freeclimb/api/default_api.rb +258 -7
- data/lib/freeclimb/models/add_to_conference.rb +1 -13
- data/lib/freeclimb/models/add_to_conference_all_of.rb +1 -13
- data/lib/freeclimb/models/create_web_rtc_token.rb +278 -0
- data/lib/freeclimb/models/get_digits.rb +1 -1
- data/lib/freeclimb/models/get_digits_all_of.rb +1 -1
- data/lib/freeclimb/models/incoming_number_result.rb +16 -5
- data/lib/freeclimb/models/incoming_number_result_all_of.rb +16 -5
- data/lib/freeclimb/models/message_request.rb +11 -9
- data/lib/freeclimb/models/message_request_all_of.rb +11 -9
- data/lib/freeclimb/models/message_result.rb +19 -5
- data/lib/freeclimb/models/message_result_all_of.rb +19 -5
- data/lib/freeclimb/models/play.rb +1 -13
- data/lib/freeclimb/models/play_all_of.rb +1 -13
- data/lib/freeclimb/models/remove_from_conference.rb +3 -23
- data/lib/freeclimb/models/say.rb +1 -13
- data/lib/freeclimb/models/say_all_of.rb +1 -13
- data/lib/freeclimb/models/set_listen.rb +2 -18
- data/lib/freeclimb/models/set_listen_all_of.rb +2 -18
- data/lib/freeclimb/models/set_talk.rb +2 -18
- data/lib/freeclimb/models/set_talk_all_of.rb +2 -18
- data/lib/freeclimb/models/sms_ten_dlc_campaign.rb +131 -1
- data/lib/freeclimb/models/sms_toll_free_campaign.rb +349 -0
- data/lib/freeclimb/models/sms_toll_free_campaigns_list_result.rb +311 -0
- data/lib/freeclimb/models/sms_toll_free_campaigns_list_result_all_of.rb +226 -0
- data/lib/freeclimb/models/terminate_conference.rb +3 -23
- data/lib/freeclimb/models/tfn.rb +229 -0
- data/lib/freeclimb/utils/signature_information.rb +1 -1
- data/lib/freeclimb/version.rb +1 -1
- data/lib/freeclimb.rb +5 -2
- data/openapi.json +605 -110
- data/package.json +8 -0
- data/spec/api/default_api_spec.rb +104 -3
- data/spec/models/add_to_conference_spec.rb +0 -30
- data/spec/models/create_web_rtc_token_spec.rb +225 -0
- data/spec/models/get_digits_spec.rb +19 -19
- data/spec/models/incoming_number_result_spec.rb +25 -0
- data/spec/models/message_request_spec.rb +23 -23
- data/spec/models/message_result_spec.rb +30 -0
- data/spec/models/play_spec.rb +0 -30
- data/spec/models/remove_from_conference_spec.rb +1 -67
- data/spec/models/say_spec.rb +0 -30
- data/spec/models/set_listen_spec.rb +0 -31
- data/spec/models/set_talk_spec.rb +0 -31
- data/spec/models/sms_ten_dlc_campaign_spec.rb +165 -0
- data/spec/models/sms_toll_free_campaign_spec.rb +368 -0
- data/spec/models/sms_toll_free_campaigns_list_result_spec.rb +371 -0
- data/spec/models/terminate_conference_spec.rb +1 -67
- data/spec/models/tfn_spec.rb +162 -0
- data/spec/utils/request_verifier_spec.rb +5 -4
- data/spec/utils/signature_information_spec.rb +7 -1
- data/yarn.lock +1292 -0
- metadata +102 -82
data/docs/DefaultApi.md
CHANGED
@@ -32,6 +32,8 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
|
|
32
32
|
| [**get_ten_dlc_sms_campaigns**](DefaultApi.md#get_ten_dlc_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns | Get list of SMS 10DLC Campaigns |
|
33
33
|
| [**get_ten_dlc_sms_partner_campaign**](DefaultApi.md#get_ten_dlc_sms_partner_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId} | Get a 10DLC SMS Partner Campaign |
|
34
34
|
| [**get_ten_dlc_sms_partner_campaigns**](DefaultApi.md#get_ten_dlc_sms_partner_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns | Get list of SMS 10DLC Partner Campaigns |
|
35
|
+
| [**get_toll_free_sms_campaign**](DefaultApi.md#get_toll_free_sms_campaign) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId} | Get a TollFree SMS Campaign |
|
36
|
+
| [**get_toll_free_sms_campaigns**](DefaultApi.md#get_toll_free_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns | Get list of TollFree Campaigns |
|
35
37
|
| [**list_active_queues**](DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues |
|
36
38
|
| [**list_all_account_logs**](DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs |
|
37
39
|
| [**list_applications**](DefaultApi.md#list_applications) | **GET** /Accounts/{accountId}/Applications | List applications |
|
@@ -39,6 +41,7 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
|
|
39
41
|
| [**list_call_logs**](DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs |
|
40
42
|
| [**list_call_recordings**](DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings |
|
41
43
|
| [**list_calls**](DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls |
|
44
|
+
| [**list_conference_recordings**](DefaultApi.md#list_conference_recordings) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Recordings | List Conference Recordings |
|
42
45
|
| [**list_conferences**](DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences |
|
43
46
|
| [**list_incoming_numbers**](DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers |
|
44
47
|
| [**list_members**](DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members |
|
@@ -46,6 +49,7 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
|
|
46
49
|
| [**list_recordings**](DefaultApi.md#list_recordings) | **GET** /Accounts/{accountId}/Recordings | List Recordings |
|
47
50
|
| [**list_sms_messages**](DefaultApi.md#list_sms_messages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages |
|
48
51
|
| [**make_a_call**](DefaultApi.md#make_a_call) | **POST** /Accounts/{accountId}/Calls | Make a Call |
|
52
|
+
| [**make_a_webrtc_jwt**](DefaultApi.md#make_a_webrtc_jwt) | **POST** /Accounts/{accountId}/Calls/WebRTC/Token | Make a JWT for WebRTC calling |
|
49
53
|
| [**remove_a_participant**](DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant |
|
50
54
|
| [**send_an_sms_message**](DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message |
|
51
55
|
| [**stream_a_recording_file**](DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File |
|
@@ -2052,6 +2056,144 @@ end
|
|
2052
2056
|
- **Accept**: application/json
|
2053
2057
|
|
2054
2058
|
|
2059
|
+
## get_toll_free_sms_campaign
|
2060
|
+
|
2061
|
+
Get a TollFree SMS Campaign
|
2062
|
+
|
2063
|
+
### Examples
|
2064
|
+
|
2065
|
+
```ruby
|
2066
|
+
require 'time'
|
2067
|
+
require 'freeclimb'
|
2068
|
+
# setup authorization
|
2069
|
+
Freeclimb.configure do |config|
|
2070
|
+
# Configure HTTP basic authorization: fc
|
2071
|
+
config.username = 'ACCOUNT_ID'
|
2072
|
+
config.password = 'API_KEY'
|
2073
|
+
end
|
2074
|
+
|
2075
|
+
api_instance = Freeclimb::DefaultApi.new
|
2076
|
+
|
2077
|
+
campaign_id = 'campaign_id_example' # String | String that uniquely identifies this TollFree Campaign resource.
|
2078
|
+
|
2079
|
+
|
2080
|
+
begin
|
2081
|
+
|
2082
|
+
# Get a TollFree SMS Campaign
|
2083
|
+
result = api_instance.get_toll_free_sms_campaign(campaign_id)
|
2084
|
+
p result
|
2085
|
+
rescue Freeclimb::ApiError => e
|
2086
|
+
puts "Error when calling DefaultApi->get_toll_free_sms_campaign: #{e}"
|
2087
|
+
end
|
2088
|
+
```
|
2089
|
+
|
2090
|
+
#### Using the get_toll_free_sms_campaign_with_http_info variant
|
2091
|
+
|
2092
|
+
This returns an Array which contains the response data, status code and headers.
|
2093
|
+
|
2094
|
+
> <Array(<SMSTollFreeCampaign>, Integer, Hash)> get_toll_free_sms_campaign_with_http_info(account_id, campaign_id)
|
2095
|
+
|
2096
|
+
```ruby
|
2097
|
+
begin
|
2098
|
+
# Get a TollFree SMS Campaign
|
2099
|
+
data, status_code, headers = api_instance.get_toll_free_sms_campaign_with_http_info(campaign_id)
|
2100
|
+
p status_code # => 2xx
|
2101
|
+
p headers # => { ... }
|
2102
|
+
p data # => <SMSTollFreeCampaign>
|
2103
|
+
rescue Freeclimb::ApiError => e
|
2104
|
+
puts "Error when calling DefaultApi->get_toll_free_sms_campaign_with_http_info: #{e}"
|
2105
|
+
end
|
2106
|
+
```
|
2107
|
+
|
2108
|
+
### Parameters
|
2109
|
+
|
2110
|
+
| Name | Type | Description | Notes |
|
2111
|
+
| ---- | ---- | ----------- | ----- |
|
2112
|
+
|
2113
|
+
| **campaign_id** | **String** | String that uniquely identifies this TollFree Campaign resource. | |
|
2114
|
+
|
2115
|
+
|
2116
|
+
### Return type
|
2117
|
+
|
2118
|
+
[**SMSTollFreeCampaign**](SMSTollFreeCampaign.md)
|
2119
|
+
|
2120
|
+
### Authorization
|
2121
|
+
|
2122
|
+
[fc](../README.md#fc)
|
2123
|
+
|
2124
|
+
### HTTP request headers
|
2125
|
+
|
2126
|
+
- **Content-Type**: Not defined
|
2127
|
+
- **Accept**: application/json
|
2128
|
+
|
2129
|
+
|
2130
|
+
## get_toll_free_sms_campaigns
|
2131
|
+
|
2132
|
+
Get list of TollFree Campaigns
|
2133
|
+
|
2134
|
+
### Examples
|
2135
|
+
|
2136
|
+
```ruby
|
2137
|
+
require 'time'
|
2138
|
+
require 'freeclimb'
|
2139
|
+
# setup authorization
|
2140
|
+
Freeclimb.configure do |config|
|
2141
|
+
# Configure HTTP basic authorization: fc
|
2142
|
+
config.username = 'ACCOUNT_ID'
|
2143
|
+
config.password = 'API_KEY'
|
2144
|
+
end
|
2145
|
+
|
2146
|
+
api_instance = Freeclimb::DefaultApi.new
|
2147
|
+
|
2148
|
+
|
2149
|
+
begin
|
2150
|
+
|
2151
|
+
# Get list of TollFree Campaigns
|
2152
|
+
result = api_instance.get_toll_free_sms_campaigns()
|
2153
|
+
p result
|
2154
|
+
rescue Freeclimb::ApiError => e
|
2155
|
+
puts "Error when calling DefaultApi->get_toll_free_sms_campaigns: #{e}"
|
2156
|
+
end
|
2157
|
+
```
|
2158
|
+
|
2159
|
+
#### Using the get_toll_free_sms_campaigns_with_http_info variant
|
2160
|
+
|
2161
|
+
This returns an Array which contains the response data, status code and headers.
|
2162
|
+
|
2163
|
+
> <Array(<SMSTollFreeCampaignsListResult>, Integer, Hash)> get_toll_free_sms_campaigns_with_http_info(account_id)
|
2164
|
+
|
2165
|
+
```ruby
|
2166
|
+
begin
|
2167
|
+
# Get list of TollFree Campaigns
|
2168
|
+
data, status_code, headers = api_instance.get_toll_free_sms_campaigns_with_http_info()
|
2169
|
+
p status_code # => 2xx
|
2170
|
+
p headers # => { ... }
|
2171
|
+
p data # => <SMSTollFreeCampaignsListResult>
|
2172
|
+
rescue Freeclimb::ApiError => e
|
2173
|
+
puts "Error when calling DefaultApi->get_toll_free_sms_campaigns_with_http_info: #{e}"
|
2174
|
+
end
|
2175
|
+
```
|
2176
|
+
|
2177
|
+
### Parameters
|
2178
|
+
|
2179
|
+
| Name | Type | Description | Notes |
|
2180
|
+
| ---- | ---- | ----------- | ----- |
|
2181
|
+
|
2182
|
+
|
2183
|
+
### Return type
|
2184
|
+
|
2185
|
+
[**SMSTollFreeCampaignsListResult**](SMSTollFreeCampaignsListResult.md)
|
2186
|
+
|
2187
|
+
### Authorization
|
2188
|
+
|
2189
|
+
[fc](../README.md#fc)
|
2190
|
+
|
2191
|
+
### HTTP request headers
|
2192
|
+
|
2193
|
+
- **Content-Type**: Not defined
|
2194
|
+
- **Accept**: application/json
|
2195
|
+
|
2196
|
+
|
2055
2197
|
## list_active_queues
|
2056
2198
|
|
2057
2199
|
List Active Queues
|
@@ -2602,6 +2744,84 @@ end
|
|
2602
2744
|
- **Accept**: application/json
|
2603
2745
|
|
2604
2746
|
|
2747
|
+
## list_conference_recordings
|
2748
|
+
|
2749
|
+
List Conference Recordings
|
2750
|
+
|
2751
|
+
### Examples
|
2752
|
+
|
2753
|
+
```ruby
|
2754
|
+
require 'time'
|
2755
|
+
require 'freeclimb'
|
2756
|
+
# setup authorization
|
2757
|
+
Freeclimb.configure do |config|
|
2758
|
+
# Configure HTTP basic authorization: fc
|
2759
|
+
config.username = 'ACCOUNT_ID'
|
2760
|
+
config.password = 'API_KEY'
|
2761
|
+
end
|
2762
|
+
|
2763
|
+
api_instance = Freeclimb::DefaultApi.new
|
2764
|
+
|
2765
|
+
opts = {
|
2766
|
+
call_id: 'call_id_example', # String | Show only Recordings made during the Call with this ID.
|
2767
|
+
conference_id: 'conference_id_example', # String | Show only Recordings made during the conference with this ID.
|
2768
|
+
date_created: 'date_created_example' # String | Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
|
2769
|
+
}
|
2770
|
+
|
2771
|
+
begin
|
2772
|
+
|
2773
|
+
# List Conference Recordings
|
2774
|
+
result = api_instance.list_conference_recordings(opts)
|
2775
|
+
p result
|
2776
|
+
rescue Freeclimb::ApiError => e
|
2777
|
+
puts "Error when calling DefaultApi->list_conference_recordings: #{e}"
|
2778
|
+
end
|
2779
|
+
```
|
2780
|
+
|
2781
|
+
#### Using the list_conference_recordings_with_http_info variant
|
2782
|
+
|
2783
|
+
This returns an Array which contains the response data, status code and headers.
|
2784
|
+
|
2785
|
+
> <Array(<RecordingList>, Integer, Hash)> list_conference_recordings_with_http_info(account_id, opts)
|
2786
|
+
|
2787
|
+
```ruby
|
2788
|
+
begin
|
2789
|
+
# List Conference Recordings
|
2790
|
+
data, status_code, headers = api_instance.list_conference_recordings_with_http_info(opts)
|
2791
|
+
p status_code # => 2xx
|
2792
|
+
p headers # => { ... }
|
2793
|
+
p data # => <RecordingList>
|
2794
|
+
rescue Freeclimb::ApiError => e
|
2795
|
+
puts "Error when calling DefaultApi->list_conference_recordings_with_http_info: #{e}"
|
2796
|
+
end
|
2797
|
+
```
|
2798
|
+
|
2799
|
+
### Parameters
|
2800
|
+
|
2801
|
+
| Name | Type | Description | Notes |
|
2802
|
+
| ---- | ---- | ----------- | ----- |
|
2803
|
+
|
2804
|
+
| **call_id** | **String** | Show only Recordings made during the Call with this ID. | [optional] |
|
2805
|
+
|
2806
|
+
| **conference_id** | **String** | Show only Recordings made during the conference with this ID. | [optional] |
|
2807
|
+
|
2808
|
+
| **date_created** | **String** | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional] |
|
2809
|
+
|
2810
|
+
|
2811
|
+
### Return type
|
2812
|
+
|
2813
|
+
[**RecordingList**](RecordingList.md)
|
2814
|
+
|
2815
|
+
### Authorization
|
2816
|
+
|
2817
|
+
[fc](../README.md#fc)
|
2818
|
+
|
2819
|
+
### HTTP request headers
|
2820
|
+
|
2821
|
+
- **Content-Type**: Not defined
|
2822
|
+
- **Accept**: application/json
|
2823
|
+
|
2824
|
+
|
2605
2825
|
## list_conferences
|
2606
2826
|
|
2607
2827
|
List Conferences
|
@@ -2716,6 +2936,7 @@ opts = {
|
|
2716
2936
|
capabilities_toll_free: true, # Boolean |
|
2717
2937
|
capabilities_ten_dlc: true, # Boolean |
|
2718
2938
|
capabilities_short_code: true, # Boolean |
|
2939
|
+
tfn_campaign_id: 'tfn_campaign_id_example', # String | Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID.
|
2719
2940
|
offnet: true # Boolean | Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource.
|
2720
2941
|
}
|
2721
2942
|
|
@@ -2780,6 +3001,8 @@ end
|
|
2780
3001
|
|
2781
3002
|
| **capabilities_short_code** | **Boolean** | | [optional] |
|
2782
3003
|
|
3004
|
+
| **tfn_campaign_id** | **String** | Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID. | [optional] |
|
3005
|
+
|
2783
3006
|
| **offnet** | **Boolean** | Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource. | [optional] |
|
2784
3007
|
|
2785
3008
|
|
@@ -3190,6 +3413,79 @@ end
|
|
3190
3413
|
- **Accept**: application/json
|
3191
3414
|
|
3192
3415
|
|
3416
|
+
## make_a_webrtc_jwt
|
3417
|
+
|
3418
|
+
Make a JWT for WebRTC calling
|
3419
|
+
|
3420
|
+
Make a JWT for WebRTC calling
|
3421
|
+
|
3422
|
+
### Examples
|
3423
|
+
|
3424
|
+
```ruby
|
3425
|
+
require 'time'
|
3426
|
+
require 'freeclimb'
|
3427
|
+
# setup authorization
|
3428
|
+
Freeclimb.configure do |config|
|
3429
|
+
# Configure HTTP basic authorization: fc
|
3430
|
+
config.username = 'ACCOUNT_ID'
|
3431
|
+
config.password = 'API_KEY'
|
3432
|
+
end
|
3433
|
+
|
3434
|
+
api_instance = Freeclimb::DefaultApi.new
|
3435
|
+
|
3436
|
+
create_web_rtc_token = Freeclimb::CreateWebRTCToken.new({to: 'to_example', from: 'from_example', uses: 37}) # CreateWebRTCToken | Information needed to craft a JWT compatible with the platforms WebRTC APIs
|
3437
|
+
|
3438
|
+
|
3439
|
+
begin
|
3440
|
+
|
3441
|
+
# Make a JWT for WebRTC calling
|
3442
|
+
result = api_instance.make_a_webrtc_jwt(create_web_rtc_token)
|
3443
|
+
p result
|
3444
|
+
rescue Freeclimb::ApiError => e
|
3445
|
+
puts "Error when calling DefaultApi->make_a_webrtc_jwt: #{e}"
|
3446
|
+
end
|
3447
|
+
```
|
3448
|
+
|
3449
|
+
#### Using the make_a_webrtc_jwt_with_http_info variant
|
3450
|
+
|
3451
|
+
This returns an Array which contains the response data, status code and headers.
|
3452
|
+
|
3453
|
+
> <Array(String, Integer, Hash)> make_a_webrtc_jwt_with_http_info(account_id, create_web_rtc_token)
|
3454
|
+
|
3455
|
+
```ruby
|
3456
|
+
begin
|
3457
|
+
# Make a JWT for WebRTC calling
|
3458
|
+
data, status_code, headers = api_instance.make_a_webrtc_jwt_with_http_info(create_web_rtc_token)
|
3459
|
+
p status_code # => 2xx
|
3460
|
+
p headers # => { ... }
|
3461
|
+
p data # => String
|
3462
|
+
rescue Freeclimb::ApiError => e
|
3463
|
+
puts "Error when calling DefaultApi->make_a_webrtc_jwt_with_http_info: #{e}"
|
3464
|
+
end
|
3465
|
+
```
|
3466
|
+
|
3467
|
+
### Parameters
|
3468
|
+
|
3469
|
+
| Name | Type | Description | Notes |
|
3470
|
+
| ---- | ---- | ----------- | ----- |
|
3471
|
+
|
3472
|
+
| **create_web_rtc_token** | [**CreateWebRTCToken**](CreateWebRTCToken.md) | Information needed to craft a JWT compatible with the platforms WebRTC APIs | |
|
3473
|
+
|
3474
|
+
|
3475
|
+
### Return type
|
3476
|
+
|
3477
|
+
**String**
|
3478
|
+
|
3479
|
+
### Authorization
|
3480
|
+
|
3481
|
+
[fc](../README.md#fc)
|
3482
|
+
|
3483
|
+
### HTTP request headers
|
3484
|
+
|
3485
|
+
- **Content-Type**: application/json
|
3486
|
+
- **Accept**: text/plain
|
3487
|
+
|
3488
|
+
|
3193
3489
|
## remove_a_participant
|
3194
3490
|
|
3195
3491
|
Remove a Participant
|
@@ -3433,8 +3729,7 @@ opts = {
|
|
3433
3729
|
begin
|
3434
3730
|
|
3435
3731
|
# Update a Conference
|
3436
|
-
|
3437
|
-
p result
|
3732
|
+
api_instance.update_a_conference(conference_id, opts)
|
3438
3733
|
rescue Freeclimb::ApiError => e
|
3439
3734
|
puts "Error when calling DefaultApi->update_a_conference: #{e}"
|
3440
3735
|
end
|
@@ -3442,9 +3737,9 @@ end
|
|
3442
3737
|
|
3443
3738
|
#### Using the update_a_conference_with_http_info variant
|
3444
3739
|
|
3445
|
-
This returns an Array which contains the response data, status code and headers.
|
3740
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
3446
3741
|
|
3447
|
-
> <Array(
|
3742
|
+
> <Array(nil, Integer, Hash)> update_a_conference_with_http_info(account_id, conference_id, opts)
|
3448
3743
|
|
3449
3744
|
```ruby
|
3450
3745
|
begin
|
@@ -3452,7 +3747,7 @@ begin
|
|
3452
3747
|
data, status_code, headers = api_instance.update_a_conference_with_http_info(conference_id, opts)
|
3453
3748
|
p status_code # => 2xx
|
3454
3749
|
p headers # => { ... }
|
3455
|
-
p data # =>
|
3750
|
+
p data # => nil
|
3456
3751
|
rescue Freeclimb::ApiError => e
|
3457
3752
|
puts "Error when calling DefaultApi->update_a_conference_with_http_info: #{e}"
|
3458
3753
|
end
|
@@ -3470,7 +3765,7 @@ end
|
|
3470
3765
|
|
3471
3766
|
### Return type
|
3472
3767
|
|
3473
|
-
|
3768
|
+
nil (empty response body)
|
3474
3769
|
|
3475
3770
|
### Authorization
|
3476
3771
|
|
@@ -3479,7 +3774,7 @@ end
|
|
3479
3774
|
### HTTP request headers
|
3480
3775
|
|
3481
3776
|
- **Content-Type**: application/json
|
3482
|
-
- **Accept**:
|
3777
|
+
- **Accept**: Not defined
|
3483
3778
|
|
3484
3779
|
|
3485
3780
|
## update_a_live_call
|
data/docs/GetDigits.md
CHANGED
@@ -8,7 +8,7 @@
|
|
8
8
|
| **digit_timeout_ms** | **Integer** | Maximum time in milliseconds that FreeClimb will wait for the Caller to press any digit after the last digit entered, before making a determination that a `timeout` has occurred and moving on to make the request to the actionUrl to submit the results of the `GetDigits` command. This timeout interval begins and resets after each digit entered. | [optional] |
|
9
9
|
| **finish_on_key** | **String** | Digit that causes the input sequence to be deemed complete. This attribute defers to the `timeout` attribute – so, if a `timeout` occurs, then the command terminates regardless of the value of `finishOnKey`. | [optional] |
|
10
10
|
| **flush_buffer** | **Boolean** | If set to true, the FreeClimb platform starts with an empty DTMF buffer to store the digits entered by the caller. If set to false, FreeClimb will append the user inputs to the end of the existing digits buffer and will return digits from the start of the digits buffer. | [optional] |
|
11
|
-
| **initial_timeout_ms** | **
|
11
|
+
| **initial_timeout_ms** | **Integer** | Maximum time in milliseconds that FreeClimb will wait for the Caller to press the first digit before making a determination that a `timeout` has occurred and moving on to make the request to the `actionUrl` to submit the results of the `GetDigits` command. This timeout interval begins when all nested commands have been fully executed. | [optional] |
|
12
12
|
| **max_digits** | **Integer** | Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the `GetDigits` command terminates regardless of the value of `finishOnKey`. | [optional] |
|
13
13
|
| **min_digits** | **Integer** | Minimum number of digits expected in the input. If specified, FreeClimb will return the collected digits only if the Caller has entered at least that many digits. | [optional] |
|
14
14
|
| **prompts** | [**Array<PerclCommand>**](PerclCommand.md) | JSON array of PerCL commands to nest within the `GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller. | [optional] |
|
data/docs/GetDigitsAllOf.md
CHANGED
@@ -8,7 +8,7 @@
|
|
8
8
|
| **digit_timeout_ms** | **Integer** | Maximum time in milliseconds that FreeClimb will wait for the Caller to press any digit after the last digit entered, before making a determination that a `timeout` has occurred and moving on to make the request to the actionUrl to submit the results of the `GetDigits` command. This timeout interval begins and resets after each digit entered. | [optional] |
|
9
9
|
| **finish_on_key** | **String** | Digit that causes the input sequence to be deemed complete. This attribute defers to the `timeout` attribute – so, if a `timeout` occurs, then the command terminates regardless of the value of `finishOnKey`. | [optional] |
|
10
10
|
| **flush_buffer** | **Boolean** | If set to true, the FreeClimb platform starts with an empty DTMF buffer to store the digits entered by the caller. If set to false, FreeClimb will append the user inputs to the end of the existing digits buffer and will return digits from the start of the digits buffer. | [optional] |
|
11
|
-
| **initial_timeout_ms** | **
|
11
|
+
| **initial_timeout_ms** | **Integer** | Maximum time in milliseconds that FreeClimb will wait for the Caller to press the first digit before making a determination that a `timeout` has occurred and moving on to make the request to the `actionUrl` to submit the results of the `GetDigits` command. This timeout interval begins when all nested commands have been fully executed. | [optional] |
|
12
12
|
| **max_digits** | **Integer** | Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the `GetDigits` command terminates regardless of the value of `finishOnKey`. | [optional] |
|
13
13
|
| **min_digits** | **Integer** | Minimum number of digits expected in the input. If specified, FreeClimb will return the collected digits only if the Caller has entered at least that many digits. | [optional] |
|
14
14
|
| **prompts** | [**Array<PerclCommand>**](PerclCommand.md) | JSON array of PerCL commands to nest within the `GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller. | [optional] |
|
@@ -20,6 +20,7 @@
|
|
20
20
|
| **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] |
|
21
21
|
| **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] |
|
22
22
|
| **offnet** | **Boolean** | The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource. | [optional] |
|
23
|
+
| **tfn** | [**TFN**](TFN.md) | | [optional] |
|
23
24
|
|
24
25
|
## Example
|
25
26
|
|
@@ -42,7 +43,8 @@ instance = Freeclimb::IncomingNumberResult.new(
|
|
42
43
|
country: null,
|
43
44
|
voice_enabled: null,
|
44
45
|
sms_enabled: null,
|
45
|
-
offnet: null
|
46
|
+
offnet: null,
|
47
|
+
tfn: null
|
46
48
|
)
|
47
49
|
```
|
48
50
|
|
@@ -16,6 +16,7 @@
|
|
16
16
|
| **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] |
|
17
17
|
| **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] |
|
18
18
|
| **offnet** | **Boolean** | The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource. | [optional] |
|
19
|
+
| **tfn** | [**TFN**](TFN.md) | | [optional] |
|
19
20
|
|
20
21
|
## Example
|
21
22
|
|
@@ -34,7 +35,8 @@ instance = Freeclimb::IncomingNumberResultAllOf.new(
|
|
34
35
|
country: null,
|
35
36
|
voice_enabled: null,
|
36
37
|
sms_enabled: null,
|
37
|
-
offnet: null
|
38
|
+
offnet: null,
|
39
|
+
tfn: null
|
38
40
|
)
|
39
41
|
```
|
40
42
|
|
data/docs/MessageRequest.md
CHANGED
@@ -12,7 +12,7 @@
|
|
12
12
|
| **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. | |
|
13
13
|
| **text** | **String** | Text contained in the message (maximum 160 characters). **Note:** For text, only ASCII characters are supported. | |
|
14
14
|
| **notification_url** | **String** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored. | [optional] |
|
15
|
-
| **
|
15
|
+
| **media_urls** | **Array<String>** | an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile. | [optional] |
|
16
16
|
|
17
17
|
## Example
|
18
18
|
|
@@ -28,7 +28,7 @@ instance = Freeclimb::MessageRequest.new(
|
|
28
28
|
to: null,
|
29
29
|
text: null,
|
30
30
|
notification_url: null,
|
31
|
-
|
31
|
+
media_urls: null
|
32
32
|
)
|
33
33
|
```
|
34
34
|
|
data/docs/MessageRequestAllOf.md
CHANGED
@@ -8,7 +8,7 @@
|
|
8
8
|
| **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. | |
|
9
9
|
| **text** | **String** | Text contained in the message (maximum 160 characters). **Note:** For text, only ASCII characters are supported. | |
|
10
10
|
| **notification_url** | **String** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored. | [optional] |
|
11
|
-
| **
|
11
|
+
| **media_urls** | **Array<String>** | an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile. | [optional] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
@@ -20,7 +20,7 @@ instance = Freeclimb::MessageRequestAllOf.new(
|
|
20
20
|
to: null,
|
21
21
|
text: null,
|
22
22
|
notification_url: null,
|
23
|
-
|
23
|
+
media_urls: null
|
24
24
|
)
|
25
25
|
```
|
26
26
|
|
data/docs/MessageResult.md
CHANGED
@@ -19,6 +19,7 @@
|
|
19
19
|
| **brand_id** | **String** | The unique identifier for the brand associated with the message | [optional] |
|
20
20
|
| **campaign_id** | **String** | The unique identifier for the campaign associated with the message | [optional] |
|
21
21
|
| **segment_count** | **Float** | The number of segments into which the message was split | [optional] |
|
22
|
+
| **media_urls** | **Array<String>** | an array of HTTP URLs which were attached this this message | [optional] |
|
22
23
|
|
23
24
|
## Example
|
24
25
|
|
@@ -40,7 +41,8 @@ instance = Freeclimb::MessageResult.new(
|
|
40
41
|
notification_url: null,
|
41
42
|
brand_id: null,
|
42
43
|
campaign_id: null,
|
43
|
-
segment_count: null
|
44
|
+
segment_count: null,
|
45
|
+
media_urls: null
|
44
46
|
)
|
45
47
|
```
|
46
48
|
|
data/docs/MessageResultAllOf.md
CHANGED
@@ -15,6 +15,7 @@
|
|
15
15
|
| **brand_id** | **String** | The unique identifier for the brand associated with the message | [optional] |
|
16
16
|
| **campaign_id** | **String** | The unique identifier for the campaign associated with the message | [optional] |
|
17
17
|
| **segment_count** | **Float** | The number of segments into which the message was split | [optional] |
|
18
|
+
| **media_urls** | **Array<String>** | an array of HTTP URLs which were attached this this message | [optional] |
|
18
19
|
|
19
20
|
## Example
|
20
21
|
|
@@ -32,7 +33,8 @@ instance = Freeclimb::MessageResultAllOf.new(
|
|
32
33
|
notification_url: null,
|
33
34
|
brand_id: null,
|
34
35
|
campaign_id: null,
|
35
|
-
segment_count: null
|
36
|
+
segment_count: null,
|
37
|
+
media_urls: null
|
36
38
|
)
|
37
39
|
```
|
38
40
|
|
data/docs/Play.md
CHANGED
@@ -6,7 +6,6 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **file** | **String** | RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands. | |
|
8
8
|
| **loop** | **Integer** | Number of times the audio file is played. Specifying '0' causes the Play action to loop until the Call is hung up. | [optional] |
|
9
|
-
| **conference_id** | **String** | ID of the Conference the audio should be rendered to. If this is not specified, the audio is by default rendered to the caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional] |
|
10
9
|
| **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
|
11
10
|
|
12
11
|
## Example
|
@@ -17,7 +16,6 @@ require 'freeclimb'
|
|
17
16
|
instance = Freeclimb::Play.new(
|
18
17
|
file: null,
|
19
18
|
loop: null,
|
20
|
-
conference_id: null,
|
21
19
|
privacy_mode: null
|
22
20
|
)
|
23
21
|
```
|
data/docs/PlayAllOf.md
CHANGED
@@ -6,7 +6,6 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **file** | **String** | RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands. | |
|
8
8
|
| **loop** | **Integer** | Number of times the audio file is played. Specifying '0' causes the Play action to loop until the Call is hung up. | [optional] |
|
9
|
-
| **conference_id** | **String** | ID of the Conference the audio should be rendered to. If this is not specified, the audio is by default rendered to the caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional] |
|
10
9
|
| **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
|
11
10
|
|
12
11
|
## Example
|
@@ -17,7 +16,6 @@ require 'freeclimb'
|
|
17
16
|
instance = Freeclimb::PlayAllOf.new(
|
18
17
|
file: null,
|
19
18
|
loop: null,
|
20
|
-
conference_id: null,
|
21
19
|
privacy_mode: null
|
22
20
|
)
|
23
21
|
```
|
@@ -4,15 +4,12 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **call_id** | **String** | ID of the Call leg to be removed from the Conference. The Call must be in a Conference or an error will be triggered. | |
|
8
7
|
|
9
8
|
## Example
|
10
9
|
|
11
10
|
```ruby
|
12
11
|
require 'freeclimb'
|
13
12
|
|
14
|
-
instance = Freeclimb::RemoveFromConference
|
15
|
-
call_id: null
|
16
|
-
)
|
13
|
+
instance = Freeclimb::RemoveFromConference::[NAME OF ENUM]
|
17
14
|
```
|
18
15
|
|
data/docs/SMSTenDLCCampaign.md
CHANGED
@@ -32,6 +32,11 @@
|
|
32
32
|
| **sample5** | **String** | Message sample. Some campaign tiers require 5 or more message samples. | [optional] |
|
33
33
|
| **message_flow** | **String** | Message flow description. | [optional] |
|
34
34
|
| **help_message** | **String** | Help message of the campaign. | [optional] |
|
35
|
+
| **optin_keywords** | **String** | Subscriber opt-in keywords. Multiple keywords are comma separated without space. | [optional] |
|
36
|
+
| **optout_keywords** | **String** | Subscriber opt-out keywords. Multiple keywords are comma separated without space. | [optional] |
|
37
|
+
| **help_keywords** | **String** | Subscriber help keywords. Multiple keywords are comma separated without space. | [optional] |
|
38
|
+
| **optin_message** | **String** | Subscriber opt-in message. | [optional] |
|
39
|
+
| **optout_message** | **String** | Subscriber opt-out message. | [optional] |
|
35
40
|
| **reference_id** | **String** | Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. | [optional] |
|
36
41
|
| **mock** | **Boolean** | Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP. | |
|
37
42
|
| **next_renewal_or_expiration_date** | **Date** | When the campaign would be due for its next renew/bill date. | [optional] |
|
@@ -70,6 +75,11 @@ instance = Freeclimb::SMSTenDLCCampaign.new(
|
|
70
75
|
sample5: null,
|
71
76
|
message_flow: null,
|
72
77
|
help_message: null,
|
78
|
+
optin_keywords: null,
|
79
|
+
optout_keywords: null,
|
80
|
+
help_keywords: null,
|
81
|
+
optin_message: null,
|
82
|
+
optout_message: null,
|
73
83
|
reference_id: null,
|
74
84
|
mock: null,
|
75
85
|
next_renewal_or_expiration_date: Fri Dec 31 19:00:00 EST 1999
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# Freeclimb::SMSTollFreeCampaign
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **account_id** | **String** | ID of the account that created this toll-free campaign | |
|
8
|
+
| **campaign_id** | **String** | Alphanumeric identifier used by the platform to identify this toll-free campaign | |
|
9
|
+
| **use_case** | **String** | | |
|
10
|
+
| **registration_status** | **String** | Current toll-free campaign registration status.Possible values: UNREGISTERED,INITIATED,PENDING,DECLINED,REGISTERED. A newly created campaign defaults to INITIATED status. | |
|
11
|
+
| **date_created** | **String** | | |
|
12
|
+
| **date_updated** | **String** | | |
|
13
|
+
| **revision** | **Integer** | | |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'freeclimb'
|
19
|
+
|
20
|
+
instance = Freeclimb::SMSTollFreeCampaign.new(
|
21
|
+
account_id: null,
|
22
|
+
campaign_id: null,
|
23
|
+
use_case: null,
|
24
|
+
registration_status: null,
|
25
|
+
date_created: null,
|
26
|
+
date_updated: null,
|
27
|
+
revision: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# Freeclimb::SMSTollFreeCampaignsListResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **total** | **Integer** | Total amount of requested resource. | [optional] |
|
8
|
+
| **start** | **Integer** | Resource index at start of current page | [optional] |
|
9
|
+
| **_end** | **Integer** | Resource index at end of current page | [optional] |
|
10
|
+
| **page** | **Integer** | Current page | [optional] |
|
11
|
+
| **num_pages** | **Integer** | Total number of pages | [optional] |
|
12
|
+
| **page_size** | **Integer** | Number of items per page | [optional] |
|
13
|
+
| **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
|
14
|
+
| **brands** | [**Array<SMSTollFreeCampaign>**](SMSTollFreeCampaign.md) | | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'freeclimb'
|
20
|
+
|
21
|
+
instance = Freeclimb::SMSTollFreeCampaignsListResult.new(
|
22
|
+
total: null,
|
23
|
+
start: null,
|
24
|
+
_end: null,
|
25
|
+
page: null,
|
26
|
+
num_pages: null,
|
27
|
+
page_size: null,
|
28
|
+
next_page_uri: null,
|
29
|
+
brands: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|