freeclimb 1.0.3 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (82) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +89 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +11 -5
  5. data/docs/AccountRequest.md +1 -3
  6. data/docs/ApplicationRequest.md +1 -3
  7. data/docs/BuyIncomingNumberRequest.md +1 -3
  8. data/docs/CreateConferenceRequest.md +1 -3
  9. data/docs/DefaultApi.md +22 -38
  10. data/docs/FilterLogsRequest.md +1 -3
  11. data/docs/GetDigits.md +3 -1
  12. data/docs/GetDigitsAllOf.md +3 -1
  13. data/docs/GetSpeech.md +2 -2
  14. data/docs/GetSpeechAllOf.md +2 -2
  15. data/docs/Hangup.md +17 -0
  16. data/docs/HangupAllOf.md +17 -0
  17. data/docs/IncomingNumberRequest.md +1 -3
  18. data/docs/MakeCallRequest.md +3 -3
  19. data/docs/MessageRequest.md +0 -2
  20. data/docs/MessageRequestAllOf.md +0 -2
  21. data/docs/MessageResult.md +1 -1
  22. data/docs/MessageResultAllOf.md +1 -1
  23. data/docs/OutDial.md +3 -1
  24. data/docs/OutDialAllOf.md +3 -1
  25. data/docs/Play.md +3 -1
  26. data/docs/PlayAllOf.md +3 -1
  27. data/docs/QueueRequest.md +1 -3
  28. data/docs/Redirect.md +1 -1
  29. data/docs/RedirectAllOf.md +1 -1
  30. data/docs/Reject.md +17 -0
  31. data/docs/RejectAllOf.md +17 -0
  32. data/docs/Say.md +2 -2
  33. data/docs/SayAllOf.md +2 -2
  34. data/docs/SendDigits.md +3 -1
  35. data/docs/SendDigitsAllOf.md +3 -1
  36. data/docs/UpdateCallRequest.md +1 -3
  37. data/docs/UpdateConferenceParticipantRequest.md +1 -3
  38. data/docs/UpdateConferenceRequest.md +1 -3
  39. data/freeclimb-2.0.3.gem +0 -0
  40. data/lib/freeclimb.rb +4 -1
  41. data/lib/freeclimb/api/default_api.rb +42 -34
  42. data/lib/freeclimb/api_client.rb +1 -1
  43. data/lib/freeclimb/models/account_request.rb +4 -14
  44. data/lib/freeclimb/models/application_request.rb +4 -14
  45. data/lib/freeclimb/models/buy_incoming_number_request.rb +4 -14
  46. data/lib/freeclimb/models/create_conference_request.rb +4 -14
  47. data/lib/freeclimb/models/filter_logs_request.rb +4 -14
  48. data/lib/freeclimb/models/get_digits.rb +14 -4
  49. data/lib/freeclimb/models/get_digits_all_of.rb +14 -4
  50. data/lib/freeclimb/models/get_speech.rb +8 -8
  51. data/lib/freeclimb/models/get_speech_all_of.rb +8 -8
  52. data/lib/freeclimb/models/hangup.rb +220 -0
  53. data/lib/freeclimb/models/{dequeue_member_request.rb → hangup_all_of.rb} +11 -11
  54. data/lib/freeclimb/models/incoming_number_request.rb +4 -14
  55. data/lib/freeclimb/models/make_call_request.rb +14 -14
  56. data/lib/freeclimb/models/message_request.rb +1 -11
  57. data/lib/freeclimb/models/message_request_all_of.rb +1 -11
  58. data/lib/freeclimb/models/message_result.rb +3 -3
  59. data/lib/freeclimb/models/message_result_all_of.rb +3 -3
  60. data/lib/freeclimb/models/out_dial.rb +14 -4
  61. data/lib/freeclimb/models/out_dial_all_of.rb +14 -4
  62. data/lib/freeclimb/models/play.rb +14 -4
  63. data/lib/freeclimb/models/play_all_of.rb +14 -4
  64. data/lib/freeclimb/models/queue_request.rb +4 -14
  65. data/lib/freeclimb/models/redirect.rb +7 -2
  66. data/lib/freeclimb/models/redirect_all_of.rb +6 -1
  67. data/lib/freeclimb/models/reject.rb +220 -0
  68. data/lib/freeclimb/models/reject_all_of.rb +207 -0
  69. data/lib/freeclimb/models/say.rb +8 -8
  70. data/lib/freeclimb/models/say_all_of.rb +8 -8
  71. data/lib/freeclimb/models/send_digits.rb +14 -4
  72. data/lib/freeclimb/models/send_digits_all_of.rb +14 -4
  73. data/lib/freeclimb/models/update_call_request.rb +4 -14
  74. data/lib/freeclimb/models/update_conference_participant_request.rb +4 -14
  75. data/lib/freeclimb/models/update_conference_request.rb +4 -14
  76. data/lib/freeclimb/version.rb +1 -1
  77. data/spec/api/default_api_spec.rb +9 -24
  78. data/spec/models/hangup_spec.rb +41 -0
  79. data/spec/models/reject_spec.rb +41 -0
  80. metadata +16 -6
  81. data/docs/DequeueMemberRequest.md +0 -17
  82. data/spec/models/dequeue_member_request_spec.rb +0 -34
