freeclimb 5.4.0 → 5.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/Gemfile.lock +2 -2
  4. data/README.md +7 -4
  5. data/docs/AudioStream.md +26 -0
  6. data/docs/AudioStreamWebhook.md +34 -0
  7. data/docs/AvailableNumber.md +2 -0
  8. data/docs/CallResult.md +17 -1
  9. data/docs/CallResultAllOfSubresourceUris.md +20 -0
  10. data/docs/ConferenceResult.md +1 -1
  11. data/docs/DefaultApi.md +20 -4
  12. data/docs/QueueResult.md +2 -0
  13. data/docs/RequestType.md +1 -0
  14. data/lib/freeclimb/api/default_api.rb +24 -0
  15. data/lib/freeclimb/models/audio_stream.rb +277 -0
  16. data/lib/freeclimb/models/audio_stream_webhook.rb +341 -0
  17. data/lib/freeclimb/models/available_number.rb +12 -1
  18. data/lib/freeclimb/models/call_result.rb +90 -3
  19. data/lib/freeclimb/models/call_result_all_of_subresource_uris.rb +228 -0
  20. data/lib/freeclimb/models/conference_result.rb +1 -0
  21. data/lib/freeclimb/models/incoming_number_result.rb +2 -1
  22. data/lib/freeclimb/models/message_result.rb +1 -0
  23. data/lib/freeclimb/models/queue_result.rb +12 -1
  24. data/lib/freeclimb/models/request_type.rb +1 -0
  25. data/lib/freeclimb/version.rb +1 -1
  26. data/lib/freeclimb.rb +3 -0
  27. data/openapi.json +241 -8
  28. data/package.json +11 -5
  29. data/spec/api/default_api_spec.rb +56 -8
  30. data/spec/models/audio_stream_spec.rb +358 -0
  31. data/spec/models/audio_stream_webhook_spec.rb +583 -0
  32. data/spec/models/available_number_spec.rb +48 -0
  33. data/spec/models/call_result_all_of_subresource_uris_spec.rb +214 -0
  34. data/spec/models/call_result_spec.rb +359 -21
  35. data/spec/models/queue_result_spec.rb +49 -1
  36. data/spec/models/request_type_spec.rb +16 -0
  37. data/yarn.lock +102 -99
  38. metadata +11 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 493077c655c7e9edf677bd1e6401b826f51a0af777e1074786dca2bbd7634524
4
- data.tar.gz: 5900b3444f637a6a8e611aba7f64cc4932111e4f76c59654129965d41e3579f8
3
+ metadata.gz: 55b3f365e1472ef495bcc62c25943b8dc3f8ba0fe7919111654a247b78e4cd36
4
+ data.tar.gz: bca322d8d2c2e39a3096a9b57925a4903353015ce2ceb6decf25c4bce13490af
5
5
  SHA512:
6
- metadata.gz: 6ca548a7765af7814f03390567c3bfe844921a845160c9b856aa1085a2a7ef6bd95d252c719278721d1c135a159b1876b4c3e09da80eb837eb398a96077b8b81
7
- data.tar.gz: ad65d42d7d44291b030550f40ccbd2ab504867dc3bc1d0713e1f5445bd1d6b2d0fb66d49aa94a3a1856c00a995c8d9ba252aac7742b05837b7b75a7d6dc5be45
6
+ metadata.gz: '09cfb72b5dc873a8dd45e1d53ec73143649632f17d039b9fe61969356fbe346b6b4e5e275feb6f0ec2a2c69bf8f0b673e32c20aa17c3d21ee5f7479cfdc49c02'
7
+ data.tar.gz: c92e50656042b5a8a47c7f7aa7c57635af77d97c3ee236be414f5cfdb5e64afcb20c7102bcb175054e131ea14637bea7cf872d8193faae3f6cb20b0553e55dc5
data/CHANGELOG.md CHANGED
@@ -7,6 +7,23 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ <a name="5.5.1"></a>
11
+
12
+ ## [5.5.1] - 2026-05-13
13
+
14
+ ### Changed
15
+
16
+ - Response status code for Make A Call should be 202 instead of 200
17
+
18
+ <a name="5.5.0"></a>
19
+
20
+ ## [5.5.0] - 2026-04-06
21
+
22
+ ### Added
23
+
24
+ - New parameters for fetching recordings (start time and end time)
25
+ - Audio Streaming feature
26
+
10
27
  <a name="5.4.0"></a>
