freeclimb 2.0.0 → 2.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +95 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +11 -4
  5. data/docs/DefaultApi.md +16 -24
  6. data/docs/GetDigits.md +3 -1
  7. data/docs/GetDigitsAllOf.md +3 -1
  8. data/docs/GetSpeech.md +2 -2
  9. data/docs/GetSpeechAllOf.md +2 -2
  10. data/docs/Hangup.md +17 -0
  11. data/docs/HangupAllOf.md +17 -0
  12. data/docs/MakeCallRequest.md +3 -1
  13. data/docs/MessageResult.md +1 -1
  14. data/docs/MessageResultAllOf.md +1 -1
  15. data/docs/OutDial.md +3 -1
  16. data/docs/OutDialAllOf.md +3 -1
  17. data/docs/Play.md +3 -1
  18. data/docs/PlayAllOf.md +3 -1
  19. data/docs/RecordUtterance.md +3 -1
  20. data/docs/RecordUtteranceAllOf.md +3 -1
  21. data/docs/Redirect.md +1 -1
  22. data/docs/RedirectAllOf.md +1 -1
  23. data/docs/Reject.md +17 -0
  24. data/docs/RejectAllOf.md +17 -0
  25. data/docs/Say.md +2 -2
  26. data/docs/SayAllOf.md +2 -2
  27. data/docs/SendDigits.md +3 -1
  28. data/docs/SendDigitsAllOf.md +3 -1
  29. data/freeclimb-2.0.3.gem +0 -0
  30. data/freeclimb-2.1.0.gem +0 -0
  31. data/lib/freeclimb.rb +4 -0
  32. data/lib/freeclimb/api/default_api.rb +40 -24
  33. data/lib/freeclimb/api_client.rb +1 -1
  34. data/lib/freeclimb/models/get_digits.rb +14 -4
  35. data/lib/freeclimb/models/get_digits_all_of.rb +14 -4
  36. data/lib/freeclimb/models/get_speech.rb +8 -8
  37. data/lib/freeclimb/models/get_speech_all_of.rb +8 -8
  38. data/lib/freeclimb/models/hangup.rb +220 -0
  39. data/lib/freeclimb/models/hangup_all_of.rb +207 -0
  40. data/lib/freeclimb/models/make_call_request.rb +14 -4
  41. data/lib/freeclimb/models/message_result.rb +3 -3
  42. data/lib/freeclimb/models/message_result_all_of.rb +3 -3
  43. data/lib/freeclimb/models/out_dial.rb +14 -4
  44. data/lib/freeclimb/models/out_dial_all_of.rb +14 -4
  45. data/lib/freeclimb/models/play.rb +14 -4
  46. data/lib/freeclimb/models/play_all_of.rb +14 -4
  47. data/lib/freeclimb/models/record_utterance.rb +14 -4
  48. data/lib/freeclimb/models/record_utterance_all_of.rb +14 -4
  49. data/lib/freeclimb/models/redirect.rb +7 -2
  50. data/lib/freeclimb/models/redirect_all_of.rb +6 -1
  51. data/lib/freeclimb/models/reject.rb +220 -0
  52. data/lib/freeclimb/models/reject_all_of.rb +207 -0
  53. data/lib/freeclimb/models/say.rb +8 -8
  54. data/lib/freeclimb/models/say_all_of.rb +8 -8
  55. data/lib/freeclimb/models/send_digits.rb +14 -4
  56. data/lib/freeclimb/models/send_digits_all_of.rb +14 -4
  57. data/lib/freeclimb/version.rb +1 -1
  58. data/spec/api/default_api_spec.rb +7 -14
  59. data/spec/models/hangup_spec.rb +41 -0
  60. data/spec/models/reject_spec.rb +41 -0
  61. metadata +17 -2
data/docs/OutDial.md CHANGED
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **send_digits** | **String** | DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension. | [optional]
14
14
  **status_callback_url** | **String** | When the outdialed Call leg terminates, FreeClimb sends a `callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored. | [optional]
15
15
  **timeout** | **Integer** | Maximum time in seconds the `OutDial` command waits for the called party to answer the Call. When a timeout occurs, FreeClimb invokes the `callConnectUrl` Webhook to report that the out-dialed Call has ended with a status of `noAnswer`. | [optional]
16
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
16
17
 
17
18
  ## Code Sample
18
19
 
@@ -27,7 +28,8 @@ instance = Freeclimb::OutDial.new(action_url: nil,
27
28
  if_machine_url: nil,
28
29
  send_digits: nil,
29
30
  status_callback_url: nil,
30
- timeout: nil)
31
+ timeout: nil,
32
+ privacy_mode: nil)
31
33
  ```
