freeclimb 4.5.2 → 4.6.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (183) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +15 -7
  5. data/docs/AddToConference.md +0 -2
  6. data/docs/AddToConferenceAllOf.md +0 -2
  7. data/docs/CreateWebRTCToken.md +22 -0
  8. data/docs/DefaultApi.md +303 -7
  9. data/docs/GetDigits.md +1 -1
  10. data/docs/GetDigitsAllOf.md +1 -1
  11. data/docs/IncomingNumberResult.md +3 -1
  12. data/docs/IncomingNumberResultAllOf.md +3 -1
  13. data/docs/MessageRequest.md +2 -2
  14. data/docs/MessageRequestAllOf.md +2 -2
  15. data/docs/MessageResult.md +3 -1
  16. data/docs/MessageResultAllOf.md +3 -1
  17. data/docs/Play.md +0 -2
  18. data/docs/PlayAllOf.md +0 -2
  19. data/docs/RemoveFromConference.md +1 -4
  20. data/docs/SMSTenDLCCampaign.md +10 -0
  21. data/docs/SMSTollFreeCampaign.md +30 -0
  22. data/docs/SMSTollFreeCampaignsListResult.md +32 -0
  23. data/docs/SMSTollFreeCampaignsListResultAllOf.md +18 -0
  24. data/docs/Say.md +0 -2
  25. data/docs/SayAllOf.md +0 -2
  26. data/docs/SetListen.md +0 -2
  27. data/docs/SetListenAllOf.md +0 -2
  28. data/docs/SetTalk.md +0 -2
  29. data/docs/SetTalkAllOf.md +0 -2
  30. data/docs/TFN.md +18 -0
  31. data/docs/TerminateConference.md +1 -4
  32. data/docs/TranscribeUtterance.md +1 -1
  33. data/docs/TranscribeUtteranceAllOf.md +28 -0
  34. data/docs/TranscribeUtteranceAllOfRecord.md +22 -0
  35. data/lib/freeclimb/api/default_api.rb +262 -7
  36. data/lib/freeclimb/models/account_request.rb +0 -2
  37. data/lib/freeclimb/models/account_result.rb +0 -6
  38. data/lib/freeclimb/models/add_to_conference.rb +1 -29
  39. data/lib/freeclimb/models/add_to_conference_all_of.rb +1 -29
  40. data/lib/freeclimb/models/application_result.rb +0 -6
  41. data/lib/freeclimb/models/buy_incoming_number_request.rb +0 -4
  42. data/lib/freeclimb/models/call_result.rb +0 -6
  43. data/lib/freeclimb/models/conference_participant_result.rb +0 -6
  44. data/lib/freeclimb/models/conference_result.rb +0 -6
  45. data/lib/freeclimb/models/create_conference.rb +0 -8
  46. data/lib/freeclimb/models/create_conference_all_of.rb +0 -8
  47. data/lib/freeclimb/models/create_conference_request.rb +0 -6
  48. data/lib/freeclimb/models/create_web_rtc_token.rb +274 -0
  49. data/lib/freeclimb/models/dequeue.rb +1 -0
  50. data/lib/freeclimb/models/enqueue.rb +0 -6
  51. data/lib/freeclimb/models/enqueue_all_of.rb +0 -6
  52. data/lib/freeclimb/models/get_digits.rb +1 -17
  53. data/lib/freeclimb/models/get_digits_all_of.rb +1 -17
  54. data/lib/freeclimb/models/get_speech.rb +0 -22
  55. data/lib/freeclimb/models/get_speech_all_of.rb +0 -22
  56. data/lib/freeclimb/models/incoming_number_request.rb +0 -2
  57. data/lib/freeclimb/models/incoming_number_result.rb +14 -13
  58. data/lib/freeclimb/models/incoming_number_result_all_of.rb +14 -5
  59. data/lib/freeclimb/models/make_call_request.rb +0 -18
  60. data/lib/freeclimb/models/message_request.rb +10 -24
  61. data/lib/freeclimb/models/message_request_all_of.rb +10 -16
  62. data/lib/freeclimb/models/message_result.rb +17 -11
  63. data/lib/freeclimb/models/message_result_all_of.rb +17 -5
  64. data/lib/freeclimb/models/mutable_resource_model.rb +0 -6
  65. data/lib/freeclimb/models/out_dial.rb +0 -18
  66. data/lib/freeclimb/models/out_dial_all_of.rb +0 -18
  67. data/lib/freeclimb/models/park.rb +0 -4
  68. data/lib/freeclimb/models/park_all_of.rb +0 -4
  69. data/lib/freeclimb/models/play.rb +1 -17
  70. data/lib/freeclimb/models/play_all_of.rb +1 -17
  71. data/lib/freeclimb/models/queue_request.rb +0 -2
  72. data/lib/freeclimb/models/queue_result.rb +0 -6
  73. data/lib/freeclimb/models/record_utterance.rb +0 -12
  74. data/lib/freeclimb/models/record_utterance_all_of.rb +0 -12
  75. data/lib/freeclimb/models/recording_result.rb +0 -6
  76. data/lib/freeclimb/models/remove_from_conference.rb +4 -23
  77. data/lib/freeclimb/models/say.rb +1 -19
  78. data/lib/freeclimb/models/say_all_of.rb +1 -19
  79. data/lib/freeclimb/models/send_digits.rb +0 -4
  80. data/lib/freeclimb/models/send_digits_all_of.rb +0 -4
  81. data/lib/freeclimb/models/set_listen.rb +2 -18
  82. data/lib/freeclimb/models/set_listen_all_of.rb +2 -18
  83. data/lib/freeclimb/models/set_talk.rb +2 -18
  84. data/lib/freeclimb/models/set_talk_all_of.rb +2 -18
  85. data/lib/freeclimb/models/sms.rb +0 -6
  86. data/lib/freeclimb/models/sms_all_of.rb +0 -6
  87. data/lib/freeclimb/models/sms_ten_dlc_brand.rb +0 -60
  88. data/lib/freeclimb/models/sms_ten_dlc_campaign.rb +121 -41
  89. data/lib/freeclimb/models/sms_ten_dlc_partner_campaign.rb +0 -44
  90. data/lib/freeclimb/models/sms_ten_dlc_partner_campaign_brand.rb +0 -20
  91. data/lib/freeclimb/models/sms_toll_free_campaign.rb +337 -0
  92. data/lib/freeclimb/models/sms_toll_free_campaigns_list_result.rb +311 -0
  93. data/lib/freeclimb/models/{remove_from_conference_all_of.rb → sms_toll_free_campaigns_list_result_all_of.rb} +14 -16
  94. data/lib/freeclimb/models/start_record_call.rb +1 -0
  95. data/lib/freeclimb/models/terminate_conference.rb +4 -23
  96. data/lib/freeclimb/models/{terminate_conference_all_of.rb → tfn.rb} +15 -14
  97. data/lib/freeclimb/models/transcribe_utterance.rb +11 -16
  98. data/lib/freeclimb/models/transcribe_utterance_all_of.rb +281 -0
  99. data/lib/freeclimb/models/{transcribe_utterance_record.rb → transcribe_utterance_all_of_record.rb} +3 -7
  100. data/lib/freeclimb/models/unpark.rb +1 -0
  101. data/lib/freeclimb/models/update_conference_participant_request.rb +0 -2
  102. data/lib/freeclimb/models/update_conference_request.rb +0 -2
  103. data/lib/freeclimb/version.rb +1 -1
  104. data/lib/freeclimb.rb +8 -4
  105. data/openapi.json +407 -88
  106. data/package.json +8 -0
  107. data/spec/api/default_api_spec.rb +215 -55
  108. data/spec/models/account_request_spec.rb +8 -6
  109. data/spec/models/account_result_spec.rb +28 -9
  110. data/spec/models/add_to_conference_spec.rb +21 -37
  111. data/spec/models/application_list_spec.rb +46 -22
  112. data/spec/models/application_request_spec.rb +13 -6
  113. data/spec/models/application_result_spec.rb +24 -9
  114. data/spec/models/available_number_list_spec.rb +46 -22
  115. data/spec/models/available_number_spec.rb +23 -10
  116. data/spec/models/buy_incoming_number_request_spec.rb +11 -7
  117. data/spec/models/call_list_spec.rb +46 -22
  118. data/spec/models/call_result_spec.rb +49 -15
  119. data/spec/models/capabilities_spec.rb +26 -11
  120. data/spec/models/conference_list_spec.rb +46 -22
  121. data/spec/models/conference_participant_list_spec.rb +46 -22
  122. data/spec/models/conference_participant_result_spec.rb +24 -9
  123. data/spec/models/conference_result_spec.rb +32 -9
  124. data/spec/models/create_conference_request_spec.rb +15 -6
  125. data/spec/models/create_conference_spec.rb +19 -7
  126. data/spec/models/create_web_rtc_token_spec.rb +231 -0
  127. data/spec/models/enqueue_spec.rb +16 -9
  128. data/spec/models/filter_logs_request_spec.rb +9 -7
  129. data/spec/models/get_digits_spec.rb +59 -35
  130. data/spec/models/get_speech_spec.rb +60 -24
  131. data/spec/models/hangup_spec.rb +7 -6
  132. data/spec/models/incoming_number_list_spec.rb +46 -22
  133. data/spec/models/incoming_number_request_spec.rb +9 -6
  134. data/spec/models/incoming_number_result_spec.rb +68 -13
  135. data/spec/models/log_list_spec.rb +46 -22
  136. data/spec/models/log_result_spec.rb +21 -9
  137. data/spec/models/make_call_request_spec.rb +26 -11
  138. data/spec/models/message_request_spec.rb +49 -35
  139. data/spec/models/message_result_spec.rb +64 -11
  140. data/spec/models/messages_list_spec.rb +46 -22
  141. data/spec/models/mutable_resource_model_spec.rb +15 -9
  142. data/spec/models/out_dial_spec.rb +33 -13
  143. data/spec/models/pagination_model_spec.rb +40 -21
  144. data/spec/models/park_spec.rb +13 -8
  145. data/spec/models/pause_spec.rb +14 -10
  146. data/spec/models/percl_command_spec.rb +6 -6
  147. data/spec/models/percl_script_spec.rb +11 -6
  148. data/spec/models/play_early_media_spec.rb +9 -7
  149. data/spec/models/play_spec.rb +17 -40
  150. data/spec/models/queue_list_spec.rb +46 -22
  151. data/spec/models/queue_member_list_spec.rb +46 -22
  152. data/spec/models/queue_member_spec.rb +21 -12
  153. data/spec/models/queue_request_spec.rb +13 -9
  154. data/spec/models/queue_result_spec.rb +37 -18
  155. data/spec/models/record_utterance_spec.rb +28 -13
  156. data/spec/models/recording_list_spec.rb +46 -22
  157. data/spec/models/recording_result_spec.rb +25 -12
  158. data/spec/models/redirect_spec.rb +9 -7
  159. data/spec/models/reject_spec.rb +7 -6
  160. data/spec/models/remove_from_conference_spec.rb +0 -133
  161. data/spec/models/say_spec.rb +18 -40
  162. data/spec/models/send_digits_spec.rb +17 -10
  163. data/spec/models/set_listen_spec.rb +8 -37
  164. data/spec/models/set_talk_spec.rb +8 -37
  165. data/spec/models/sms_spec.rb +16 -9
  166. data/spec/models/sms_ten_dlc_brand_spec.rb +38 -4
  167. data/spec/models/sms_ten_dlc_brands_list_result_spec.rb +46 -22
  168. data/spec/models/sms_ten_dlc_campaign_spec.rb +228 -4
  169. data/spec/models/sms_ten_dlc_campaigns_list_result_spec.rb +46 -22
  170. data/spec/models/sms_ten_dlc_partner_campaign_brand_spec.rb +25 -7
  171. data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +56 -8
  172. data/spec/models/sms_ten_dlc_partner_campaigns_list_result_spec.rb +46 -22
  173. data/spec/models/sms_toll_free_campaign_spec.rb +382 -0
  174. data/spec/models/sms_toll_free_campaigns_list_result_spec.rb +395 -0
  175. data/spec/models/terminate_conference_spec.rb +0 -133
  176. data/spec/models/tfn_spec.rb +164 -0
  177. data/spec/models/{transcribe_utterance_record_spec.rb → transcribe_utterance_all_of_record_spec.rb} +78 -67
  178. data/spec/models/transcribe_utterance_spec.rb +37 -96
  179. data/spec/models/update_call_request_spec.rb +12 -7
  180. data/spec/models/update_conference_participant_request_spec.rb +10 -6
  181. data/spec/models/update_conference_request_spec.rb +15 -6
  182. data/yarn.lock +1292 -0
  183. metadata +105 -84
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7892913f9919cdb4f097852f58fff33055aca7f960c31789687fde928b207039
4
- data.tar.gz: 1f006eb508f1f35f01440d155a9a4970a0ebf2aaf86bcce5a66ad72fa40b8cb9
3
+ metadata.gz: 814c7a58b3021f56bc05b205c8120514fc752ea62cb37ee660bfd6062b736164
4
+ data.tar.gz: d2b806037bd75dde4d8f32dbc00118706db4ee2e8fe1155e0077edd5e467f036
5
5
  SHA512:
6
- metadata.gz: b8c21bfd5390e6d3ef77b5e194038742f5bac190d9ea1c5d6d107941523393afdabeeeba174ac335cc880288b20397595dadd772518a2c9948db5386ecb658fd
7
- data.tar.gz: 75c0ed125218eb861047db684bb1a33ef5cc868f827978f5f96c12305f268438f14f7471d1518700edf0c88dabec32ffe192bbbfe1082eb7f1d1d099b7ec03ad
6
+ metadata.gz: 4c9e59188c48065ef0228c2c19a1b8438303cd6bd7169e56a1de58daaf7e6e94e06c796f94c9a5c4e856a7d6f795268bcc518cd067b537c32c094f04d3e0179f
7
+ data.tar.gz: cbd6aa3ba61ddd3e959d8ec497ef74eb3314fdda1c5fd53ec28e11eb52d43de359ff51cfbcb9b2013f7cf8c1701e5a58be1ce3c5bff89bbaad456341e7ee8858
data/CHANGELOG.md CHANGED
@@ -9,6 +9,26 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
9
9
 
10
10
  None
11
11
 
12
+ <a name="4.6.1"></a>
13
+
14
+ ## [4.6.1] - 2024-07-24
15
+
16
+ ### Changed
17
+
18
+ - Fix test file format and some value updates, also fix SDK file auto-generation issue
19
+
20
+ <a name="4.6.0"></a>
21
+
22
+ ## [4.6.0] - 2024-07-19
23
+
24
+ ### Changed
25
+
26
+ - GetDigit initialTimeoutMS property type change from string to integer
27
+
28
+ ### Removed
29
+
30
+ - Removal of deprecated percl fields
31
+
12
32
  <a name="4.5.2"></a>