@@ -5,15 +5,13 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **pql** | **String** | The filter query for retrieving logs. See **Performance Query Language** below. |
8
- **request_id** | **String** | RequestId for this request starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>). | [optional]
9
8
 
10
9
  ## Code Sample
11
10
 
12
11
  ```ruby
13
12
  require 'freeclimb'
14
13
 
15
- instance = Freeclimb::FilterLogsRequest.new(pql: nil,
16
- request_id: nil)
14
+ instance = Freeclimb::FilterLogsRequest.new(pql: nil)
17
15
  ```
18
16
 
19
17
 
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **max_digits** | **Integer** | Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the `GetDigits` command terminates regardless of the value of `finishOnKey`. | [optional]
13
13
  **min_digits** | **Integer** | Minimum number of digits expected in the input. If specified, FreeClimb will return the collected digits only if the Caller has entered at least that many digits. | [optional]
14
14
  **prompts** | [**Array<PerclCommand>**](PerclCommand.md) | 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. | [optional]
15
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
15
16
 
16
17
  ## Code Sample
17
18
 
@@ -25,7 +26,8 @@ instance = Freeclimb::GetDigits.new(action_url: nil,
25
26
  initial_timeout_ms: nil,
26
27
  max_digits: nil,
27
28
  min_digits: nil,
28
- prompts: nil)
29
+ prompts: nil,
30
+ privacy_mode: nil)
29
31
  ```
30
32
 
31
33
 
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **max_digits** | **Integer** | Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the `GetDigits` command terminates regardless of the value of `finishOnKey`. | [optional]
13
13
  **min_digits** | **Integer** | Minimum number of digits expected in the input. If specified, FreeClimb will return the collected digits only if the Caller has entered at least that many digits. | [optional]
14
14
  **prompts** | [**Array<PerclCommand>**](PerclCommand.md) | 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. | [optional]
15
+ **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
15
16
 
16
17
  ## Code Sample
17
18
 
@@ -25,7 +26,8 @@ instance = Freeclimb::GetDigitsAllOf.new(action_url: nil,
25
26
  initial_timeout_ms: nil,
26
27
  max_digits: nil,
27
28
  min_digits: nil,
28
- prompts: nil)
29
+ prompts: nil,
30
+ privacy_mode: nil)
29
31
  ```
30
32
 
31
33
 
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
16
16
  **sensitivity_level** | **Float** | The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0 | [optional]
17
17
  **speech_complete_timeout_ms** | **Integer** | Parameter `speechCompleteTimeoutMs` specifies the length of silence required following user speech before the speech recognizer finalizes a result. This timeout applies when the recognizer currently has a complete match against an active grammar. Reasonable speech complete timeout values are typically in the range of 0.3 seconds to 1.0 seconds. | [optional]
18
18
  **speech_incomplete_timeout_ms** | **Integer** | Parameter `speechIncompleteTimeoutMs` specifies the length of silence following user speech after which a recognizer finalizes a result. This timeout applies when the speech prior to the silence is an incomplete match of all active grammars. Timeout `speechIncompleteTimeoutMs` is usually longer than `speechCompleteTimeoutMs` to allow users to pause mid-utterance. | [optional]
