freeclimb 2.1.1 → 2.1.2
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/README.md +4 -4
- data/docs/MakeCallRequest.md +5 -3
- data/freeclimb-2.1.1.gem +0 -0
- data/lib/freeclimb/api_client.rb +1 -1
- data/lib/freeclimb/models/make_call_request.rb +16 -11
- data/lib/freeclimb/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 74fbd3e95a615cbce3500873c8a4327c1c7d75196ff38ce887bdd10186973ab6
|
4
|
+
data.tar.gz: dc982f026dee3aacb7ef6a36ef73ac6b8957cffc40e111e3a546345ee6f4a8ee
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6beb69d6d9abfe2a17ebf688f64b218655b6bdb2bc30bcc532374d9bd7a619265689f95194dc108009db41d1011b450cc7abb192be8e0ea81dbcb15740fca82e
|
7
|
+
data.tar.gz: 3ea6744cbcca10ed7a9f48a6762f371351f453543b05aeba154e41c31cc4254af850872ff9b1583e97324c6d611f254c5a131c4b5efb31cea576e2dd2b1a15b1
|
data/CHANGELOG.md
CHANGED
@@ -7,6 +7,11 @@ 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="2.1.2"></a>
|
11
|
+
## [2.1.2] - 2021-03-10
|
12
|
+
### Added
|
13
|
+
- Add `callConnectUrl` option to MakeACall Request
|
14
|
+
|
10
15
|
|
11
16
|
<a name="2.1.1"></a>
|
12
17
|
## [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.
|
8
|
+
- Package version: 2.1.2
|
9
9
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
10
10
|
|
11
11
|
## Installation
|
@@ -21,16 +21,16 @@ gem build freeclimb.gemspec
|
|
21
21
|
Then either install the gem locally:
|
22
22
|
|
23
23
|
```shell
|
24
|
-
gem install ./freeclimb-2.1.
|
24
|
+
gem install ./freeclimb-2.1.2.gem
|
25
25
|
```
|
26
26
|
|
27
|
-
(for development, run `gem install --dev ./freeclimb-2.1.
|
27
|
+
(for development, run `gem install --dev ./freeclimb-2.1.2.gem` to install the development dependencies)
|
28
28
|
|
29
29
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
30
30
|
|
31
31
|
Finally add this to the Gemfile:
|
32
32
|
|
33
|
-
gem 'freeclimb', '~> 2.1.
|
33
|
+
gem 'freeclimb', '~> 2.1.2'
|
34
34
|
|
35
35
|
### Install from Ruby gems
|
36
36
|
```shell
|
data/docs/MakeCallRequest.md
CHANGED
@@ -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'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 `callConnectUrl` and `statusCallbackUrl` set on the application.
|
9
|
+
**application_id** | **String** | 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. | [optional]
|
10
10
|
**send_digits** | **String** | 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. | [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'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.
|
14
|
+
**parent_call_id** | **String** | 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. | [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
|
|
data/freeclimb-2.1.1.gem
ADDED
Binary file
|
data/lib/freeclimb/api_client.rb
CHANGED
@@ -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.
|
33
|
+
@user_agent = "FreeClimbSDK/2.1.2/ruby"
|
34
34
|
@default_headers = {
|
35
35
|
'Content-Type' => 'application/json',
|
36
36
|
'User-Agent' => @user_agent
|
@@ -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.
|
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.
|
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
|
data/lib/freeclimb/version.rb
CHANGED
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.
|
4
|
+
version: 2.1.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- OpenAPI-Generator
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-03-26 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -194,6 +194,7 @@ 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
|
197
198
|
- freeclimb.gemspec
|
198
199
|
- lib/freeclimb.rb
|
199
200
|
- lib/freeclimb/api/default_api.rb
|