13
33
 
14
34
  ## [4.5.2] - 2024-04-09
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- freeclimb (4.5.2)
4
+ freeclimb (4.6.1)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -7,7 +7,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 1.0.0
10
- - Package version: 4.5.2
10
+ - Package version: 4.6.1
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
13
13
 
@@ -15,7 +15,7 @@ For more information, please visit [https://www.freeclimb.com/support/](https://
15
15
 
16
16
  Add this to the Gemfile:
17
17
 
18
- gem 'freeclimb', '~> 4.5.2'
18
+ gem 'freeclimb', '~> 4.6.1'
19
19
 
20
20
  and run from your terminal
21
21
 
@@ -44,9 +44,9 @@ gem build freeclimb.gemspec
44
44
  Then either install the gem locally:
45
45
 
46
46
  ```shell
47
- gem install ./freeclimb-4.5.2.gem
47
+ gem install ./freeclimb-4.6.1.gem
48
48
  ```
49
- (for development, run `gem install --dev ./freeclimb-4.5.2.gem` to install the development dependencies)
49
+ (for development, run `gem install --dev ./freeclimb-4.6.1.gem` to install the development dependencies)
50
50
 
51
51
  ## Getting Started
52
52
 
@@ -127,6 +127,8 @@ Class | Method | HTTP request | Description
127
127
  *Freeclimb::DefaultApi* | [**get_ten_dlc_sms_campaigns**](docs/DefaultApi.md#get_ten_dlc_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns | Get list of SMS 10DLC Campaigns
128
128
  *Freeclimb::DefaultApi* | [**get_ten_dlc_sms_partner_campaign**](docs/DefaultApi.md#get_ten_dlc_sms_partner_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId} | Get a 10DLC SMS Partner Campaign
129
129
  *Freeclimb::DefaultApi* | [**get_ten_dlc_sms_partner_campaigns**](docs/DefaultApi.md#get_ten_dlc_sms_partner_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns | Get list of SMS 10DLC Partner Campaigns
130
+ *Freeclimb::DefaultApi* | [**get_toll_free_sms_campaign**](docs/DefaultApi.md#get_toll_free_sms_campaign) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId} | Get a TollFree SMS Campaign
131
+ *Freeclimb::DefaultApi* | [**get_toll_free_sms_campaigns**](docs/DefaultApi.md#get_toll_free_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns | Get list of TollFree Campaigns
130
132
  *Freeclimb::DefaultApi* | [**list_active_queues**](docs/DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues
131
133
  *Freeclimb::DefaultApi* | [**list_all_account_logs**](docs/DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs
132
134
  *Freeclimb::DefaultApi* | [**list_applications**](docs/DefaultApi.md#list_applications) | **GET** /Accounts/{accountId}/Applications | List applications
@@ -134,6 +136,7 @@ Class | Method | HTTP request | Description
134
136
  *Freeclimb::DefaultApi* | [**list_call_logs**](docs/DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs
135
137
  *Freeclimb::DefaultApi* | [**list_call_recordings**](docs/DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings
136
138
  *Freeclimb::DefaultApi* | [**list_calls**](docs/DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls
139
+ *Freeclimb::DefaultApi* | [**list_conference_recordings**](docs/DefaultApi.md#list_conference_recordings) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Recordings | List Conference Recordings
137
140
  *Freeclimb::DefaultApi* | [**list_conferences**](docs/DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences
138
141
  *Freeclimb::DefaultApi* | [**list_incoming_numbers**](docs/DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers
139
142
  *Freeclimb::DefaultApi* | [**list_members**](docs/DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members
@@ -141,6 +144,7 @@ Class | Method | HTTP request | Description
141
144
  *Freeclimb::DefaultApi* | [**list_recordings**](docs/DefaultApi.md#list_recordings) | **GET** /Accounts/{accountId}/Recordings | List Recordings
142
145
  *Freeclimb::DefaultApi* | [**list_sms_messages**](docs/DefaultApi.md#list_sms_messages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages
143
146
  *Freeclimb::DefaultApi* | [**make_a_call**](docs/DefaultApi.md#make_a_call) | **POST** /Accounts/{accountId}/Calls | Make a Call
147
+ *Freeclimb::DefaultApi* | [**make_a_webrtc_jwt**](docs/DefaultApi.md#make_a_webrtc_jwt) | **POST** /Accounts/{accountId}/Calls/WebRTC/Token | Make a JWT for WebRTC calling
144
148
  *Freeclimb::DefaultApi* | [**remove_a_participant**](docs/DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant
145
149
  *Freeclimb::DefaultApi* | [**send_an_sms_message**](docs/DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message
146
150
  *Freeclimb::DefaultApi* | [**stream_a_recording_file**](docs/DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File
@@ -191,6 +195,7 @@ Class | Method | HTTP request | Description
191
195
  - [Freeclimb::CreateConference](docs/CreateConference.md)
192
196
  - [Freeclimb::CreateConferenceAllOf](docs/CreateConferenceAllOf.md)
193
197
  - [Freeclimb::CreateConferenceRequest](docs/CreateConferenceRequest.md)
198
+ - [Freeclimb::CreateWebRTCToken](docs/CreateWebRTCToken.md)
194
199
  - [Freeclimb::Dequeue](docs/Dequeue.md)
195
200
  - [Freeclimb::Enqueue](docs/Enqueue.md)
196
201
  - [Freeclimb::EnqueueAllOf](docs/EnqueueAllOf.md)
@@ -261,7 +266,6 @@ Class | Method | HTTP request | Description
261
266
  - [Freeclimb::Reject](docs/Reject.md)
262
267
  - [Freeclimb::RejectAllOf](docs/RejectAllOf.md)
263
268
  - [Freeclimb::RemoveFromConference](docs/RemoveFromConference.md)
264
- - [Freeclimb::RemoveFromConferenceAllOf](docs/RemoveFromConferenceAllOf.md)
265
269
  - [Freeclimb::RequestType](docs/RequestType.md)
266
270
  - [Freeclimb::SMSTenDLCBrand](docs/SMSTenDLCBrand.md)
267
271
  - [Freeclimb::SMSTenDLCBrandsListResult](docs/SMSTenDLCBrandsListResult.md)
@@ -273,6 +277,9 @@ Class | Method | HTTP request | Description
273
277
  - [Freeclimb::SMSTenDLCPartnerCampaignBrand](docs/SMSTenDLCPartnerCampaignBrand.md)
274
278
  - [Freeclimb::SMSTenDLCPartnerCampaignsListResult](docs/SMSTenDLCPartnerCampaignsListResult.md)
275
279
  - [Freeclimb::SMSTenDLCPartnerCampaignsListResultAllOf](docs/SMSTenDLCPartnerCampaignsListResultAllOf.md)
280
+ - [Freeclimb::SMSTollFreeCampaign](docs/SMSTollFreeCampaign.md)
281
+ - [Freeclimb::SMSTollFreeCampaignsListResult](docs/SMSTollFreeCampaignsListResult.md)
282
+ - [Freeclimb::SMSTollFreeCampaignsListResultAllOf](docs/SMSTollFreeCampaignsListResultAllOf.md)
276
283
  - [Freeclimb::Say](docs/Say.md)
277
284
  - [Freeclimb::SayAllOf](docs/SayAllOf.md)
278
285
  - [Freeclimb::SendDigits](docs/SendDigits.md)
@@ -284,10 +291,11 @@ Class | Method | HTTP request | Description
284
291
  - [Freeclimb::Sms](docs/Sms.md)
285
292
  - [Freeclimb::SmsAllOf](docs/SmsAllOf.md)
286
293
  - [Freeclimb::StartRecordCall](docs/StartRecordCall.md)
294
+ - [Freeclimb::TFN](docs/TFN.md)
287
295
  - [Freeclimb::TerminateConference](docs/TerminateConference.md)
288
- - [Freeclimb::TerminateConferenceAllOf](docs/TerminateConferenceAllOf.md)
289
296
  - [Freeclimb::TranscribeUtterance](docs/TranscribeUtterance.md)
290
- - [Freeclimb::TranscribeUtteranceRecord](docs/TranscribeUtteranceRecord.md)
297
+ - [Freeclimb::TranscribeUtteranceAllOf](docs/TranscribeUtteranceAllOf.md)
298
+ - [Freeclimb::TranscribeUtteranceAllOfRecord](docs/TranscribeUtteranceAllOfRecord.md)
291
299
  - [Freeclimb::Unpark](docs/Unpark.md)
292
300
  - [Freeclimb::UpdateCallRequest](docs/UpdateCallRequest.md)
293
301
  - [Freeclimb::UpdateCallRequestStatus](docs/UpdateCallRequestStatus.md)
@@ -8,7 +8,6 @@
8
8
  | **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the &#x60;callControlUrl&#x60;. Only digits plus &#39;*&#39;, and &#39;#&#39; may be used. | [optional] |
9
9
  | **call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the &#x60;callControlSequence&#x60; 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** | **String** | 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
11
  | **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional] |
13
12
  | **listen** | **Boolean** | If &#x60;true&#x60;, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or &#x60;SetListen&#x60; PerCL command. | [optional] |
14
13
  | **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] |
@@ -25,7 +24,6 @@ instance = Freeclimb::AddToConference.new(
25
24
  call_control_sequence: null,
26
25
  call_control_url: null,
27
26
  conference_id: null,
28
- call_id: null,
29
27
  leave_conference_url: null,
30
28
  listen: null,
31
29
  notification_url: null,
@@ -8,7 +8,6 @@
8
8
  | **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the &#x60;callControlUrl&#x60;. Only digits plus &#39;*&#39;, and &#39;#&#39; may be used. | [optional] |
9
9
  | **call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the &#x60;callControlSequence&#x60; 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** | **String** | 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
11
  | **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional] |
13
12
  | **listen** | **Boolean** | If &#x60;true&#x60;, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or &#x60;SetListen&#x60; PerCL command. | [optional] |
14
13
  | **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] |
@@ -25,7 +24,6 @@ instance = Freeclimb::AddToConferenceAllOf.new(
25
24
  call_control_sequence: null,
26
25
  call_control_url: null,
27
26
  conference_id: null,
28
- call_id: null,
29
27
  leave_conference_url: null,
30
28
  listen: null,
31
29
  notification_url: null,
@@ -0,0 +1,22 @@
1
+ # Freeclimb::CreateWebRTCToken
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **to** | **String** | E.164 formatted phone number to which calls using this token will be made. | |
8
+ | **from** | **String** | E.164 formatted phone number owned by the reqeusting account from which calls using this token will be made. | |
9
+ | **uses** | **Integer** | number of times this token may be used for a WebRTC call | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'freeclimb'
15
+
16
+ instance = Freeclimb::CreateWebRTCToken.new(
17
+ to: null,
18
+ from: null,
19
+ uses: null
20
+ )
21
+ ```
22
+
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,85 @@ 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
+ conference_id = 'conference_id_example' # String | Show only Recordings made during the conference with this ID.
2766
+
2767
+ opts = {
2768
+ call_id: 'call_id_example', # String | Show only Recordings made during the Call with this ID.
2769
+ date_created: 'date_created_example' # String | Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
2770
+ }
2771
+
2772
+ begin
2773
+
2774
+ # List Conference Recordings
2775
+ result = api_instance.list_conference_recordings(conference_id, opts)
2776
+ p result
2777
+ rescue Freeclimb::ApiError => e
2778
+ puts "Error when calling DefaultApi->list_conference_recordings: #{e}"
2779
+ end
2780
+ ```
2781
+
2782
+ #### Using the list_conference_recordings_with_http_info variant
2783
+
2784
+ This returns an Array which contains the response data, status code and headers.
2785
+
2786
+ > <Array(<RecordingList>, Integer, Hash)> list_conference_recordings_with_http_info(account_id, conference_id, opts)
2787
+
2788
+ ```ruby
2789
+ begin
2790
+ # List Conference Recordings
2791
+ data, status_code, headers = api_instance.list_conference_recordings_with_http_info(conference_id, opts)
2792
+ p status_code # => 2xx
2793
+ p headers # => { ... }
2794
+ p data # => <RecordingList>
2795
+ rescue Freeclimb::ApiError => e
2796
+ puts "Error when calling DefaultApi->list_conference_recordings_with_http_info: #{e}"
2797
+ end
2798
+ ```
2799
+
2800
+ ### Parameters
2801
+
2802
+ | Name | Type | Description | Notes |
2803
+ | ---- | ---- | ----------- | ----- |
2804
+
2805
+ | **conference_id** | **String** | Show only Recordings made during the conference with this ID. | |
2806
+
2807
+ | **call_id** | **String** | Show only Recordings made during the Call with this ID. | [optional] |
2808
+
2809
+ | **date_created** | **String** | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional] |
2810
+
2811
+
2812
+ ### Return type
2813
+
2814
+ [**RecordingList**](RecordingList.md)
2815
+
2816
+ ### Authorization
2817
+
2818
+ [fc](../README.md#fc)
2819
+
2820
+ ### HTTP request headers
2821
+
2822
+ - **Content-Type**: Not defined
2823
+ - **Accept**: application/json
2824
+
2825
+
2605
2826
  ## list_conferences
2606
2827
 
2607
2828
  List Conferences
@@ -2716,6 +2937,7 @@ opts = {
2716
2937
  capabilities_toll_free: true, # Boolean |
2717
2938
  capabilities_ten_dlc: true, # Boolean |
2718
2939
  capabilities_short_code: true, # Boolean |
2940
+ tfn_campaign_id: 'tfn_campaign_id_example', # String | Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID.
2719
2941
  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
2942
  }
2721
2943
 
@@ -2780,6 +3002,8 @@ end
2780
3002
 
2781
3003
  | **capabilities_short_code** | **Boolean** | | [optional] |
2782
3004
 
3005
+ | **tfn_campaign_id** | **String** | Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID. | [optional] |
3006
+
2783
3007
  | **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
3008
 
2785
3009
 
@@ -3190,6 +3414,79 @@ end
3190
3414
  - **Accept**: application/json
3191
3415
 
3192
3416
 
3417
+ ## make_a_webrtc_jwt
3418
+
3419
+ Make a JWT for WebRTC calling
3420
+
3421
+ Make a JWT for WebRTC calling
3422
+
3423
+ ### Examples
3424
+
3425
+ ```ruby
3426
+ require 'time'
3427
+ require 'freeclimb'
3428
+ # setup authorization
3429
+ Freeclimb.configure do |config|
3430
+ # Configure HTTP basic authorization: fc
3431
+ config.username = 'ACCOUNT_ID'
3432
+ config.password = 'API_KEY'
3433
+ end
3434
+
3435
+ api_instance = Freeclimb::DefaultApi.new
3436
+
3437
+ 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
3438
+
3439
+
3440
+ begin
3441
+
3442
+ # Make a JWT for WebRTC calling
3443
+ result = api_instance.make_a_webrtc_jwt(create_web_rtc_token)
3444
+ p result
3445
+ rescue Freeclimb::ApiError => e
3446
+ puts "Error when calling DefaultApi->make_a_webrtc_jwt: #{e}"
3447
+ end
3448
+ ```
3449
+
3450
+ #### Using the make_a_webrtc_jwt_with_http_info variant
3451
+
3452
+ This returns an Array which contains the response data, status code and headers.
3453
+
3454
+ > <Array(String, Integer, Hash)> make_a_webrtc_jwt_with_http_info(account_id, create_web_rtc_token)
3455
+
3456
+ ```ruby
3457
+ begin
3458
+ # Make a JWT for WebRTC calling
3459
+ data, status_code, headers = api_instance.make_a_webrtc_jwt_with_http_info(create_web_rtc_token)
3460
+ p status_code # => 2xx
3461
+ p headers # => { ... }
3462
+ p data # => String
3463
+ rescue Freeclimb::ApiError => e
3464
+ puts "Error when calling DefaultApi->make_a_webrtc_jwt_with_http_info: #{e}"
3465
+ end
3466
+ ```
3467
+
3468
+ ### Parameters
3469
+
3470
+ | Name | Type | Description | Notes |
3471
+ | ---- | ---- | ----------- | ----- |
3472
+
3473
+ | **create_web_rtc_token** | [**CreateWebRTCToken**](CreateWebRTCToken.md) | Information needed to craft a JWT compatible with the platforms WebRTC APIs | |
3474
+
3475
+
3476
+ ### Return type
3477
+
3478
+ **String**
3479
+
3480
+ ### Authorization
3481
+
3482
+ [fc](../README.md#fc)
3483
+
3484
+ ### HTTP request headers
3485
+
3486
+ - **Content-Type**: application/json
3487
+ - **Accept**: text/plain
3488
+
3489
+
3193
3490
  ## remove_a_participant
3194
3491
 
3195
3492
  Remove a Participant
@@ -3433,8 +3730,7 @@ opts = {
3433
3730
  begin
3434
3731
 
3435
3732
  # Update a Conference
3436
- result = api_instance.update_a_conference(conference_id, opts)
3437
- p result
3733
+ api_instance.update_a_conference(conference_id, opts)
3438
3734
  rescue Freeclimb::ApiError => e
3439
3735
  puts "Error when calling DefaultApi->update_a_conference: #{e}"
3440
3736
  end
@@ -3442,9 +3738,9 @@ end
3442
3738
 
3443
3739
  #### Using the update_a_conference_with_http_info variant
3444
3740
 
3445
- This returns an Array which contains the response data, status code and headers.
3741
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
3446
3742
 
3447
- > <Array(<ConferenceResult>, Integer, Hash)> update_a_conference_with_http_info(account_id, conference_id, opts)
3743
+ > <Array(nil, Integer, Hash)> update_a_conference_with_http_info(account_id, conference_id, opts)
3448
3744
 
3449
3745
  ```ruby
3450
3746
  begin
@@ -3452,7 +3748,7 @@ begin
3452
3748
  data, status_code, headers = api_instance.update_a_conference_with_http_info(conference_id, opts)
3453
3749
  p status_code # => 2xx
3454
3750
  p headers # => { ... }
3455
- p data # => <ConferenceResult>
3751
+ p data # => nil
3456
3752
  rescue Freeclimb::ApiError => e
3457
3753
  puts "Error when calling DefaultApi->update_a_conference_with_http_info: #{e}"
3458
3754
  end
@@ -3470,7 +3766,7 @@ end
3470
3766
 
3471
3767
  ### Return type
3472
3768
 
3473
- [**ConferenceResult**](ConferenceResult.md)
3769
+ nil (empty response body)
3474
3770
 
3475
3771
  ### Authorization
3476
3772
 
@@ -3479,7 +3775,7 @@ end
3479
3775
  ### HTTP request headers
3480
3776
 
3481
3777
  - **Content-Type**: application/json
3482
- - **Accept**: application/json
3778
+ - **Accept**: Not defined
3483
3779
 
3484
3780
 
3485
3781
  ## 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 &#x60;timeout&#x60; has occurred and moving on to make the request to the actionUrl to submit the results of the &#x60;GetDigits&#x60; 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 &#x60;timeout&#x60; attribute – so, if a &#x60;timeout&#x60; occurs, then the command terminates regardless of the value of &#x60;finishOnKey&#x60;. | [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** | **String** | Maximum time in milliseconds that FreeClimb will wait for the Caller to press the first digit before making a determination that a &#x60;timeout&#x60; has occurred and moving on to make the request to the &#x60;actionUrl&#x60; to submit the results of the &#x60;GetDigits&#x60; command. This timeout interval begins when all nested commands have been fully executed. | [optional] |
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 &#x60;timeout&#x60; has occurred and moving on to make the request to the &#x60;actionUrl&#x60; to submit the results of the &#x60;GetDigits&#x60; 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 &#x60;GetDigits&#x60; command terminates regardless of the value of &#x60;finishOnKey&#x60;. | [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&lt;PerclCommand&gt;**](PerclCommand.md) | JSON array of PerCL commands to nest within the &#x60;GetDigits&#x60; command. The &#x60;Say&#x60;, &#x60;Play&#x60;, and &#x60;Pause&#x60; commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller. | [optional] |
@@ -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 &#x60;timeout&#x60; has occurred and moving on to make the request to the actionUrl to submit the results of the &#x60;GetDigits&#x60; 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 &#x60;timeout&#x60; attribute – so, if a &#x60;timeout&#x60; occurs, then the command terminates regardless of the value of &#x60;finishOnKey&#x60;. | [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** | **String** | Maximum time in milliseconds that FreeClimb will wait for the Caller to press the first digit before making a determination that a &#x60;timeout&#x60; has occurred and moving on to make the request to the &#x60;actionUrl&#x60; to submit the results of the &#x60;GetDigits&#x60; command. This timeout interval begins when all nested commands have been fully executed. | [optional] |
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 &#x60;timeout&#x60; has occurred and moving on to make the request to the &#x60;actionUrl&#x60; to submit the results of the &#x60;GetDigits&#x60; 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 &#x60;GetDigits&#x60; command terminates regardless of the value of &#x60;finishOnKey&#x60;. | [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&lt;PerclCommand&gt;**](PerclCommand.md) | JSON array of PerCL commands to nest within the &#x60;GetDigits&#x60; command. The &#x60;Say&#x60;, &#x60;Play&#x60;, and &#x60;Pause&#x60; 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