19
- **enforce_pci** | **Boolean** | Parameter enforcePCI will not log the `text` as required by PCI compliance. | [optional]
19
+ **privacy_mode** | **Boolean** | Parameter privacyMode will not log the `text` as required by PCI compliance. | [optional]
20
20
 
21
21
  ## Code Sample
22
22
 
@@ -35,7 +35,7 @@ instance = Freeclimb::GetSpeech.new(action_url: nil,
35
35
  sensitivity_level: nil,
36
36
  speech_complete_timeout_ms: nil,
37
37
  speech_incomplete_timeout_ms: nil,
38
- enforce_pci: nil)
38
+ privacy_mode: nil)
39
39
  ```
40
40
 
41
41
 
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
16
16
  **sensitivity_level** | **Float** | The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0 | [optional]
17
17
  **speech_complete_timeout_ms** | **Integer** | Parameter `speechCompleteTimeoutMs` specifies the length of silence required following user speech before the speech recognizer finalizes a result. This timeout applies when the recognizer currently has a complete match against an active grammar. Reasonable speech complete timeout values are typically in the range of 0.3 seconds to 1.0 seconds. | [optional]
18
18
  **speech_incomplete_timeout_ms** | **Integer** | Parameter `speechIncompleteTimeoutMs` specifies the length of silence following user speech after which a recognizer finalizes a result. This timeout applies when the speech prior to the silence is an incomplete match of all active grammars. Timeout `speechIncompleteTimeoutMs` is usually longer than `speechCompleteTimeoutMs` to allow users to pause mid-utterance. | [optional]
19
- **enforce_pci** | **Boolean** | Parameter enforcePCI will not log the `text` as required by PCI compliance. | [optional]
19
+ **privacy_mode** | **Boolean** | Parameter privacyMode will not log the `text` as required by PCI compliance. | [optional]
20
20
 
21
21
  ## Code Sample
22
22
 
@@ -35,7 +35,7 @@ instance = Freeclimb::GetSpeechAllOf.new(action_url: nil,
35
35
  sensitivity_level: nil,
36
36
  speech_complete_timeout_ms: nil,
37
37
  speech_incomplete_timeout_ms: nil,
38
- enforce_pci: nil)
38
+ privacy_mode: nil)
39
39
  ```
40
40
 
41
41
 
@@ -0,0 +1,17 @@
1
+ # Freeclimb::Hangup
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **reason** | **String** | The user defined reason for the hangup. 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::Hangup.new(reason: nil)
15
+ ```
16
+
17
+
@@ -0,0 +1,17 @@
1
+ # Freeclimb::HangupAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **reason** | **String** | The user defined reason for the hangup. 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::HangupAllOf.new(reason: nil)
15
+ ```
16
+
17
+
@@ -6,7 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **application_id** | **String** | ID of the Application that should handle calls to this number. | [optional]
8
8
  **_alias** | **String** | Description for this phone number. | [optional]
9
- **request_id** | **String** | RequestId for this request starting with prefix `RQ` followed by 40 hexadecimal characters. FreeClimb logs that are generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g., `X-Pulse-Request-Id: <requestId>`). | [optional]
10
9
 
11
10
  ## Code Sample
12
11
 
@@ -14,8 +13,7 @@ Name | Type | Description | Notes
14
13
  require 'freeclimb'
15
14
 
16
15
  instance = Freeclimb::IncomingNumberRequest.new(application_id: nil,
17
- _alias: nil,
18
- request_id: nil)
16
+ _alias: nil)
19
17
  ```
20
18
 
21
19
 
@@ -11,8 +11,8 @@ Name | Type | Description | Notes
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
- **request_id** | **String** | The requestId for this request starting with prefix \"RQ\" followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g. `X-Pulse-Request-Id: <requestId>`). | [optional]
15
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]
15
+ **privacy_mode** | **Boolean** | Activate privacy mode in order to obscure log data that can potentially expose private information. | [optional]
16
16
 
17
17
  ## Code Sample
18
18
 
@@ -26,8 +26,8 @@ instance = Freeclimb::MakeCallRequest.new(from: nil,
26
26
  if_machine: nil,
27
27
  if_machine_url: nil,
28
28
  timeout: nil,
29
- request_id: nil,
30
- parent_call_id: nil)
29
+ parent_call_id: nil,
30
+ privacy_mode: nil)
31
31
  ```