32
34
 
33
35
 
data/docs/OutDialAllOf.md CHANGED
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **send_digits** | **String** | DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension. | [optional]
14
14
  **status_callback_url** | **String** | When the outdialed Call leg terminates, FreeClimb sends a `callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored. | [optional]
15
15
  **timeout** | **Integer** | Maximum time in seconds the `OutDial` command waits for the called party to answer the Call. When a timeout occurs, FreeClimb invokes the `callConnectUrl` Webhook to report that the out-dialed Call has ended with a status of `noAnswer`. | [optional]
16
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
16
17
 
17
18
  ## Code Sample
18
19
 
@@ -27,7 +28,8 @@ instance = Freeclimb::OutDialAllOf.new(action_url: nil,
27
28
  if_machine_url: nil,
28
29
  send_digits: nil,
29
30
  status_callback_url: nil,
30
- timeout: nil)
31
+ timeout: nil,
32
+ privacy_mode: nil)
31
33
  ```
32
34
 
33
35
 
data/docs/Play.md CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **file** | **String** | RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands. |
8
8
  **loop** | **Integer** | Number of times the audio file is played. Specifying '0' causes the Play action to loop until the Call is hung up. | [optional]
9
9
  **conference_id** | **String** | ID of the Conference the audio should be rendered to. If this is not specified, the audio is by default rendered to the caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional]
10
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
10
11
 
11
12
  ## Code Sample
12
13
 
@@ -15,7 +16,8 @@ require 'freeclimb'
15
16
 
16
17
  instance = Freeclimb::Play.new(file: nil,
17
18
  loop: nil,
18
- conference_id: nil)
19
+ conference_id: nil,
20
+ privacy_mode: nil)
19
21
  ```
20
22
 
21
23
 
data/docs/PlayAllOf.md CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **file** | **String** | RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands. |
8
8
  **loop** | **Integer** | Number of times the audio file is played. Specifying '0' causes the Play action to loop until the Call is hung up. | [optional]
9
9
  **conference_id** | **String** | ID of the Conference the audio should be rendered to. If this is not specified, the audio is by default rendered to the caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional]
10
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
10
11
 
11
12
  ## Code Sample
12
13
 
@@ -15,7 +16,8 @@ require 'freeclimb'
15
16
 
16
17
  instance = Freeclimb::PlayAllOf.new(file: nil,
17
18
  loop: nil,
18
- conference_id: nil)
19
+ conference_id: nil,
20
+ privacy_mode: nil)
19
21
  ```
20
22
 
21
23
 
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional]
11
11
  **play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional]
12
12
  **auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional]
13
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
13
14
 
14
15
  ## Code Sample
15
16
 
@@ -21,7 +22,8 @@ instance = Freeclimb::RecordUtterance.new(action_url: nil,
21
22
  finish_on_key: nil,
22
23
  max_length_sec: nil,
23
24
  play_beep: nil,
24
- auto_start: nil)
25
+ auto_start: nil,
26
+ privacy_mode: nil)
25
27
  ```
26
28
 
27
29
 
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional]
11
11
  **play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional]
12
12
  **auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional]
13
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
13
14
 
14
15
  ## Code Sample
15
16
 
@@ -21,7 +22,8 @@ instance = Freeclimb::RecordUtteranceAllOf.new(action_url: nil,
21
22
  finish_on_key: nil,
22
23
  max_length_sec: nil,
23
24
  play_beep: nil,
24
- auto_start: nil)
25
+ auto_start: nil,
26
+ privacy_mode: nil)
25
27
  ```
26
28
 
27
29
 
data/docs/Redirect.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **action_url** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional]
7
+ **action_url** | **String** | URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call. |
8
8
 
9
9
  ## Code Sample
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **action_url** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional]
7
+ **action_url** | **String** | URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call. |
8
8
 
9
9
  ## Code Sample
10
10
 
