freeclimb 2.1.1 → 3.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2b2432d5b30385e65f3c0e9a9fc9c2731de5cd03377ef0df110269772cb3d1fd
4
- data.tar.gz: eb91292c2fa6fa794fbf1c0c7c5925b79c023a6eea28d167848d9c9aa6f91036
3
+ metadata.gz: 617bf20b11396e58276bbbdd33244196b877a26f1cc79486b831c97254e51dd2
4
+ data.tar.gz: 9f233c8a0fd8dff303a73421e3431ee84dcfe31ae95121cbcdffa3de0fd54ea7
5
5
  SHA512:
6
- metadata.gz: 648bb6a97a082a2baf5b5edf02effb1312f98ae1cc67e4b309e843905abd98343b8805e9f6e365be7d96517d4b5f6b5bd09cf0f791c3cf5dadd9ecac90128e82
7
- data.tar.gz: f238c728fac55b34900af24c2d37072ede3948fd73460ea4f6c9aad62237153095473dc47813d7fba0ea25b1d76aba72be90bc6379420497cc1e6129070cdca5
6
+ metadata.gz: 151eab0b3b6e3f54871ca7a966dc4a5fc491a39fb9c8a303c618b149434505e192124ed4c74abd344b168a64925315f5abbcedf2330f01dccbf49f76a6219f01
7
+ data.tar.gz: 1f03da230e4bfd987128d72156e840f04c5f64d10e3f1af97fa028634a6b2bfaae1656a06452535fbb9453940dc77f565fa5bba9d98e0dcbb2e38736c2ebe330
data/CHANGELOG.md CHANGED
@@ -7,6 +7,30 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
7
7
  ## [Unreleased]
8
8
  None
9
9
 
10
+ <a name="3.0.1"></a>
11
+ ## [3.0.1] - 2021-11-02
12
+ ### Added
13
+ - Add `active` property to CallResult
14
+
15
+ ### Changed
16
+ - Small instances of `token` to `key`
17
+ - Call ID is not required to `AddToConference`
18
+
19
+ <a name="3.0.0"></a>
20
+ ## [3.0.0] - 2021-05-03
21
+ ### Added
22
+ - Add `verify_request` utility function
23
+
24
+ <a name="2.2.0"></a>
25
+ ## [2.2.0] - 2021-04-12
26
+ ### Changed
27
+ - Replace any language instance of `auth_token` or similar speech to `api_key`
28
+
29
+ <a name="2.1.2"></a>
30
+ ## [2.1.2] - 2021-03-10
31
+ ### Added
32
+ - Add `callConnectUrl` option to MakeACall Request
33
+
10
34
 
11
35
  <a name="2.1.1"></a>
12
36
  ## [2.1.1] - 2020-12-16
data/README.md CHANGED
@@ -5,7 +5,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
5
5
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
6
6
 
7
7
  - API version: 1.0.0
8
- - Package version: 2.1.1
8
+ - Package version: 3.0.1
9
9
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
10
10
 
11
11
  ## Installation
@@ -21,16 +21,16 @@ gem build freeclimb.gemspec
21
21
  Then either install the gem locally:
22
22
 
23
23
  ```shell
24
- gem install ./freeclimb-2.1.1.gem
24
+ gem install ./freeclimb-3.0.1.gem
25
25
  ```
26
26
 
27
- (for development, run `gem install --dev ./freeclimb-2.1.1.gem` to install the development dependencies)
27
+ (for development, run `gem install --dev ./freeclimb-3.0.1.gem` to install the development dependencies)
28
28
 
29
29
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
30
30
 
31
31
  Finally add this to the Gemfile:
32
32
 
33
- gem 'freeclimb', '~> 2.1.1'
33
+ gem 'freeclimb', '~> 3.0.1'
34
34
 
35
35
  ### Install from Ruby gems