32
32
 
33
33
 
@@ -12,7 +12,6 @@ Name | Type | Description | Notes
12
12
  **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. |
13
13
  **text** | **String** | Text contained in the message (maximum 160 characters). **Note:** For text, only ASCII characters are supported. |
14
14
  **notification_url** | **String** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored. | [optional]
15
- **request_id** | **String** | RequestId for this request, starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>). | [optional]
16
15
  **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
17
16
 
18
17
  ## Code Sample
@@ -28,7 +27,6 @@ instance = Freeclimb::MessageRequest.new(uri: nil,
28
27
  to: nil,
29
28
  text: nil,
30
29
  notification_url: nil,
31
- request_id: nil,
32
30
  account_id: nil)
33
31
  ```
34
32
 
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
8
8
  **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. |
9
9
  **text** | **String** | Text contained in the message (maximum 160 characters). **Note:** For text, only ASCII characters are supported. |
10
10
  **notification_url** | **String** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored. | [optional]
11
- **request_id** | **String** | RequestId for this request, starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>). | [optional]
12
11
  **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
13
12
 
14
13
  ## Code Sample
@@ -20,7 +19,6 @@ instance = Freeclimb::MessageRequestAllOf.new(from: nil,
20
19
  to: nil,
21
20
  text: nil,
22
21
  notification_url: nil,
23
- request_id: nil,
24
22
  account_id: nil)
25
23
  ```
26
24
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
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
12
  **message_id** | **String** | String that uniquely identifies this message resource | [optional]
13
- **status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received | [optional]
13
+ **status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional]
14
14
  **from** | **String** | Phone number in E.164 format that sent the message. | [optional]
15
15
  **to** | **String** | Phone number in E.164 format that received the message. | [optional]
16
16
  **text** | **String** | Message contents | [optional]
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
8
8
  **message_id** | **String** | String that uniquely identifies this message resource | [optional]
9
- **status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received | [optional]
9
+ **status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional]
10
10
  **from** | **String** | Phone number in E.164 format that sent the message. | [optional]
11
11
  **to** | **String** | Phone number in E.164 format that received the message. | [optional]
12
12
  **text** | **String** | Message contents | [optional]
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -6,7 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **_alias** | **String** | Description for this Queue. Max length is 64 characters. | [optional]
8
8
  **max_size** | **Integer** | Maximum number of calls this queue can hold. Default is 100. Maximum is 1000. **Note:** Reducing the maxSize of a Queue causes the Queue to reject incoming requests until it shrinks below the new value of maxSize. | [optional]
9
- **request_id** | **String** | RequestId for this request, starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request include this requestId. If this parameter is not provided, FreeClimb generates a requestId and returns it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>). | [optional]
10
9
 
11
10
  ## Code Sample
12
11
 
@@ -14,8 +13,7 @@ Name | Type | Description | Notes
14
13
  require 'freeclimb'
15
14
 
16
15
  instance = Freeclimb::QueueRequest.new(_alias: nil,
17
- max_size: nil,
18
- request_id: nil)
16
+ max_size: nil)
19
17
  ```
20
18
 
21
19
 
@@ -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
 
@@ -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
+
@@ -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
 
@@ -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
 
@@ -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
 
@@ -5,15 +5,13 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **status** | **String** | Either `canceled` or `completed`. Specifying `canceled` attempts to hang up calls that are queued without affecting calls already in progress. Specifying `completed` attempts to hang up a call already in progress. |
8
- **request_id** | **String** | RequestId for this request starting with prefix `RQ` followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g. `X-Pulse-Request-Id: <requestId>`). | [optional]
9
8
 
10
9
  ## Code Sample
11
10
 
12
11
  ```ruby
13
12
  require 'freeclimb'
14
13
 
15
- instance = Freeclimb::UpdateCallRequest.new(status: nil,
16
- request_id: nil)
14
+ instance = Freeclimb::UpdateCallRequest.new(status: nil)
17
15
  ```
18
16
 
19
17