data/docs/Reject.md ADDED
@@ -0,0 +1,17 @@
1
+ # Freeclimb::Reject
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **reason** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'freeclimb'
13
+
14
+ instance = Freeclimb::Reject.new(reason: nil)
15
+ ```
16
+
17
+
@@ -0,0 +1,17 @@
1
+ # Freeclimb::RejectAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **reason** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'freeclimb'
13
+
14
+ instance = Freeclimb::RejectAllOf.new(reason: nil)
15
+ ```
16
+
17
+
data/docs/Say.md CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **language** | **String** | Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below. | [optional]
9
9
  **loop** | **Integer** | Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up. | [optional]
10
10
  **conference_id** | **String** | D of the Conference the speech should be rendered to. If this is not specified, the speech is by default rendered to the Caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional]
11
- **enforce_pci** | **Boolean** | Parameter `enforcePCI` will not log the `text` as required by PCI compliance. | [optional]
11
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
12
12
 
13
13
  ## Code Sample
14
14
 
@@ -19,7 +19,7 @@ instance = Freeclimb::Say.new(text: nil,
19
19
  language: nil,
20
20
  loop: nil,
21
21
  conference_id: nil,
22
- enforce_pci: nil)
22
+ privacy_mode: nil)
23
23
  ```
24
24
 
25
25
 
data/docs/SayAllOf.md CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **language** | **String** | Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below. | [optional]
9
9
  **loop** | **Integer** | Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up. | [optional]
10
10
  **conference_id** | **String** | D of the Conference the speech should be rendered to. If this is not specified, the speech is by default rendered to the Caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional]
11
- **enforce_pci** | **Boolean** | Parameter `enforcePCI` will not log the `text` as required by PCI compliance. | [optional]
11
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
12
12
 
13
13
  ## Code Sample
14
14
 
@@ -19,7 +19,7 @@ instance = Freeclimb::SayAllOf.new(text: nil,
19
19
  language: nil,
20
20
  loop: nil,
21
21
  conference_id: nil,
22
- enforce_pci: nil)
22
+ privacy_mode: nil)
23
23
  ```
24
24
 
25
25
 
data/docs/SendDigits.md CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **digits** | **String** | String containing the digits to be played. The string cannot be empty and can include any digit, plus `#`, or `*`, and allows embedding specification for delay or pause between the output of individual digits. |
8
8
  **pause_ms** | **Integer** | Pause between digits in milliseconds. Valid values are 100-1000 milliseconds and will be adjusted by FreeClimb to satisfy the constraint. | [optional]
9
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
9
10
 
10
11
  ## Code Sample
11
12
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
13
14
  require 'freeclimb'
14
15
 
15
16
  instance = Freeclimb::SendDigits.new(digits: nil,
16
- pause_ms: nil)
17
+ pause_ms: nil,
18
+ privacy_mode: nil)
17
19
  ```
18
20
 
19
21
 
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **digits** | **String** | String containing the digits to be played. The string cannot be empty and can include any digit, plus `#`, or `*`, and allows embedding specification for delay or pause between the output of individual digits. |
8
8
  **pause_ms** | **Integer** | Pause between digits in milliseconds. Valid values are 100-1000 milliseconds and will be adjusted by FreeClimb to satisfy the constraint. | [optional]
9
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
9
10
 
10
11
  ## Code Sample
11
12
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
13
14
  require 'freeclimb'
14
15
 
15
16
  instance = Freeclimb::SendDigitsAllOf.new(digits: nil,
16
- pause_ms: nil)
17
+ pause_ms: nil,
18
+ privacy_mode: nil)
17
19
  ```
18
20
 
19
21
 
Binary file
Binary file
data/lib/freeclimb.rb CHANGED
@@ -55,6 +55,8 @@ require 'freeclimb/models/get_digits'
55
55
  require 'freeclimb/models/get_digits_all_of'
56
56
  require 'freeclimb/models/get_speech'
57
57
  require 'freeclimb/models/get_speech_all_of'
58
+ require 'freeclimb/models/hangup'
59
+ require 'freeclimb/models/hangup_all_of'
58
60
  require 'freeclimb/models/incoming_number_list'
59
61
  require 'freeclimb/models/incoming_number_list_all_of'
60
62
  require 'freeclimb/models/incoming_number_request'
@@ -98,6 +100,8 @@ require 'freeclimb/models/recording_result'
98
100
  require 'freeclimb/models/recording_result_all_of'
99
101
  require 'freeclimb/models/redirect'
100
102
  require 'freeclimb/models/redirect_all_of'
103
+ require 'freeclimb/models/reject'
104
+ require 'freeclimb/models/reject_all_of'
101
105
  require 'freeclimb/models/remove_from_conference'
102
106
  require 'freeclimb/models/remove_from_conference_all_of'
103
107
  require 'freeclimb/models/say'
@@ -79,22 +79,26 @@ module Freeclimb
79
79
  end
80
80
 
81
81
  # Buy a Phone Number
82
+ # @param buy_incoming_number_request [BuyIncomingNumberRequest] Incoming Number transaction details
82
83
  # @param [Hash] opts the optional parameters
83
- # @option opts [BuyIncomingNumberRequest] :buy_incoming_number_request Incoming Number transaction details
84
84
  # @return [IncomingNumberResult]
85
- def buy_a_phone_number(opts = {})
86
- data, _status_code, _headers = buy_a_phone_number_with_http_info(opts)
85
+ def buy_a_phone_number(buy_incoming_number_request, opts = {})
86
+ data, _status_code, _headers = buy_a_phone_number_with_http_info(buy_incoming_number_request, opts)
87
87
  data
88
88
  end
89
89
 
90
90
  # Buy a Phone Number
91
+ # @param buy_incoming_number_request [BuyIncomingNumberRequest] Incoming Number transaction details
91
92
  # @param [Hash] opts the optional parameters
92
- # @option opts [BuyIncomingNumberRequest] :buy_incoming_number_request Incoming Number transaction details
93
93
  # @return [Array<(IncomingNumberResult, Integer, Hash)>] IncomingNumberResult data, response status code and response headers
94
- def buy_a_phone_number_with_http_info(opts = {})
94
+ def buy_a_phone_number_with_http_info(buy_incoming_number_request, opts = {})
95
95
  if @api_client.config.debugging
96
96
  @api_client.config.logger.debug 'Calling API: DefaultApi.buy_a_phone_number ...'
97
97
  end
98
+ # verify the required parameter 'buy_incoming_number_request' is set
99
+ if @api_client.config.client_side_validation && buy_incoming_number_request.nil?
100
+ fail ArgumentError, "Missing the required parameter 'buy_incoming_number_request' when calling DefaultApi.buy_a_phone_number"
101
+ end
98
102
  # resource path
99
103
  local_var_path = '/Accounts/{accountId}/IncomingPhoneNumbers'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))
100
104
 
@@ -112,7 +116,7 @@ module Freeclimb
112
116
  form_params = opts[:form_params] || {}
113
117
 
114
118
  # http body (model)
115
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'buy_incoming_number_request'])
119
+ post_body = opts[:body] || @api_client.object_to_http_body(buy_incoming_number_request)
116
120
 
117
121
  # return_type
118
122
  return_type = opts[:return_type] || 'IncomingNumberResult'
@@ -671,22 +675,26 @@ module Freeclimb
671
675
  end
672
676
 
673
677
  # Filter Logs
678
+ # @param filter_logs_request [FilterLogsRequest] Filter logs request paramters
674
679
  # @param [Hash] opts the optional parameters
675
- # @option opts [FilterLogsRequest] :filter_logs_request Filter logs request paramters
676
680
  # @return [LogList]
677
- def filter_logs(opts = {})
678
- data, _status_code, _headers = filter_logs_with_http_info(opts)
681
+ def filter_logs(filter_logs_request, opts = {})
682
+ data, _status_code, _headers = filter_logs_with_http_info(filter_logs_request, opts)
679
683
  data
680
684
  end
681
685
 
682
686
  # Filter Logs
687
+ # @param filter_logs_request [FilterLogsRequest] Filter logs request paramters
683
688
  # @param [Hash] opts the optional parameters
684
- # @option opts [FilterLogsRequest] :filter_logs_request Filter logs request paramters
685
689
  # @return [Array<(LogList, Integer, Hash)>] LogList data, response status code and response headers
686
- def filter_logs_with_http_info(opts = {})
690
+ def filter_logs_with_http_info(filter_logs_request, opts = {})
687
691
  if @api_client.config.debugging
688
692
  @api_client.config.logger.debug 'Calling API: DefaultApi.filter_logs ...'
689
693
  end
694
+ # verify the required parameter 'filter_logs_request' is set
695
+ if @api_client.config.client_side_validation && filter_logs_request.nil?
696
+ fail ArgumentError, "Missing the required parameter 'filter_logs_request' when calling DefaultApi.filter_logs"
697
+ end
690
698
  # resource path
691
699
  local_var_path = '/Accounts/{accountId}/Logs'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))
692
700
 
@@ -704,7 +712,7 @@ module Freeclimb
704
712
  form_params = opts[:form_params] || {}
705
713
 
706
714
  # http body (model)
707
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'filter_logs_request'])
715
+ post_body = opts[:body] || @api_client.object_to_http_body(filter_logs_request)
708
716
 
709
717
  # return_type
710
718
  return_type = opts[:return_type] || 'LogList'
@@ -2273,22 +2281,26 @@ module Freeclimb
2273
2281
  end
2274
2282
 
2275
2283
  # Send an SMS Message
2284
+ # @param message_request [MessageRequest] Details to create a message
2276
2285
  # @param [Hash] opts the optional parameters
2277
- # @option opts [MessageRequest] :message_request Details to create a message
2278
2286
  # @return [MessageResult]
2279
- def send_an_sms_message(opts = {})
2280
- data, _status_code, _headers = send_an_sms_message_with_http_info(opts)
2287
+ def send_an_sms_message(message_request, opts = {})
2288
+ data, _status_code, _headers = send_an_sms_message_with_http_info(message_request, opts)
2281
2289
  data
2282
2290
  end
2283
2291
 
2284
2292
  # Send an SMS Message
2293
+ # @param message_request [MessageRequest] Details to create a message
2285
2294
  # @param [Hash] opts the optional parameters
2286
- # @option opts [MessageRequest] :message_request Details to create a message
2287
2295
  # @return [Array<(MessageResult, Integer, Hash)>] MessageResult data, response status code and response headers
2288
- def send_an_sms_message_with_http_info(opts = {})
2296
+ def send_an_sms_message_with_http_info(message_request, opts = {})
2289
2297
  if @api_client.config.debugging
2290
2298
  @api_client.config.logger.debug 'Calling API: DefaultApi.send_an_sms_message ...'
2291
2299
  end
2300
+ # verify the required parameter 'message_request' is set
2301
+ if @api_client.config.client_side_validation && message_request.nil?
2302
+ fail ArgumentError, "Missing the required parameter 'message_request' when calling DefaultApi.send_an_sms_message"
2303
+ end
2292
2304
  # resource path
2293
2305
  local_var_path = '/Accounts/{accountId}/Messages'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))
2294
2306
 
@@ -2306,7 +2318,7 @@ module Freeclimb
2306
2318
  form_params = opts[:form_params] || {}
2307
2319
 
2308
2320
  # http body (model)
2309
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'message_request'])
2321
+ post_body = opts[:body] || @api_client.object_to_http_body(message_request)
2310
2322
 
2311
2323
  # return_type
2312
2324
  return_type = opts[:return_type] || 'MessageResult'
@@ -2456,20 +2468,20 @@ module Freeclimb
2456
2468
 
2457
2469
  # Update a Live Call
2458
2470
  # @param call_id [String] String that uniquely identifies this call resource.
2471
+ # @param update_call_request [UpdateCallRequest] Call details to update
2459
2472
  # @param [Hash] opts the optional parameters
2460
- # @option opts [UpdateCallRequest] :update_call_request Call details to update
2461
2473
  # @return [nil]
2462
- def update_a_live_call(call_id, opts = {})
2463
- update_a_live_call_with_http_info(call_id, opts)
2474
+ def update_a_live_call(call_id, update_call_request, opts = {})
2475
+ update_a_live_call_with_http_info(call_id, update_call_request, opts)
2464
2476
  nil
2465
2477
  end
2466
2478
 
2467
2479
  # Update a Live Call
2468
2480
  # @param call_id [String] String that uniquely identifies this call resource.
2481
+ # @param update_call_request [UpdateCallRequest] Call details to update
2469
2482
  # @param [Hash] opts the optional parameters
2470
- # @option opts [UpdateCallRequest] :update_call_request Call details to update
2471
2483
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2472
- def update_a_live_call_with_http_info(call_id, opts = {})
2484
+ def update_a_live_call_with_http_info(call_id, update_call_request, opts = {})
2473
2485
  if @api_client.config.debugging
2474
2486
  @api_client.config.logger.debug 'Calling API: DefaultApi.update_a_live_call ...'
2475
2487
  end
@@ -2477,6 +2489,10 @@ module Freeclimb
2477
2489
  if @api_client.config.client_side_validation && call_id.nil?
2478
2490
  fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.update_a_live_call"
2479
2491
  end
2492
+ # verify the required parameter 'update_call_request' is set
2493
+ if @api_client.config.client_side_validation && update_call_request.nil?
2494
+ fail ArgumentError, "Missing the required parameter 'update_call_request' when calling DefaultApi.update_a_live_call"
2495
+ end
2480
2496
  # resource path
2481
2497
  local_var_path = '/Accounts/{accountId}/Calls/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s))
2482
2498
 
@@ -2492,7 +2508,7 @@ module Freeclimb
2492
2508
  form_params = opts[:form_params] || {}
2493
2509
 
2494
2510
  # http body (model)
2495
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'update_call_request'])
2511
+ post_body = opts[:body] || @api_client.object_to_http_body(update_call_request)
2496
2512
 
2497
2513
  # return_type
2498
2514
  return_type = opts[:return_type]
@@ -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.0.0/ruby"
33
+ @user_agent = "FreeClimbSDK/2.1.1/ruby"
34
34
  @default_headers = {
35
35
  'Content-Type' => 'application/json',
36
36
  'User-Agent' => @user_agent
@@ -39,6 +39,9 @@ module Freeclimb
39
39
  # JSON array of PerCL commands to nest within the `GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller.