11
28
 
12
29
  ## [5.4.0] - 2025-10-24
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- freeclimb (5.4.0)
4
+ freeclimb (5.5.1)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -39,7 +39,7 @@ GEM
39
39
  facets (3.1.0)
40
40
  factory_bot (6.5.0)
41
41
  activesupport (>= 5.0.0)
42
- ffi (1.17.2)
42
+ ffi (1.17.4)
43
43
  hashdiff (1.1.2)
44
44
  i18n (1.14.6)
45
45
  concurrent-ruby (~> 1.0)
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: 5.4.0
10
+ - Package version: 5.5.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', '~> 5.4.0'
18
+ gem 'freeclimb', '~> 5.5.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-5.4.0.gem
47
+ gem install ./freeclimb-5.5.1.gem
48
48
  ```
49
- (for development, run `gem install --dev ./freeclimb-5.4.0.gem` to install the development dependencies)
49
+ (for development, run `gem install --dev ./freeclimb-5.5.1.gem` to install the development dependencies)
50
50
 
51
51
  ## Getting Started
52
52
 
@@ -182,6 +182,8 @@ Class | Method | HTTP request | Description
182
182
  - [Freeclimb::ApplicationList](docs/ApplicationList.md)
183
183
  - [Freeclimb::ApplicationRequest](docs/ApplicationRequest.md)
184
184
  - [Freeclimb::ApplicationResult](docs/ApplicationResult.md)
185
+ - [Freeclimb::AudioStream](docs/AudioStream.md)
186
+ - [Freeclimb::AudioStreamWebhook](docs/AudioStreamWebhook.md)
185
187
  - [Freeclimb::AvailableNumber](docs/AvailableNumber.md)
186
188
  - [Freeclimb::AvailableNumberList](docs/AvailableNumberList.md)
187
189
  - [Freeclimb::BargeInReason](docs/BargeInReason.md)
@@ -193,6 +195,7 @@ Class | Method | HTTP request | Description
193
195
  - [Freeclimb::CallEndedReason](docs/CallEndedReason.md)
194
196
  - [Freeclimb::CallList](docs/CallList.md)
195
197
  - [Freeclimb::CallResult](docs/CallResult.md)
198
+ - [Freeclimb::CallResultAllOfSubresourceUris](docs/CallResultAllOfSubresourceUris.md)
196
199
  - [Freeclimb::CallStatus](docs/CallStatus.md)
197
200
  - [Freeclimb::CallStatusWebhook](docs/CallStatusWebhook.md)
198
201
  - [Freeclimb::Capabilities](docs/Capabilities.md)
@@ -0,0 +1,26 @@
1
+ # Freeclimb::AudioStream
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **location** | **String** | The gRPC server location that will receive the grpc stream as a uri and must be port 80 or 443. | |
8
+ | **action_url** | **String** | A request is made to this URL when the gRPC session is concluded. The PerCL script returned in response to the actionUrl will be executed on the call. | [optional] |
9
+ | **content_type** | **String** | The type and sample rate of the audio being received over the channel must match the environmental sample rate. | [optional] |
10
+ | **meta_data** | **Array&lt;String&gt;** | An arbitrary array of strings passed through FC to the GRPC server can be used to pass state or other information about the call. | [optional] |
11
+ | **privacy_mode** | **Boolean** | Enables audio redaction with full call recording while gRPC session is running and blocks logging of any DTMFs received by FreeClimb. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'freeclimb'
17
+
18
+ instance = Freeclimb::AudioStream.new(
19
+ location: null,
20
+ action_url: null,
21
+ content_type: null,
22
+ meta_data: null,
23
+ privacy_mode: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,34 @@
1
+ # Freeclimb::AudioStreamWebhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_type** | **String** | Context or reason why this request is being made. Will be audioStream - gRPC session for this Call has ended and its actionUrl is being invoked. | [optional] |
8
+ | **call_id** | **String** | Unique ID for this Call, generated by FreeClimb. This is the call leg which ended its gRPC session. | [optional] |
9
+ | **account_id** | **String** | Account ID associated with your account. | [optional] |
10
+ | **from** | **String** | Phone number of the party that initiated the Call (in E.164 format). | [optional] |
11
+ | **to** | **String** | Phone number provisioned to you and to which this Call is directed (in E.164 format). | [optional] |
12
+ | **call_status** | [**CallStatus**](CallStatus.md) | | [optional] |
13
+ | **direction** | [**CallDirection**](CallDirection.md) | | [optional] |
14
+ | **conference_id** | **String** | This is only populated if request pertains to a Conference. Otherwise, it is set to null. | [optional] |
15
+ | **queue_id** | **String** | This is only populated if the request pertains to a Queue. Otherwise, it is set to null. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'freeclimb'
21
+
22
+ instance = Freeclimb::AudioStreamWebhook.new(
23
+ request_type: null,
24
+ call_id: null,
25
+ account_id: null,
26
+ from: null,
27
+ to: null,
28
+ call_status: null,
29
+ direction: null,
30
+ conference_id: null,
31
+ queue_id: null
32
+ )
33
+ ```
34
+
@@ -7,6 +7,7 @@
7
7
  | **capabilities** | [**Capabilities**](Capabilities.md) | | [optional] |
8
8
  | **campaign_id** | **String** | The campaign ID generated by the campaign registry | [optional] |
9
9
  | **phone_number** | **String** | The phone number, in E.164 format (+ country code and phone number: +18003608245). | [optional] |
10
+ | **_alias** | **String** | A nicely-formatted version of the phone number. | [optional] |
10
11
  | **region** | **String** | The state or province of this phone number. | [optional] |
11
12
  | **country** | **String** | The country of this phone number. | [optional] |
12
13
 
@@ -19,6 +20,7 @@ instance = Freeclimb::AvailableNumber.new(
19
20
  capabilities: null,
20
21
  campaign_id: null,
21
22
  phone_number: null,
23
+ _alias: null,
22
24
  region: null,
23
25
  country: null
24
26
  )
data/docs/CallResult.md CHANGED
@@ -8,6 +8,8 @@
8
8
  | **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
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
+ | **date_created_iso** | **Time** | The date that this resource was created in ISO 8601 format (e.g., 2022-01-01T00:00:00.000Z). | [optional] |
12
+ | **date_updated_iso** | **Time** | The date that this resource was last updated in ISO 8601 format (e.g., 2022-01-01T00:00:00.000Z). | [optional] |
11
13
  | **call_id** | **String** | String that uniquely identifies this Call resource. | [optional] |
12
14
  | **parent_call_id** | **String** | ID of the Call that created this leg (child Call). | [optional] |
13
15
  | **account_id** | **String** | ID of the account that owns this Call. | [optional] |
@@ -16,13 +18,19 @@
16
18
  | **phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional] |
17
19
  | **status** | [**CallStatus**](CallStatus.md) | | [optional] |
18
20
  | **start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
21
+ | **start_time_iso** | **Time** | Start time of the Call in ISO 8601 format (e.g., 2022-01-01T00:00:00.000Z). Empty if the Call has not yet been dialed. | [optional] |
19
22
  | **connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
23
+ | **connect_time_iso** | **Time** | Time the Call was answered in ISO 8601 format (e.g., 2022-01-01T00:00:00.000Z). Empty if the Call has not yet been dialed. | [optional] |
20
24
  | **end_time** | **String** | End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully. | [optional] |
25
+ | **end_time_iso** | **Time** | End time of the Call in ISO 8601 format (e.g., 2022-01-01T00:00:00.000Z). Empty if the Call did not complete successfully. | [optional] |
21
26
  | **duration** | **Integer** | Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] |
22
27
  | **connect_duration** | **Integer** | Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] |
28
+ | **audio_stream_duration** | **Integer** | Length of time that the Call used the audio stream in seconds. This value is empty or zero when the Call did not use the audio stream. | [optional] |
23
29
  | **direction** | [**CallDirection**](CallDirection.md) | | [optional] |
24
30
  | **answered_by** | [**AnsweredBy**](AnsweredBy.md) | | [optional] |
25
- | **subresource_uris** | **Object** | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional] |
31
+ | **caller_name** | **String** | The caller ID name (CNAM) for this Call. Empty if unavailable. | [optional] |
32
+ | **web_rtc** | **Boolean** | Indicates whether this Call was initiated via WebRTC. | [optional] |
33
+ | **subresource_uris** | [**CallResultAllOfSubresourceUris**](CallResultAllOfSubresourceUris.md) | | [optional] |
26
34
  | **application_id** | **String** | ApplicationId associated with the Call. | [optional] |
27
35
 
28
36
  ## Example
@@ -35,6 +43,8 @@ instance = Freeclimb::CallResult.new(
35
43
  date_created: null,
36
44
  date_updated: null,
37
45
  revision: null,
46
+ date_created_iso: null,
47
+ date_updated_iso: null,
38
48
  call_id: null,
39
49
  parent_call_id: null,
40
50
  account_id: null,
@@ -43,12 +53,18 @@ instance = Freeclimb::CallResult.new(
43
53
  phone_number_id: null,
44
54
  status: null,
45
55
  start_time: null,
56
+ start_time_iso: null,
46
57
  connect_time: null,
58
+ connect_time_iso: null,
47
59
  end_time: null,
60
+ end_time_iso: null,
48
61
  duration: null,
49
62
  connect_duration: null,
63
+ audio_stream_duration: null,
50
64
  direction: null,
51
65
  answered_by: null,
66
+ caller_name: null,
67
+ web_rtc: null,
52
68
  subresource_uris: null,
53
69
  application_id: null
54
70
  )
@@ -0,0 +1,20 @@
1
+ # Freeclimb::CallResultAllOfSubresourceUris
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **logs** | **String** | The URI for the logs associated with this Call. | [optional] |
8
+ | **recordings** | **String** | The URI for the recordings associated with this Call. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'freeclimb'
14
+
15
+ instance = Freeclimb::CallResultAllOfSubresourceUris.new(
16
+ logs: null,
17
+ recordings: null
18
+ )
19
+ ```
20
+
@@ -11,7 +11,7 @@
11
11
  | **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional] |
12
12
  | **account_id** | **String** | ID of the account that created this Conference. | [optional] |
13
13
  | **_alias** | **String** | A description for this Conference. | [optional] |
14
- | **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional] |
14
+ | **play_beep** | [**PlayBeep**](PlayBeep.md) | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional] |
15
15
  | **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional] |
16
16
  | **status** | [**ConferenceStatus**](ConferenceStatus.md) | | [optional] |
17
17
  | **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional] |
data/docs/DefaultApi.md CHANGED
@@ -3272,7 +3272,9 @@ api_instance = Freeclimb::DefaultApi.new
3272
3272
  call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
3273
3273
 
3274
3274
  opts = {
3275
- date_created: 'date_created_example' # String | Only show recordings created on the specified date, in the form *YYYY-MM-DD*.
3275
+ date_created: 'date_created_example', # String | Only show recordings created on the specified date, in the form *YYYY-MM-DD*.
3276
+ start_time: 'start_time_example', # String | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss.
3277
+ end_time: 'end_time_example' # String | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss.
3276
3278
  }
3277
3279
 
3278
3280
  begin
@@ -3309,6 +3311,8 @@ end
3309
3311
  | ---- | ---- | ----------- | ----- |
3310
3312
  | **call_id** | **String** | String that uniquely identifies this call resource. | |
3311
3313
  | **date_created** | **String** | Only show recordings created on the specified date, in the form *YYYY-MM-DD*. | [optional] |
3314
+ | **start_time** | **String** | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] |
3315
+ | **end_time** | **String** | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. | [optional] |
3312
3316
 
3313
3317
 
3314
3318
  ### Return type
@@ -3344,6 +3348,7 @@ end
3344
3348
  api_instance = Freeclimb::DefaultApi.new
3345
3349
 
3346
3350
  opts = {
3351
+ used_audio_stream: true, # Boolean | If usedAudioStream is set to true then all calls that have a audioStreamDuration > 0 will be returned
3347
3352
  active: true, # Boolean | If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query.
3348
3353
  to: 'to_example', # String | Only show Calls to this phone number.
3349
3354
  from: 'from_example', # String | Only show Calls from this phone number.
@@ -3353,7 +3358,8 @@ opts = {
3353
3358
  parent_call_id: 'parent_call_id_example', # String | Only show Calls spawned by the call with this ID.
3354
3359
  application_id: ['inner_example'], # Array<String> | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.
3355
3360
  risk_score_min: 56, # Integer | The minimum riskScore that should be included in the list.
3356
- risk_score_max: 56 # Integer | The maximum riskScore that should be included in the list.
3361
+ risk_score_max: 56, # Integer | The maximum riskScore that should be included in the list.
3362
+ web_rtc: true # Boolean | Only show Calls that were originated via WebRTC.
3357
3363
  }
3358
3364
 
3359
3365
  begin
@@ -3388,6 +3394,7 @@ end
3388
3394
 
3389
3395
  | Name | Type | Description | Notes |
3390
3396
  | ---- | ---- | ----------- | ----- |
3397
+ | **used_audio_stream** | **Boolean** | If usedAudioStream is set to true then all calls that have a audioStreamDuration &gt; 0 will be returned | [optional][default to false] |
3391
3398
  | **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] |
3392
3399
  | **to** | **String** | Only show Calls to this phone number. | [optional] |
3393
3400
  | **from** | **String** | Only show Calls from this phone number. | [optional] |
@@ -3398,6 +3405,7 @@ end
3398
3405
  | **application_id** | [**Array&lt;String&gt;**](String.md) | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. | [optional] |
3399
3406
  | **risk_score_min** | **Integer** | The minimum riskScore that should be included in the list. | [optional] |
3400
3407
  | **risk_score_max** | **Integer** | The maximum riskScore that should be included in the list. | [optional] |
3408
+ | **web_rtc** | **Boolean** | Only show Calls that were originated via WebRTC. | [optional][default to false] |
3401
3409
 
3402
3410
 
3403
3411
  ### Return type
@@ -3436,7 +3444,9 @@ conference_id = 'conference_id_example' # String | Show only Recordings made dur
3436
3444
 
3437
3445
  opts = {
3438
3446
  call_id: 'call_id_example', # String | Show only Recordings made during the Call with this ID.
3439
- date_created: 'date_created_example' # String | Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
3447
+ date_created: 'date_created_example', # String | Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
3448
+ start_time: 'start_time_example', # String | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss.
3449
+ end_time: 'end_time_example' # String | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss.
3440
3450
  }
3441
3451
 
3442
3452
  begin
@@ -3474,6 +3484,8 @@ end
3474
3484
  | **conference_id** | **String** | Show only Recordings made during the conference with this ID. | |
3475
3485
  | **call_id** | **String** | Show only Recordings made during the Call with this ID. | [optional] |
3476
3486
  | **date_created** | **String** | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional] |
3487
+ | **start_time** | **String** | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] |
3488
+ | **end_time** | **String** | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. | [optional] |
3477
3489
 
3478
3490
 
3479
3491
  ### Return type
@@ -3906,7 +3918,9 @@ api_instance = Freeclimb::DefaultApi.new
3906
3918
  opts = {
3907
3919
  call_id: 'call_id_example', # String | Show only Recordings made during the Call with this ID.
3908
3920
  conference_id: 'conference_id_example', # String | Show only Recordings made during the conference with this ID.
3909
- date_created: 'date_created_example' # String | Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
3921
+ date_created: 'date_created_example', # String | Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
3922
+ start_time: 'start_time_example', # String | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss.
3923
+ end_time: 'end_time_example' # String | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss.
3910
3924
  }
3911
3925
 
3912
3926
  begin
@@ -3944,6 +3958,8 @@ end
3944
3958
  | **call_id** | **String** | Show only Recordings made during the Call with this ID. | [optional] |
3945
3959
  | **conference_id** | **String** | Show only Recordings made during the conference with this ID. | [optional] |
3946
3960
  | **date_created** | **String** | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional] |
3961
+ | **start_time** | **String** | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] |
3962
+ | **end_time** | **String** | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. | [optional] |
3947
3963
 
3948
3964
 
3949
3965
  ### Return type
data/docs/QueueResult.md CHANGED
@@ -14,6 +14,7 @@
14
14
  | **max_size** | **Integer** | The maximum number of Calls permitted in the Queue. Default is 100. Maximum is 1000. | [optional] |
15
15
  | **current_size** | **Integer** | Count of Calls currently in the Queue. | [optional] |
16
16
  | **average_queue_removal_time** | **Integer** | The average amount of time (in seconds) for a call to be removed from the queue. | [optional] |
17
+ | **average_wait_time** | **Integer** | The average wait time (in seconds) of all Calls in the Queue. | [optional] |
17
18
  | **subresource_uris** | **Object** | List of subresources for this Queue (which includes Queue members). | [optional] |
18
19
 
19
20
  ## Example
@@ -32,6 +33,7 @@ instance = Freeclimb::QueueResult.new(
32
33
  max_size: null,
33
34
  current_size: null,
34
35
  average_queue_removal_time: null,
36
+ average_wait_time: null,
35
37
  subresource_uris: null
36
38
  )
37
39
  ```
data/docs/RequestType.md CHANGED
@@ -17,6 +17,7 @@
17
17
  | **DEQUEUE** | **RequestType** | | Represented in Ruby as "dequeue" |
18
18
  | **QUEUE_WAIT** | **RequestType** | | Represented in Ruby as "queueWait" |
19
19
  | **ADD_TO_QUEUE_NOTIFICATION** | **RequestType** | | Represented in Ruby as "addToQueueNotification" |
20
+ | **AUDIO_STREAM** | **RequestType** | | Represented in Ruby as "audioStream" |
20
21
  | **REMOVE_FROM_QUEUE_NOTIFICATION** | **RequestType** | | Represented in Ruby as "removeFromQueueNotification" |
21
22
  | **CALL_STATUS** | **RequestType** | | Represented in Ruby as "callStatus" |
22
23
  | **CREATE_CONFERENCE** | **RequestType** | | Represented in Ruby as "createConference" |
@@ -2965,6 +2965,8 @@ module Freeclimb
2965
2965
  # @param call_id [String] String that uniquely identifies this call resource.
2966
2966
  # @param [Hash] opts the optional parameters
2967
2967
  # @option opts [String] :date_created Only show recordings created on the specified date, in the form *YYYY-MM-DD*.
2968
+ # @option opts [String] :start_time Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss.
2969
+ # @option opts [String] :end_time Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss.
2968
2970
  # @return [RecordingList]
2969
2971
  def list_call_recordings(call_id, opts = {})
2970
2972
  data, _status_code, _headers = list_call_recordings_with_http_info(call_id, opts)
@@ -2975,6 +2977,8 @@ module Freeclimb
2975
2977
  # @param call_id [String] String that uniquely identifies this call resource.
2976
2978
  # @param [Hash] opts the optional parameters
2977
2979
  # @option opts [String] :date_created Only show recordings created on the specified date, in the form *YYYY-MM-DD*.
2980
+ # @option opts [String] :start_time Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss.
2981
+ # @option opts [String] :end_time Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss.
2978
2982
  # @return [Array<(RecordingList, Integer, Hash)>] RecordingList data, response status code and response headers
2979
2983
  def list_call_recordings_with_http_info(call_id, opts = {})
2980
2984
  if @api_client.config.debugging
@@ -2995,6 +2999,8 @@ module Freeclimb
2995
2999
  # query parameters
2996
3000
  query_params = opts[:query_params] || {}
2997
3001
  query_params[:dateCreated] = opts[:date_created] if !opts[:date_created].nil?
3002
+ query_params[:startTime] = opts[:start_time] if !opts[:start_time].nil?
3003
+ query_params[:endTime] = opts[:end_time] if !opts[:end_time].nil?
2998
3004
 
2999
3005
  # header parameters
3000
3006
  header_params = opts[:header_params] || {}
@@ -3032,6 +3038,7 @@ module Freeclimb
3032
3038
 
3033
3039
  # List Calls
3034
3040
  # @param [Hash] opts the optional parameters
3041
+ # @option opts [Boolean] :used_audio_stream If usedAudioStream is set to true then all calls that have a audioStreamDuration &gt; 0 will be returned (default to false)
3035
3042
  # @option opts [Boolean] :active If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. (default to false)
3036
3043
  # @option opts [String] :to Only show Calls to this phone number.
3037
3044
  # @option opts [String] :from Only show Calls from this phone number.
@@ -3042,6 +3049,7 @@ module Freeclimb
3042
3049
  # @option opts [Array<String>] :application_id Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.
3043
3050
  # @option opts [Integer] :risk_score_min The minimum riskScore that should be included in the list.
3044
3051
  # @option opts [Integer] :risk_score_max The maximum riskScore that should be included in the list.
3052
+ # @option opts [Boolean] :web_rtc Only show Calls that were originated via WebRTC. (default to false)
3045
3053
  # @return [CallList]
3046
3054
  def list_calls(opts = {})
3047
3055
  data, _status_code, _headers = list_calls_with_http_info(opts)
@@ -3050,6 +3058,7 @@ module Freeclimb
3050
3058
 
3051
3059
  # List Calls
3052
3060
  # @param [Hash] opts the optional parameters
3061
+ # @option opts [Boolean] :used_audio_stream If usedAudioStream is set to true then all calls that have a audioStreamDuration &gt; 0 will be returned
3053
3062
  # @option opts [Boolean] :active If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query.
3054
3063
  # @option opts [String] :to Only show Calls to this phone number.
3055
3064
  # @option opts [String] :from Only show Calls from this phone number.
@@ -3060,6 +3069,7 @@ module Freeclimb
3060
3069
  # @option opts [Array<String>] :application_id Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.
3061
3070
  # @option opts [Integer] :risk_score_min The minimum riskScore that should be included in the list.
3062
3071
  # @option opts [Integer] :risk_score_max The maximum riskScore that should be included in the list.
3072
+ # @option opts [Boolean] :web_rtc Only show Calls that were originated via WebRTC.
3063
3073
  # @return [Array<(CallList, Integer, Hash)>] CallList data, response status code and response headers
3064
3074
  def list_calls_with_http_info(opts = {})
3065
3075
  if @api_client.config.debugging
@@ -3079,6 +3089,7 @@ module Freeclimb
3079
3089
 
3080
3090
  # query parameters
3081
3091
  query_params = opts[:query_params] || {}
3092
+ query_params[:usedAudioStream] = opts[:used_audio_stream] if !opts[:used_audio_stream].nil?
3082
3093
  query_params[:active] = opts[:active] if !opts[:active].nil?
3083
3094
  query_params[:to] = opts[:to] if !opts[:to].nil?
3084
3095
  query_params[:from] = opts[:from] if !opts[:from].nil?
@@ -3089,6 +3100,7 @@ module Freeclimb
3089
3100
  query_params[:applicationId] = @api_client.build_collection_param(opts[:application_id], :multi) if !opts[:application_id].nil?
3090
3101
  query_params[:riskScoreMin] = opts[:risk_score_min] if !opts[:risk_score_min].nil?
3091
3102
  query_params[:riskScoreMax] = opts[:risk_score_max] if !opts[:risk_score_max].nil?
3103
+ query_params[:webRTC] = opts[:web_rtc] if !opts[:web_rtc].nil?
3092
3104
 
3093
3105
  # header parameters
3094
3106
  header_params = opts[:header_params] || {}
@@ -3129,6 +3141,8 @@ module Freeclimb
3129
3141
  # @param [Hash] opts the optional parameters
3130
3142
  # @option opts [String] :call_id Show only Recordings made during the Call with this ID.
3131
3143
  # @option opts [String] :date_created Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
3144
+ # @option opts [String] :start_time Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss.
3145
+ # @option opts [String] :end_time Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss.
3132
3146
  # @return [RecordingList]
3133
3147
  def list_conference_recordings(conference_id, opts = {})
3134
3148
  data, _status_code, _headers = list_conference_recordings_with_http_info(conference_id, opts)
@@ -3140,6 +3154,8 @@ module Freeclimb
3140
3154
  # @param [Hash] opts the optional parameters
3141
3155
  # @option opts [String] :call_id Show only Recordings made during the Call with this ID.
3142
3156
  # @option opts [String] :date_created Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
3157
+ # @option opts [String] :start_time Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss.
3158
+ # @option opts [String] :end_time Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss.
3143
3159
  # @return [Array<(RecordingList, Integer, Hash)>] RecordingList data, response status code and response headers
3144
3160
  def list_conference_recordings_with_http_info(conference_id, opts = {})
3145
3161
  if @api_client.config.debugging
@@ -3161,6 +3177,8 @@ module Freeclimb
3161
3177
  query_params = opts[:query_params] || {}
3162
3178
  query_params[:callId] = opts[:call_id] if !opts[:call_id].nil?
3163
3179
  query_params[:dateCreated] = opts[:date_created] if !opts[:date_created].nil?
3180
+ query_params[:startTime] = opts[:start_time] if !opts[:start_time].nil?
3181
+ query_params[:endTime] = opts[:end_time] if !opts[:end_time].nil?
3164
3182
 
3165
3183
  # header parameters
3166
3184
  header_params = opts[:header_params] || {}
@@ -3582,6 +3600,8 @@ module Freeclimb
3582
3600
  # @option opts [String] :call_id Show only Recordings made during the Call with this ID.
3583
3601
  # @option opts [String] :conference_id Show only Recordings made during the conference with this ID.
3584
3602
  # @option opts [String] :date_created Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
3603
+ # @option opts [String] :start_time Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss.
3604
+ # @option opts [String] :end_time Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss.
3585
3605
  # @return [RecordingList]
3586
3606
  def list_recordings(opts = {})
3587
3607
  data, _status_code, _headers = list_recordings_with_http_info(opts)
@@ -3593,6 +3613,8 @@ module Freeclimb
3593
3613
  # @option opts [String] :call_id Show only Recordings made during the Call with this ID.
3594
3614
  # @option opts [String] :conference_id Show only Recordings made during the conference with this ID.
3595
3615
  # @option opts [String] :date_created Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
3616
+ # @option opts [String] :start_time Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss.
3617
+ # @option opts [String] :end_time Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss.
3596
3618
  # @return [Array<(RecordingList, Integer, Hash)>] RecordingList data, response status code and response headers
3597
3619
  def list_recordings_with_http_info(opts = {})
3598
3620
  if @api_client.config.debugging
@@ -3611,6 +3633,8 @@ module Freeclimb
3611
3633
  query_params[:callId] = opts[:call_id] if !opts[:call_id].nil?
3612
3634
  query_params[:conferenceId] = opts[:conference_id] if !opts[:conference_id].nil?
3613
3635
  query_params[:dateCreated] = opts[:date_created] if !opts[:date_created].nil?
3636
+ query_params[:startTime] = opts[:start_time] if !opts[:start_time].nil?
3637
+ query_params[:endTime] = opts[:end_time] if !opts[:end_time].nil?
3614
3638
 
3615
3639
  # header parameters
3616
3640
  header_params = opts[:header_params] || {}