36
36
  ```shell
@@ -63,7 +63,7 @@ require 'freeclimb'
63
63
  Freeclimb.configure do |config|
64
64
  # Configure HTTP basic authorization: fc
65
65
  config.username = 'ACCOUNT_ID'
66
- config.password = 'AUTH_TOKEN'
66
+ config.password = 'API_KEY'
67
67
  end
68
68
 
69
69
  api_instance = Freeclimb::DefaultApi.new
@@ -259,6 +259,7 @@ Class | Method | HTTP request | Description
259
259
 
260
260
  - **Type**: HTTP basic authentication
261
261
 
262
+
262
263
  ## Getting Help
263
264
 
264
265
  If you are experiencing difficulties, [contact support](https://freeclimb.com/support).
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
  **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
10
10
  **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
11
11
  **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
12
- **auth_token** | **String** | The authorization token assigned to this account. This token must be kept a secret by the customer. | [optional]
12
+ **api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional]
13
13
  **_alias** | **String** | A description for this account. | [optional]
14
14
  **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional]
15
15
  **type** | **String** | The type of this account. It is one of: trial or full. | [optional]
@@ -26,7 +26,7 @@ instance = Freeclimb::AccountResult.new(uri: nil,
26
26
  date_updated: nil,
27
27
  revision: nil,
28
28
  account_id: nil,
29
- auth_token: nil,
29
+ api_key: nil,
30
30
  _alias: nil,
31
31
  label: nil,
32
32
  type: nil,
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
8
- **auth_token** | **String** | The authorization token assigned to this account. This token must be kept a secret by the customer. | [optional]
8
+ **api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional]
9
9
  **_alias** | **String** | A description for this account. | [optional]
10
10
  **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional]
11
11
  **type** | **String** | The type of this account. It is one of: trial or full. | [optional]
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
18
18
  require 'freeclimb'
19
19
 
20
20
  instance = Freeclimb::AccountResultAllOf.new(account_id: nil,
21
- auth_token: nil,
21
+ api_key: nil,
22
22
  _alias: nil,
23
23
  label: nil,
24
24
  type: nil,
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the &#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** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. |
11
+ **call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. | [optional]
12
12
  **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional]
13
13
  **listen** | **Boolean** | If &#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
14
  **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the &#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** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. |
11
+ **call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. | [optional]
12
12
  **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional]
13
13
  **listen** | **Boolean** | If &#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
14
  **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
data/docs/CallResult.md CHANGED
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
14
14
  **from** | **String** | Phone number that initiated this Call. | [optional]
15
15
  **to** | **String** | Phone number that received this Call. | [optional]
16
16
  **phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional]
17
+ **active** | **Boolean** | Whether the call is currently active or has concluded. | [optional] [default to false]
17
18
  **status** | **String** | * &#x60;queued&#x60; &amp;ndash; Call is ready and waiting in line before going out. * &#x60;ringing&#x60; &amp;ndash; Call is currently ringing. * &#x60;inProgress&#x60; &amp;ndash; Call was answered and is currently in progress. * &#x60;canceled&#x60; &amp;ndash; Call was hung up while it was queued or ringing. * &#x60;completed&#x60; &amp;ndash; Call was answered and has ended normally. * &#x60;busy&#x60; &amp;ndash; Caller received a busy signal. * &#x60;failed&#x60; &amp;ndash; Call could not be completed as dialed, most likely because the phone number was non-existent. * &#x60;noAnswer&#x60; &amp;ndash; Call ended without being answered. | [optional]
18
19
  **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]
19
20
  **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]
@@ -39,6 +40,7 @@ instance = Freeclimb::CallResult.new(uri: nil,
39
40
  from: nil,
40
41
  to: nil,
41
42
  phone_number_id: nil,
43
+ active: nil,
42
44
  status: nil,
43
45
  start_time: nil,
44
46
  connect_time: nil,
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **from** | **String** | Phone number that initiated this Call. | [optional]
11
11
  **to** | **String** | Phone number that received this Call. | [optional]
12
12
  **phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional]
13
+ **active** | **Boolean** | Whether the call is currently active or has concluded. | [optional] [default to false]
13
14
  **status** | **String** | * &#x60;queued&#x60; &amp;ndash; Call is ready and waiting in line before going out. * &#x60;ringing&#x60; &amp;ndash; Call is currently ringing. * &#x60;inProgress&#x60; &amp;ndash; Call was answered and is currently in progress. * &#x60;canceled&#x60; &amp;ndash; Call was hung up while it was queued or ringing. * &#x60;completed&#x60; &amp;ndash; Call was answered and has ended normally. * &#x60;busy&#x60; &amp;ndash; Caller received a busy signal. * &#x60;failed&#x60; &amp;ndash; Call could not be completed as dialed, most likely because the phone number was non-existent. * &#x60;noAnswer&#x60; &amp;ndash; Call ended without being answered. | [optional]
14
15
  **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]
15
16
  **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]
@@ -31,6 +32,7 @@ instance = Freeclimb::CallResultAllOf.new(call_id: nil,
31
32
  from: nil,
32
33
  to: nil,
33
34
  phone_number_id: nil,
35
+ active: nil,
34
36
  status: nil,
35
37
  start_time: nil,
36
38
  connect_time: nil,
data/docs/DefaultApi.md CHANGED
@@ -68,7 +68,7 @@ require 'freeclimb'
68
68
  Freeclimb.configure do |config|
69
69
  # Configure HTTP basic authorization: fc
70
70
  config.username = 'ACCOUNT ID'
71
- config.password = 'AUTH TOKEN'
71
+ config.password = 'API KEY'
72
72
  end
73
73
 
74
74
  api_instance = Freeclimb::DefaultApi.new
@@ -115,7 +115,7 @@ require 'freeclimb'
115
115
  Freeclimb.configure do |config|
116
116
  # Configure HTTP basic authorization: fc
117
117
  config.username = 'ACCOUNT ID'
118
- config.password = 'AUTH TOKEN'
118
+ config.password = 'API KEY'
119
119
  end
120
120
 
121
121
  api_instance = Freeclimb::DefaultApi.new
@@ -166,7 +166,7 @@ require 'freeclimb'
166
166
  Freeclimb.configure do |config|
167
167
  # Configure HTTP basic authorization: fc
168
168
  config.username = 'ACCOUNT ID'
169
- config.password = 'AUTH TOKEN'
169
+ config.password = 'API KEY'
170
170
  end
171
171
 
172
172
  api_instance = Freeclimb::DefaultApi.new
@@ -219,7 +219,7 @@ require 'freeclimb'
219
219
  Freeclimb.configure do |config|
220
220
  # Configure HTTP basic authorization: fc
221
221
  config.username = 'ACCOUNT ID'
222
- config.password = 'AUTH TOKEN'
222
+ config.password = 'API KEY'
223
223
  end
224
224
 
225
225
  api_instance = Freeclimb::DefaultApi.new
@@ -272,7 +272,7 @@ require 'freeclimb'
272
272
  Freeclimb.configure do |config|
273
273
  # Configure HTTP basic authorization: fc
274
274
  config.username = 'ACCOUNT ID'
275
- config.password = 'AUTH TOKEN'
275
+ config.password = 'API KEY'
276
276
  end
277
277
 
278
278
  api_instance = Freeclimb::DefaultApi.new
@@ -325,7 +325,7 @@ require 'freeclimb'
325
325
  Freeclimb.configure do |config|
326
326
  # Configure HTTP basic authorization: fc
327
327
  config.username = 'ACCOUNT ID'
328
- config.password = 'AUTH TOKEN'
328
+ config.password = 'API KEY'
329
329
  end
330
330
 
331
331
  api_instance = Freeclimb::DefaultApi.new
@@ -375,7 +375,7 @@ require 'freeclimb'
375
375
  Freeclimb.configure do |config|
376
376
  # Configure HTTP basic authorization: fc
377
377
  config.username = 'ACCOUNT ID'
378
- config.password = 'AUTH TOKEN'
378
+ config.password = 'API KEY'
379
379
  end
380
380
 
381
381
  api_instance = Freeclimb::DefaultApi.new
@@ -425,7 +425,7 @@ require 'freeclimb'
425
425
  Freeclimb.configure do |config|
426
426
  # Configure HTTP basic authorization: fc
427
427
  config.username = 'ACCOUNT ID'
428
- config.password = 'AUTH TOKEN'
428
+ config.password = 'API KEY'
429
429
  end
430
430
 
431
431
  api_instance = Freeclimb::DefaultApi.new
@@ -475,7 +475,7 @@ require 'freeclimb'
475
475
  Freeclimb.configure do |config|
476
476
  # Configure HTTP basic authorization: fc
477
477
  config.username = 'ACCOUNT ID'
478
- config.password = 'AUTH TOKEN'
478
+ config.password = 'API KEY'
479
479
  end
480
480
 
481
481
  api_instance = Freeclimb::DefaultApi.new
@@ -528,7 +528,7 @@ require 'freeclimb'
528
528
  Freeclimb.configure do |config|
529
529
  # Configure HTTP basic authorization: fc
530
530
  config.username = 'ACCOUNT ID'
531
- config.password = 'AUTH TOKEN'
531
+ config.password = 'API KEY'
532
532
  end
533
533
 
534
534
  api_instance = Freeclimb::DefaultApi.new
@@ -579,7 +579,7 @@ require 'freeclimb'
579
579
  Freeclimb.configure do |config|
580
580
  # Configure HTTP basic authorization: fc
581
581
  config.username = 'ACCOUNT ID'
582
- config.password = 'AUTH TOKEN'
582
+ config.password = 'API KEY'
583
583
  end
584
584
 
585
585
  api_instance = Freeclimb::DefaultApi.new
@@ -630,7 +630,7 @@ require 'freeclimb'
630
630
  Freeclimb.configure do |config|
631
631
  # Configure HTTP basic authorization: fc
632
632
  config.username = 'ACCOUNT ID'
633
- config.password = 'AUTH TOKEN'
633
+ config.password = 'API KEY'
634
634
  end
635
635
 
636
636
  api_instance = Freeclimb::DefaultApi.new
@@ -681,7 +681,7 @@ require 'freeclimb'
681
681
  Freeclimb.configure do |config|
682
682
  # Configure HTTP basic authorization: fc
683
683
  config.username = 'ACCOUNT ID'
684
- config.password = 'AUTH TOKEN'
684
+ config.password = 'API KEY'
685
685
  end
686
686
 
687
687
  api_instance = Freeclimb::DefaultApi.new
@@ -732,7 +732,7 @@ require 'freeclimb'
732
732
  Freeclimb.configure do |config|
733
733
  # Configure HTTP basic authorization: fc
734
734
  config.username = 'ACCOUNT ID'
735
- config.password = 'AUTH TOKEN'
735
+ config.password = 'API KEY'
736
736
  end
737
737
 
738
738
  api_instance = Freeclimb::DefaultApi.new
@@ -783,7 +783,7 @@ require 'freeclimb'
783
783
  Freeclimb.configure do |config|
784
784
  # Configure HTTP basic authorization: fc
785
785
  config.username = 'ACCOUNT ID'
786
- config.password = 'AUTH TOKEN'
786
+ config.password = 'API KEY'
787
787
  end
788
788
 
789
789
  api_instance = Freeclimb::DefaultApi.new
@@ -836,7 +836,7 @@ require 'freeclimb'
836
836
  Freeclimb.configure do |config|
837
837
  # Configure HTTP basic authorization: fc
838
838
  config.username = 'ACCOUNT ID'
839
- config.password = 'AUTH TOKEN'
839
+ config.password = 'API KEY'
840
840
  end
841
841
 
842
842
  api_instance = Freeclimb::DefaultApi.new
@@ -889,7 +889,7 @@ require 'freeclimb'
889
889
  Freeclimb.configure do |config|
890
890
  # Configure HTTP basic authorization: fc
891
891
  config.username = 'ACCOUNT ID'
892
- config.password = 'AUTH TOKEN'
892
+ config.password = 'API KEY'
893
893
  end
894
894
 
895
895
  api_instance = Freeclimb::DefaultApi.new
@@ -940,7 +940,7 @@ require 'freeclimb'
940
940
  Freeclimb.configure do |config|
941
941
  # Configure HTTP basic authorization: fc
942
942
  config.username = 'ACCOUNT ID'
943
- config.password = 'AUTH TOKEN'
943
+ config.password = 'API KEY'
944
944
  end
945
945
 
946
946
  api_instance = Freeclimb::DefaultApi.new
@@ -991,7 +991,7 @@ require 'freeclimb'
991
991
  Freeclimb.configure do |config|
992
992
  # Configure HTTP basic authorization: fc
993
993
  config.username = 'ACCOUNT ID'
994
- config.password = 'AUTH TOKEN'
994
+ config.password = 'API KEY'
995
995
  end
996
996
 
997
997
  api_instance = Freeclimb::DefaultApi.new
@@ -1042,7 +1042,7 @@ require 'freeclimb'
1042
1042
  Freeclimb.configure do |config|
1043
1043
  # Configure HTTP basic authorization: fc
1044
1044
  config.username = 'ACCOUNT ID'
1045
- config.password = 'AUTH TOKEN'
1045
+ config.password = 'API KEY'
1046
1046
  end
1047
1047
 
1048
1048
  api_instance = Freeclimb::DefaultApi.new
@@ -1093,7 +1093,7 @@ require 'freeclimb'
1093
1093
  Freeclimb.configure do |config|
1094
1094
  # Configure HTTP basic authorization: fc
1095
1095
  config.username = 'ACCOUNT ID'
1096
- config.password = 'AUTH TOKEN'
1096
+ config.password = 'API KEY'
1097
1097
  end
1098
1098
 
1099
1099
  api_instance = Freeclimb::DefaultApi.new
@@ -1144,7 +1144,7 @@ require 'freeclimb'
1144
1144
  Freeclimb.configure do |config|
1145
1145
  # Configure HTTP basic authorization: fc
1146
1146
  config.username = 'ACCOUNT ID'
1147
- config.password = 'AUTH TOKEN'
1147
+ config.password = 'API KEY'
1148
1148
  end
1149
1149
 
1150
1150
  api_instance = Freeclimb::DefaultApi.new
@@ -1195,7 +1195,7 @@ require 'freeclimb'
1195
1195
  Freeclimb.configure do |config|
1196
1196
  # Configure HTTP basic authorization: fc
1197
1197
  config.username = 'ACCOUNT ID'
1198
- config.password = 'AUTH TOKEN'
1198
+ config.password = 'API KEY'
1199
1199
  end
1200
1200
 
1201
1201
  api_instance = Freeclimb::DefaultApi.new
@@ -1248,7 +1248,7 @@ require 'freeclimb'
1248
1248
  Freeclimb.configure do |config|
1249
1249
  # Configure HTTP basic authorization: fc
1250
1250
  config.username = 'ACCOUNT ID'
1251
- config.password = 'AUTH TOKEN'
1251
+ config.password = 'API KEY'
1252
1252
  end
1253
1253
 
1254
1254
  api_instance = Freeclimb::DefaultApi.new
@@ -1295,7 +1295,7 @@ require 'freeclimb'
1295
1295
  Freeclimb.configure do |config|
1296
1296
  # Configure HTTP basic authorization: fc
1297
1297
  config.username = 'ACCOUNT ID'
1298
- config.password = 'AUTH TOKEN'
1298
+ config.password = 'API KEY'
1299
1299
  end
1300
1300
 
1301
1301
  api_instance = Freeclimb::DefaultApi.new
@@ -1348,7 +1348,7 @@ require 'freeclimb'
1348
1348
  Freeclimb.configure do |config|
1349
1349
  # Configure HTTP basic authorization: fc
1350
1350
  config.username = 'ACCOUNT ID'
1351
- config.password = 'AUTH TOKEN'
1351
+ config.password = 'API KEY'
1352
1352
  end
1353
1353
 
1354
1354
  api_instance = Freeclimb::DefaultApi.new
@@ -1403,7 +1403,7 @@ require 'freeclimb'
1403
1403
  Freeclimb.configure do |config|
1404
1404
  # Configure HTTP basic authorization: fc
1405
1405
  config.username = 'ACCOUNT ID'
1406
- config.password = 'AUTH TOKEN'
1406
+ config.password = 'API KEY'
1407
1407
  end
1408
1408
 
1409
1409
  api_instance = Freeclimb::DefaultApi.new
@@ -1454,7 +1454,7 @@ require 'freeclimb'
1454
1454
  Freeclimb.configure do |config|
1455
1455
  # Configure HTTP basic authorization: fc
1456
1456
  config.username = 'ACCOUNT ID'
1457
- config.password = 'AUTH TOKEN'
1457
+ config.password = 'API KEY'
1458
1458
  end
1459
1459
 
1460
1460
  api_instance = Freeclimb::DefaultApi.new
@@ -1509,7 +1509,7 @@ require 'freeclimb'
1509
1509
  Freeclimb.configure do |config|
1510
1510
  # Configure HTTP basic authorization: fc
1511
1511
  config.username = 'ACCOUNT ID'
1512
- config.password = 'AUTH TOKEN'
1512
+ config.password = 'API KEY'
1513
1513
  end
1514
1514
 
1515
1515
  api_instance = Freeclimb::DefaultApi.new
@@ -1572,7 +1572,7 @@ require 'freeclimb'
1572
1572
  Freeclimb.configure do |config|
1573
1573
  # Configure HTTP basic authorization: fc
1574
1574
  config.username = 'ACCOUNT ID'
1575
- config.password = 'AUTH TOKEN'
1575
+ config.password = 'API KEY'
1576
1576
  end
1577
1577
 
1578
1578
  api_instance = Freeclimb::DefaultApi.new
@@ -1631,7 +1631,7 @@ require 'freeclimb'
1631
1631
  Freeclimb.configure do |config|
1632
1632
  # Configure HTTP basic authorization: fc
1633
1633
  config.username = 'ACCOUNT ID'
1634
- config.password = 'AUTH TOKEN'
1634
+ config.password = 'API KEY'
1635
1635
  end
1636
1636
 
1637
1637
  api_instance = Freeclimb::DefaultApi.new
@@ -1686,7 +1686,7 @@ require 'freeclimb'
1686
1686
  Freeclimb.configure do |config|
1687
1687
  # Configure HTTP basic authorization: fc
1688
1688
  config.username = 'ACCOUNT ID'
1689
- config.password = 'AUTH TOKEN'
1689
+ config.password = 'API KEY'
1690
1690
  end
1691
1691
 
1692
1692
  api_instance = Freeclimb::DefaultApi.new
@@ -1737,7 +1737,7 @@ require 'freeclimb'
1737
1737
  Freeclimb.configure do |config|
1738
1738
  # Configure HTTP basic authorization: fc
1739
1739
  config.username = 'ACCOUNT ID'
1740
- config.password = 'AUTH TOKEN'
1740
+ config.password = 'API KEY'
1741
1741
  end
1742
1742
 
1743
1743
  api_instance = Freeclimb::DefaultApi.new
@@ -1794,7 +1794,7 @@ require 'freeclimb'
1794
1794
  Freeclimb.configure do |config|
1795
1795
  # Configure HTTP basic authorization: fc
1796
1796
  config.username = 'ACCOUNT ID'
1797
- config.password = 'AUTH TOKEN'
1797
+ config.password = 'API KEY'
1798
1798
  end
1799
1799
 
1800
1800
  api_instance = Freeclimb::DefaultApi.new
@@ -1851,7 +1851,7 @@ require 'freeclimb'
1851
1851
  Freeclimb.configure do |config|
1852
1852
  # Configure HTTP basic authorization: fc
1853
1853
  config.username = 'ACCOUNT ID'
1854
- config.password = 'AUTH TOKEN'
1854
+ config.password = 'API KEY'
1855
1855
  end
1856
1856
 
1857
1857
  api_instance = Freeclimb::DefaultApi.new
@@ -1914,7 +1914,7 @@ require 'freeclimb'
1914
1914
  Freeclimb.configure do |config|
1915
1915
  # Configure HTTP basic authorization: fc
1916
1916
  config.username = 'ACCOUNT ID'
1917
- config.password = 'AUTH TOKEN'
1917
+ config.password = 'API KEY'
1918
1918
  end
1919
1919
 
1920
1920
  api_instance = Freeclimb::DefaultApi.new
@@ -1967,7 +1967,7 @@ require 'freeclimb'
1967
1967
  Freeclimb.configure do |config|
1968
1968
  # Configure HTTP basic authorization: fc
1969
1969
  config.username = 'ACCOUNT ID'
1970
- config.password = 'AUTH TOKEN'
1970
+ config.password = 'API KEY'
1971
1971
  end
1972
1972
 
1973
1973
  api_instance = Freeclimb::DefaultApi.new
@@ -2019,7 +2019,7 @@ require 'freeclimb'
2019
2019
  Freeclimb.configure do |config|
2020
2020
  # Configure HTTP basic authorization: fc
2021
2021
  config.username = 'ACCOUNT ID'
2022
- config.password = 'AUTH TOKEN'
2022
+ config.password = 'API KEY'
2023
2023
  end
2024
2024
 
2025
2025
  api_instance = Freeclimb::DefaultApi.new
@@ -2070,7 +2070,7 @@ require 'freeclimb'
2070
2070
  Freeclimb.configure do |config|
2071
2071
  # Configure HTTP basic authorization: fc
2072
2072
  config.username = 'ACCOUNT ID'
2073
- config.password = 'AUTH TOKEN'
2073
+ config.password = 'API KEY'
2074
2074
  end
2075
2075
 
2076
2076
  api_instance = Freeclimb::DefaultApi.new
@@ -2121,7 +2121,7 @@ require 'freeclimb'
2121
2121
  Freeclimb.configure do |config|
2122
2122
  # Configure HTTP basic authorization: fc
2123
2123
  config.username = 'ACCOUNT ID'
2124
- config.password = 'AUTH TOKEN'
2124
+ config.password = 'API KEY'
2125
2125
  end
2126
2126
 
2127
2127
  api_instance = Freeclimb::DefaultApi.new
@@ -2176,7 +2176,7 @@ require 'freeclimb'
2176
2176
  Freeclimb.configure do |config|
2177
2177
  # Configure HTTP basic authorization: fc
2178
2178
  config.username = 'ACCOUNT ID'
2179
- config.password = 'AUTH TOKEN'
2179
+ config.password = 'API KEY'
2180
2180
  end
2181
2181
 
2182
2182
  api_instance = Freeclimb::DefaultApi.new
@@ -2228,7 +2228,7 @@ require 'freeclimb'
2228
2228
  Freeclimb.configure do |config|
2229
2229
  # Configure HTTP basic authorization: fc
2230
2230
  config.username = 'ACCOUNT ID'
2231
- config.password = 'AUTH TOKEN'
2231
+ config.password = 'API KEY'
2232
2232
  end
2233
2233
 
2234
2234
  api_instance = Freeclimb::DefaultApi.new
@@ -2285,7 +2285,7 @@ require 'freeclimb'
2285
2285
  Freeclimb.configure do |config|
2286
2286
  # Configure HTTP basic authorization: fc
2287
2287
  config.username = 'ACCOUNT ID'
2288
- config.password = 'AUTH TOKEN'
2288
+ config.password = 'API KEY'
2289
2289
  end
2290
2290
 
2291
2291
  api_instance = Freeclimb::DefaultApi.new
@@ -2340,7 +2340,7 @@ require 'freeclimb'
2340
2340
  Freeclimb.configure do |config|
2341
2341
  # Configure HTTP basic authorization: fc
2342
2342
  config.username = 'ACCOUNT ID'
2343
- config.password = 'AUTH TOKEN'
2343
+ config.password = 'API KEY'
2344
2344
  end
2345
2345
 
2346
2346
  api_instance = Freeclimb::DefaultApi.new
@@ -2392,7 +2392,7 @@ require 'freeclimb'
2392
2392
  Freeclimb.configure do |config|
2393
2393
  # Configure HTTP basic authorization: fc
2394
2394
  config.username = 'ACCOUNT ID'
2395
- config.password = 'AUTH TOKEN'
2395
+ config.password = 'API KEY'
2396
2396
  end
2397
2397
 
2398
2398
  api_instance = Freeclimb::DefaultApi.new
@@ -2447,7 +2447,7 @@ require 'freeclimb'
2447
2447
  Freeclimb.configure do |config|
2448
2448
  # Configure HTTP basic authorization: fc
2449
2449
  config.username = 'ACCOUNT ID'
2450
- config.password = 'AUTH TOKEN'
2450
+ config.password = 'API KEY'
2451
2451
  end
2452
2452
 
2453
2453
  api_instance = Freeclimb::DefaultApi.new
@@ -6,13 +6,14 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **from** | **String** | Phone number to use as the caller ID. This can be: (a) The To or From number provided in FreeClimb&#39;s initial request to your app or (b) Any incoming phone number you have purchased from FreeClimb. |
8
8
  **to** | **String** | Phone number to place the Call to. |
9
- **application_id** | **String** | ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the &#x60;callConnectUrl&#x60; and &#x60;statusCallbackUrl&#x60; set on the application. The application must have a &#x60;callConnectUrl&#x60; associated with it or an error will be returned. The application’s &#x60;voiceUrl&#x60; parameter is not used for outbound calls. |
9
+ **application_id** | **String** | Required if no &#x60;parentCallId&#x60; or &#x60;callConnectUrl&#x60; has been provided. ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the &#x60;callConnectUrl&#x60; and &#x60;statusCallbackUrl&#x60; set on the application unless the &#x60;callConnectUrl&#x60; attribute is also provided with the request. In this case, the URL specified in that &#x60;callConnectUrl&#x60; attribute will be used as a replacement of the &#x60;callConnectUrl&#x60; originally assigned in the application. If the &#x60;callConnectUrl&#x60; is not set as either an attribute of the request or as part of the specified application, an error will be provided. The application’s voiceUrl parameter is not used for outbound calls. | [optional]
10
10
  **send_digits** | **String** | String of digits to dial after connecting to the number. It can include digits &#x60;0-9&#x60;, &#x60;*&#x60;, and &#x60;#&#x60;, and allows embedding a pause between the output of individual digits. The default pause is 500 milliseconds. So, a string such as *1234#* will be played in 2 seconds because of the 4 standard pauses implied within the string. A custom pause is specified by including a positive integer wrapped in curly braces: {n}. For more information, see **sendDigits examples** below. | [optional]
11
11
  **if_machine** | **String** | Specifies how FreeClimb should handle this Call if an answering machine answers it. | [optional]
12
12
  **if_machine_url** | **String** | This attribute specifies a URL to which FreeClimb will make a POST request when an answering machine or a fax machine is detected. This URL is required if the ifMachine flag is set to redirect. When ifMachine is set to hangup, ifMachineUrl must not be included in the request. For more information, see **ifMachineUrl example** below. | [optional]
13
13
  **timeout** | **Integer** | Number of seconds that FreeClimb should allow the phone to ring before assuming there is no answer. Default is 30 seconds. Maximum allowed ring-time is determined by the target phone&#39;s provider. Note that most providers limit ring-time to 120 seconds. | [optional]
14
- **parent_call_id** | **String** | The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing. An outbound call is considered to be in progress once the outdialConnect or outdialApiConnect webhook is invoked. An inbound call is ringing when the inbound webhook is invoked. | [optional]
14
+ **parent_call_id** | **String** | Required if no &#x60;applicationId&#x60; or &#x60;callConnectUrl&#x60; has been provided. The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing. An outbound call is considered to be in progress once the &#x60;outdialConnect&#x60; or &#x60;outdialApiConnect&#x60; webhook is invoked. An inbound call is ringing when the inbound webhook is invoked. If a &#x60;callConnectUrl&#x60; attribute is also included with the &#x60;parentCallId&#x60; in the request, this URL will be used as a replacement of the &#x60;callConnectUrl&#x60; originally assigned in the parent call. | [optional]
15
15
  **privacy_mode** | **Boolean** | Activate privacy mode in order to obscure log data that can potentially expose private information. | [optional]
16
+ **call_connect_url** | **String** | The URL that FreeClimb should use to handle this phone call. If an applicationId or parentCallId have already been provided, this callConnectUrl attribute will be used as a replacement of the callConnectUrl originally assigned in the application or parent call. | [optional]
16
17
 
17
18
  ## Code Sample
18
19
 
@@ -27,7 +28,8 @@ instance = Freeclimb::MakeCallRequest.new(from: nil,
27
28
  if_machine_url: nil,
28
29
  timeout: nil,
29
30
  parent_call_id: nil,
30
- privacy_mode: nil)
31
+ privacy_mode: nil,
32
+ call_connect_url: nil)
31
33
  ```