40
40
  attr_accessor :prompts
41
41
 
42
+ # Parameter `privacyMode` will not log the `text` as required by PCI compliance.
43
+ attr_accessor :privacy_mode
44
+
42
45
  # Attribute mapping from ruby-style variable name to JSON key.
43
46
  def self.attribute_map
44
47
  {
@@ -49,7 +52,8 @@ module Freeclimb
49
52
  :'initial_timeout_ms' => :'initialTimeoutMs',
50
53
  :'max_digits' => :'maxDigits',
51
54
  :'min_digits' => :'minDigits',
52
- :'prompts' => :'prompts'
55
+ :'prompts' => :'prompts',
56
+ :'privacy_mode' => :'privacyMode'
53
57
  }
54
58
  end
55
59
 
@@ -63,7 +67,8 @@ module Freeclimb
63
67
  :'initial_timeout_ms' => :'String',
64
68
  :'max_digits' => :'Integer',
65
69
  :'min_digits' => :'Integer',
66
- :'prompts' => :'Array<PerclCommand>'
70
+ :'prompts' => :'Array<PerclCommand>',
71
+ :'privacy_mode' => :'Boolean'
67
72
  }
68
73
  end
69
74
 
@@ -132,6 +137,10 @@ module Freeclimb
132
137
  self.prompts = value
133
138
  end
134
139
  end
140
+
141
+ if attributes.key?(:'privacy_mode')
142
+ self.privacy_mode = attributes[:'privacy_mode']
143
+ end
135
144
  end
136
145
 
137
146
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -164,7 +173,8 @@ module Freeclimb
164
173
  initial_timeout_ms == o.initial_timeout_ms &&
165
174
  max_digits == o.max_digits &&
166
175
  min_digits == o.min_digits &&
167
- prompts == o.prompts && super(o)
176
+ prompts == o.prompts &&
177
+ privacy_mode == o.privacy_mode && super(o)
168
178
  end
169
179
 
170
180
  # @see the `==` method
@@ -176,7 +186,7 @@ module Freeclimb
176
186
  # Calculates hash code according to all attributes.
177
187
  # @return [Integer] Hash code
178
188
  def hash
179
- [action_url, digit_timeout_ms, finish_on_key, flush_buffer, initial_timeout_ms, max_digits, min_digits, prompts].hash
189
+ [action_url, digit_timeout_ms, finish_on_key, flush_buffer, initial_timeout_ms, max_digits, min_digits, prompts, privacy_mode].hash
180
190
  end
181
191
 
182
192
  # Builds the object from hash