32
34
 
33
35
 
Binary file
Binary file
Binary file
Binary file
@@ -30,7 +30,7 @@ module Freeclimb
30
30
  # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
31
31
  def initialize(config = Configuration.default)
32
32
  @config = config
33
- @user_agent = "FreeClimbSDK/2.1.1/ruby"
33
+ @user_agent = "FreeClimbSDK/3.0.1/ruby"
34
34
  @default_headers = {
35
35
  'Content-Type' => 'application/json',
36
36
  'User-Agent' => @user_agent
@@ -29,8 +29,8 @@ module Freeclimb
29
29
  # String that uniquely identifies this account resource.
30
30
  attr_accessor :account_id
31
31
 
32
- # The authorization token assigned to this account. This token must be kept a secret by the customer.
33
- attr_accessor :auth_token
32
+ # The API key assigned to this account. This key must be kept a secret by the customer.
33
+ attr_accessor :api_key
34
34
 
35
35
  # A description for this account.
36
36
  attr_accessor :_alias
@@ -77,7 +77,7 @@ module Freeclimb
77
77
  :'date_updated' => :'dateUpdated',
78
78
  :'revision' => :'revision',
79
79
  :'account_id' => :'accountId',
80
- :'auth_token' => :'authToken',
80
+ :'api_key' => :'apiKey',
81
81
  :'_alias' => :'alias',
82
82
  :'label' => :'label',
83
83
  :'type' => :'type',
@@ -94,7 +94,7 @@ module Freeclimb
94
94
  :'date_updated' => :'String',
95
95
  :'revision' => :'Integer',
96
96
  :'account_id' => :'String',
97
- :'auth_token' => :'String',
97
+ :'api_key' => :'String',
98
98
  :'_alias' => :'String',
99
99
  :'label' => :'String',
100
100
  :'type' => :'String',
@@ -152,8 +152,8 @@ module Freeclimb
152
152
  self.account_id = attributes[:'account_id']
153
153
  end
154
154
 
155
- if attributes.key?(:'auth_token')
156
- self.auth_token = attributes[:'auth_token']
155
+ if attributes.key?(:'api_key')
156
+ self.api_key = attributes[:'api_key']
157
157
  end
158
158
 
159
159
  if attributes.key?(:'_alias')
@@ -212,7 +212,7 @@ module Freeclimb
212
212
  date_updated == o.date_updated &&
213
213
  revision == o.revision &&
214
214
  account_id == o.account_id &&
215
- auth_token == o.auth_token &&
215
+ api_key == o.api_key &&
216
216
  _alias == o._alias &&
217
217
  label == o.label &&
218
218
  type == o.type &&
@@ -229,7 +229,7 @@ module Freeclimb
229
229
  # Calculates hash code according to all attributes.
230
230
  # @return [Integer] Hash code
231
231
  def hash
232
- [uri, date_created, date_updated, revision, account_id, auth_token, _alias, label, type, status, subresource_uris].hash
232
+ [uri, date_created, date_updated, revision, account_id, api_key, _alias, label, type, status, subresource_uris].hash
233
233
  end
234
234
 
235
235
  # Builds the object from hash
@@ -17,8 +17,8 @@ module Freeclimb
17
17
  # String that uniquely identifies this account resource.
18
18
  attr_accessor :account_id
19
19
 
20
- # The authorization token assigned to this account. This token must be kept a secret by the customer.
21
- attr_accessor :auth_token
20
+ # The API key assigned to this account. This key must be kept a secret by the customer.
21
+ attr_accessor :api_key
22
22
 
23
23
  # A description for this account.
24
24
  attr_accessor :_alias
@@ -61,7 +61,7 @@ module Freeclimb
61
61
  def self.attribute_map
62
62
  {
63
63
  :'account_id' => :'accountId',
64
- :'auth_token' => :'authToken',
64
+ :'api_key' => :'apiKey',
65
65
  :'_alias' => :'alias',
66
66
  :'label' => :'label',
67
67
  :'type' => :'type',
@@ -74,7 +74,7 @@ module Freeclimb
74
74
  def self.openapi_types
75
75
  {
76
76
  :'account_id' => :'String',
77
- :'auth_token' => :'String',
77
+ :'api_key' => :'String',
78
78
  :'_alias' => :'String',
79
79
  :'label' => :'String',
80
80
  :'type' => :'String',
@@ -108,8 +108,8 @@ module Freeclimb
108
108
  self.account_id = attributes[:'account_id']
109
109
  end
110
110
 
111
- if attributes.key?(:'auth_token')
112
- self.auth_token = attributes[:'auth_token']
111
+ if attributes.key?(:'api_key')
112
+ self.api_key = attributes[:'api_key']
113
113
  end
114
114
 
115
115
  if attributes.key?(:'_alias')
@@ -164,7 +164,7 @@ module Freeclimb
164
164
  return true if self.equal?(o)
165
165
  self.class == o.class &&
166
166
  account_id == o.account_id &&
167
- auth_token == o.auth_token &&
167
+ api_key == o.api_key &&
168
168
  _alias == o._alias &&
169
169
  label == o.label &&
170
170
  type == o.type &&
@@ -181,7 +181,7 @@ module Freeclimb
181
181
  # Calculates hash code according to all attributes.
182
182
  # @return [Integer] Hash code
183
183
  def hash
184
- [account_id, auth_token, _alias, label, type, status, subresource_uris].hash
184
+ [account_id, api_key, _alias, label, type, status, subresource_uris].hash
185
185
  end
186
186
 
187
187
  # Builds the object from hash
@@ -158,10 +158,6 @@ module Freeclimb
158
158
  invalid_properties.push('invalid value for "conference_id", conference_id cannot be nil.')
159
159
  end
160
160
 
161
- if @call_id.nil?
162
- invalid_properties.push('invalid value for "call_id", call_id cannot be nil.')
163
- end
164
-
165
161
  invalid_properties
166
162
  end
167
163
 
@@ -169,7 +165,6 @@ module Freeclimb
169
165
  # @return true if the model is valid
170
166
  def valid?
171
167
  return false if @conference_id.nil?
172
- return false if @call_id.nil?
173
168
  true && super
174
169
  end
175
170
 
@@ -146,10 +146,6 @@ module Freeclimb
146
146
  invalid_properties.push('invalid value for "conference_id", conference_id cannot be nil.')
147
147
  end
148
148
 
149
- if @call_id.nil?
150
- invalid_properties.push('invalid value for "call_id", call_id cannot be nil.')
151
- end
152
-
153
149
  invalid_properties
154
150
  end
155
151
 
@@ -157,7 +153,6 @@ module Freeclimb
157
153
  # @return true if the model is valid
158
154
  def valid?
159
155
  return false if @conference_id.nil?
160
- return false if @call_id.nil?
161
156
  true
162
157
  end
163
158
 
@@ -44,6 +44,9 @@ module Freeclimb
44
44
  # If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI).
45
45
  attr_accessor :phone_number_id
46
46
 
47
+ # Whether the call is currently active or has concluded.
48
+ attr_accessor :active
49
+
47
50
  # * `queued` &ndash; Call is ready and waiting in line before going out. * `ringing` &ndash; Call is currently ringing. * `inProgress` &ndash; Call was answered and is currently in progress. * `canceled` &ndash; Call was hung up while it was queued or ringing. * `completed` &ndash; Call was answered and has ended normally. * `busy` &ndash; Caller received a busy signal. * `failed` &ndash; Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` &ndash; Call ended without being answered.
48
51
  attr_accessor :status
49
52
 
@@ -106,6 +109,7 @@ module Freeclimb
106
109
  :'from' => :'from',
107
110
  :'to' => :'to',
108
111
  :'phone_number_id' => :'phoneNumberId',
112
+ :'active' => :'active',
109
113
  :'status' => :'status',
110
114
  :'start_time' => :'startTime',
111
115
  :'connect_time' => :'connectTime',
@@ -131,6 +135,7 @@ module Freeclimb
131
135
  :'from' => :'String',
132
136
  :'to' => :'String',
133
137
  :'phone_number_id' => :'String',
138
+ :'active' => :'Boolean',
134
139
  :'status' => :'String',
135
140
  :'start_time' => :'String',
136
141
  :'connect_time' => :'String',
@@ -212,6 +217,12 @@ module Freeclimb
212
217
  self.phone_number_id = attributes[:'phone_number_id']
213
218
  end
214
219
 
220
+ if attributes.key?(:'active')
221
+ self.active = attributes[:'active']
222
+ else
223
+ self.active = false
224
+ end
225
+
215
226
  if attributes.key?(:'status')
216
227
  self.status = attributes[:'status']
217
228
  end
@@ -289,6 +300,7 @@ module Freeclimb
289
300
  from == o.from &&
290
301
  to == o.to &&
291
302
  phone_number_id == o.phone_number_id &&
303
+ active == o.active &&
292
304
  status == o.status &&
293
305
  start_time == o.start_time &&
294
306
  connect_time == o.connect_time &&
@@ -309,7 +321,7 @@ module Freeclimb
309
321
  # Calculates hash code according to all attributes.
310
322
  # @return [Integer] Hash code
311
323
  def hash
312
- [uri, date_created, date_updated, revision, call_id, parent_call_id, account_id, from, to, phone_number_id, status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris].hash
324
+ [uri, date_created, date_updated, revision, call_id, parent_call_id, account_id, from, to, phone_number_id, active, status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris].hash
313
325
  end
314
326
 
315
327
  # Builds the object from hash
@@ -32,6 +32,9 @@ module Freeclimb
32
32
  # If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI).
33
33
  attr_accessor :phone_number_id
34
34
 
35
+ # Whether the call is currently active or has concluded.
36
+ attr_accessor :active
37
+
35
38
  # * `queued` &ndash; Call is ready and waiting in line before going out. * `ringing` &ndash; Call is currently ringing. * `inProgress` &ndash; Call was answered and is currently in progress. * `canceled` &ndash; Call was hung up while it was queued or ringing. * `completed` &ndash; Call was answered and has ended normally. * `busy` &ndash; Caller received a busy signal. * `failed` &ndash; Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` &ndash; Call ended without being answered.
36
39
  attr_accessor :status
37
40
 
@@ -90,6 +93,7 @@ module Freeclimb
90
93
  :'from' => :'from',
91
94
  :'to' => :'to',
92
95
  :'phone_number_id' => :'phoneNumberId',
96
+ :'active' => :'active',
93
97
  :'status' => :'status',
94
98
  :'start_time' => :'startTime',
95
99
  :'connect_time' => :'connectTime',
@@ -111,6 +115,7 @@ module Freeclimb
111
115
  :'from' => :'String',
112
116
  :'to' => :'String',
113
117
  :'phone_number_id' => :'String',
118
+ :'active' => :'Boolean',
114
119
  :'status' => :'String',
115
120
  :'start_time' => :'String',
116
121
  :'connect_time' => :'String',
@@ -168,6 +173,12 @@ module Freeclimb
168
173
  self.phone_number_id = attributes[:'phone_number_id']
169
174
  end
170
175
 
176
+ if attributes.key?(:'active')
177
+ self.active = attributes[:'active']
178
+ else
179
+ self.active = false
180
+ end
181
+
171
182
  if attributes.key?(:'status')
172
183
  self.status = attributes[:'status']
173
184
  end
@@ -241,6 +252,7 @@ module Freeclimb
241
252
  from == o.from &&
242
253
  to == o.to &&
243
254
  phone_number_id == o.phone_number_id &&
255
+ active == o.active &&
244
256
  status == o.status &&
245
257
  start_time == o.start_time &&
246
258
  connect_time == o.connect_time &&
@@ -261,7 +273,7 @@ module Freeclimb
261
273
  # Calculates hash code according to all attributes.
262
274
  # @return [Integer] Hash code
263
275
  def hash
264
- [call_id, parent_call_id, account_id, from, to, phone_number_id, status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris].hash
276
+ [call_id, parent_call_id, account_id, from, to, phone_number_id, active, status, start_time, connect_time, end_time, duration, connect_duration, direction, answered_by, subresource_uris].hash
265
277
  end
266
278
 
267
279
  # Builds the object from hash
@@ -20,7 +20,7 @@ module Freeclimb
20
20
  # Phone number to place the Call to.
21
21
  attr_accessor :to
22
22
 
23
- # ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the `callConnectUrl` and `statusCallbackUrl` set on the application. The application must have a `callConnectUrl` associated with it or an error will be returned. The application’s `voiceUrl` parameter is not used for outbound calls.
23
+ # Required if no `parentCallId` or `callConnectUrl` has been provided. ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the `callConnectUrl` and `statusCallbackUrl` set on the application unless the `callConnectUrl` attribute is also provided with the request. In this case, the URL specified in that `callConnectUrl` attribute will be used as a replacement of the `callConnectUrl` originally assigned in the application. If the `callConnectUrl` is not set as either an attribute of the request or as part of the specified application, an error will be provided. The application’s voiceUrl parameter is not used for outbound calls.
24
24
  attr_accessor :application_id
25
25
 
26
26
  # String of digits to dial after connecting to the number. It can include digits `0-9`, `*`, and `#`, and allows embedding a pause between the output of individual digits. The default pause is 500 milliseconds. So, a string such as *1234#* will be played in 2 seconds because of the 4 standard pauses implied within the string. A custom pause is specified by including a positive integer wrapped in curly braces: {n}. For more information, see **sendDigits examples** below.
@@ -35,12 +35,15 @@ module Freeclimb
35
35
  # Number of seconds that FreeClimb should allow the phone to ring before assuming there is no answer. Default is 30 seconds. Maximum allowed ring-time is determined by the target phone's provider. Note that most providers limit ring-time to 120 seconds.
36
36
  attr_accessor :timeout
37
37
 
38
- # The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing. An outbound call is considered to be in progress once the outdialConnect or outdialApiConnect webhook is invoked. An inbound call is ringing when the inbound webhook is invoked.
38
+ # Required if no `applicationId` or `callConnectUrl` has been provided. The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing. An outbound call is considered to be in progress once the `outdialConnect` or `outdialApiConnect` webhook is invoked. An inbound call is ringing when the inbound webhook is invoked. If a `callConnectUrl` attribute is also included with the `parentCallId` in the request, this URL will be used as a replacement of the `callConnectUrl` originally assigned in the parent call.
39
39
  attr_accessor :parent_call_id
40
40
 
41
41
  # Activate privacy mode in order to obscure log data that can potentially expose private information.
42
42
  attr_accessor :privacy_mode
43
43
 
44
+ # The URL that FreeClimb should use to handle this phone call. If an applicationId or parentCallId have already been provided, this callConnectUrl attribute will be used as a replacement of the callConnectUrl originally assigned in the application or parent call.
45
+ attr_accessor :call_connect_url
46
+
44
47
  # Attribute mapping from ruby-style variable name to JSON key.
45
48
  def self.attribute_map
46
49
  {
@@ -52,7 +55,8 @@ module Freeclimb
52
55
  :'if_machine_url' => :'ifMachineUrl',
53
56
  :'timeout' => :'timeout',
54
57
  :'parent_call_id' => :'parentCallId',
55
- :'privacy_mode' => :'privacyMode'
58
+ :'privacy_mode' => :'privacyMode',
59
+ :'call_connect_url' => :'callConnectUrl'
56
60
  }
57
61
  end
58
62
 
@@ -67,7 +71,8 @@ module Freeclimb
67
71
  :'if_machine_url' => :'String',
68
72
  :'timeout' => :'Integer',
69
73
  :'parent_call_id' => :'String',
70
- :'privacy_mode' => :'Boolean'
74
+ :'privacy_mode' => :'Boolean',
75
+ :'call_connect_url' => :'String'
71
76
  }
72
77
  end
73
78
 
@@ -127,6 +132,10 @@ module Freeclimb
127
132
  if attributes.key?(:'privacy_mode')
128
133
  self.privacy_mode = attributes[:'privacy_mode']
129
134
  end
135
+
136
+ if attributes.key?(:'call_connect_url')
137
+ self.call_connect_url = attributes[:'call_connect_url']
138
+ end
130
139
  end
131
140
 
132
141
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -141,10 +150,6 @@ module Freeclimb
141
150
  invalid_properties.push('invalid value for "to", to cannot be nil.')
142
151
  end
143
152
 
144
- if @application_id.nil?
145
- invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
146
- end
147
-
148
153
  invalid_properties
149
154
  end
150
155
 
@@ -153,7 +158,6 @@ module Freeclimb
153
158
  def valid?
154
159
  return false if @from.nil?
155
160
  return false if @to.nil?
156
- return false if @application_id.nil?
157
161
  true
158
162
  end
159
163
 
@@ -170,7 +174,8 @@ module Freeclimb
170
174
  if_machine_url == o.if_machine_url &&
171
175
  timeout == o.timeout &&
172
176
  parent_call_id == o.parent_call_id &&
173
- privacy_mode == o.privacy_mode
177
+ privacy_mode == o.privacy_mode &&
178
+ call_connect_url == o.call_connect_url
174
179
  end
175
180
 
176
181
  # @see the `==` method
@@ -182,7 +187,7 @@ module Freeclimb
182
187
  # Calculates hash code according to all attributes.
183
188
  # @return [Integer] Hash code
184
189
  def hash
185
- [from, to, application_id, send_digits, if_machine, if_machine_url, timeout, parent_call_id, privacy_mode].hash
190
+ [from, to, application_id, send_digits, if_machine, if_machine_url, timeout, parent_call_id, privacy_mode, call_connect_url].hash
186
191
  end
187
192
 
188
193
  # Builds the object from hash
@@ -0,0 +1,34 @@
1
+ require 'json'
2
+ require 'cgi'
3
+ require 'date'
4
+ require 'openssl'
5
+
6
+ module FreeClimb
7
+ class Utils
8
+ def self.verify_request(requestBody, signatureHeader, signingSecret, tolerance=5*60*1000)
9
+ signatureArr = signatureHeader.split(',')
10
+ signatureHash = {}
11
+ signatureArr.each { |queryStr|
12
+ hash = CGI.parse(queryStr)
13
+ if (signatureHash.key?(hash.keys[0]))
14
+ signatureHash[hash.keys[0]] = [signatureHash[hash.keys[0]]].append(hash.values[0][0])
15
+ else
16
+ signatureHash[hash.keys[0]] = hash.values[0][0]
17
+ end
18
+ }
19
+
20
+ currentTime = DateTime.now.strftime('%s')
21
+ signatureAge = currentTime.to_i - signatureHash["t"].to_i
22
+ if (tolerance < signatureAge)
23
+ raise StandardError.new "Request rejected - signature's timestamp failed against current tolerance of #{tolerance} milliseconds. Signature age: #{signatureAge} milliseconds";
24
+ end
25
+
26
+ data = signatureHash["t"] + "." + requestBody
27
+ hmac = OpenSSL::HMAC.hexdigest('sha256', signingSecret, data)
28
+
29
+ if (!signatureHash["v1"].include? hmac)
30
+ raise StandardError.new "Unverified Request Signature - FreeClimb was unable to verify that this request originated from FreeClimb. If this request was unexpected, it may be from a bad actor. Please proceed with caution. If this request was expected, to fix this issue try checking for any typos or misspelling of your signing secret.";
31
+ end
32
+ end
33
+ end
34
+ end
@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.0-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module Freeclimb
14
- VERSION = '2.1.1'
14
+ VERSION = '3.0.1'
15
15
  end
data/lib/freeclimb.rb CHANGED
@@ -15,6 +15,7 @@ require 'freeclimb/api_client'
15
15
  require 'freeclimb/api_error'
16
16
  require 'freeclimb/version'
17
17
  require 'freeclimb/configuration'
18
+ require 'freeclimb/utils'
18
19
  require 'freeclimb/models/percl_command'
19
20
 
20
21
  # Models
@@ -171,7 +171,7 @@ module ResponseMocks
171
171
  "dateCreated":"Thu, 13 Oct 2019 16:59:34 GMT",
172
172
  "dateUpdated":"Thu, 13 Oct 2019 16:59:34 GMT",
173
173
  "accountId":"{account_id}",
174
- "authToken":"428e487a035b837ac2f47f2236ec553550ed2628",
174
+ "apiKey":"428e487a035b837ac2f47f2236ec553550ed2628",
175
175
  "alias":"boostrap account",
176
176
  "label":"customer service",
177
177
  "type":"trial",
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: freeclimb
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.1.1
4
+ version: 3.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAPI-Generator
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-02-16 00:00:00.000000000 Z
11
+ date: 2021-11-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -194,6 +194,10 @@ files:
194
194
  - docs/UpdateConferenceRequest.md
195
195
  - freeclimb-2.0.3.gem
196
196
  - freeclimb-2.1.0.gem
197
+ - freeclimb-2.1.1.gem
198
+ - freeclimb-2.1.2.gem
199
+ - freeclimb-2.2.0.gem
200
+ - freeclimb-3.0.0.gem
197
201
  - freeclimb.gemspec
198
202
  - lib/freeclimb.rb
199
203
  - lib/freeclimb/api/default_api.rb
@@ -302,6 +306,7 @@ files:
302
306
  - lib/freeclimb/models/update_call_request.rb
303
307
  - lib/freeclimb/models/update_conference_participant_request.rb
304
308
  - lib/freeclimb/models/update_conference_request.rb
309
+ - lib/freeclimb/utils.rb
305
310
  - lib/freeclimb/version.rb
306
311
  - spec/api/default_api_spec.rb
307
312
  - spec/api/web_mocks.rb
@@ -373,7 +378,7 @@ homepage: https://freeclimb.com
373
378
  licenses:
374
379
  - Unlicense
375
380
  metadata: {}
376
- post_install_message:
381
+ post_install_message:
377
382
  rdoc_options: []
378
383
  require_paths:
379
384
  - lib
@@ -389,7 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
389
394
  version: '0'
390
395
  requirements: []
391
396
  rubygems_version: 3.0.3
392
- signing_key:
397
+ signing_key:
393
398
  specification_version: 4
394
399
  summary: FreeClimb API Ruby Gem
395
400
  test_files: