freeclimb 2.0.0 → 2.1.1

data/lib/freeclimb/models/make_call_request.rb

@@ -38,6 +38,9 @@ module Freeclimb
     # 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.
     attr_accessor :parent_call_id
 
+    # Activate privacy mode in order to obscure log data that can potentially expose private information.
+    attr_accessor :privacy_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,7 +51,8 @@ module Freeclimb
         :'if_machine' => :'ifMachine',
         :'if_machine_url' => :'ifMachineUrl',
         :'timeout' => :'timeout',
-        :'parent_call_id' => :'parentCallId'
+        :'parent_call_id' => :'parentCallId',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -62,7 +66,8 @@ module Freeclimb
         :'if_machine' => :'String',
         :'if_machine_url' => :'String',
         :'timeout' => :'Integer',
-        :'parent_call_id' => :'String'
+        :'parent_call_id' => :'String',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -118,6 +123,10 @@ module Freeclimb
       if attributes.key?(:'parent_call_id')
         self.parent_call_id = attributes[:'parent_call_id']
       end
+
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -160,7 +169,8 @@ module Freeclimb
           if_machine == o.if_machine &&
           if_machine_url == o.if_machine_url &&
           timeout == o.timeout &&
-          parent_call_id == o.parent_call_id
+          parent_call_id == o.parent_call_id &&
+          privacy_mode == o.privacy_mode
     end
 
     # @see the `==` method
@@ -172,7 +182,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [from, to, application_id, send_digits, if_machine, if_machine_url, timeout, parent_call_id].hash
+      [from, to, application_id, send_digits, if_machine, if_machine_url, timeout, parent_call_id, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/message_result.rb

@@ -32,7 +32,7 @@ module Freeclimb
     # String that uniquely identifies this message resource
     attr_accessor :message_id
 
-    # Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received
+    # Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown
     attr_accessor :status
 
     # Phone number in E.164 format that sent the message.
@@ -196,7 +196,7 @@ module Freeclimb
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      status_validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered"])
+      status_validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered", "expired", "deleted", "unknown"])
       return false unless status_validator.valid?(@status)
       true
     end
@@ -204,7 +204,7 @@ module Freeclimb
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered"])
+      validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered", "expired", "deleted", "unknown"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end

data/lib/freeclimb/models/message_result_all_of.rb

@@ -20,7 +20,7 @@ module Freeclimb
     # String that uniquely identifies this message resource
     attr_accessor :message_id
 
-    # Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received
+    # Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown
     attr_accessor :status
 
     # Phone number in E.164 format that sent the message.
@@ -152,7 +152,7 @@ module Freeclimb
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      status_validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered"])
+      status_validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered", "expired", "deleted", "unknown"])
       return false unless status_validator.valid?(@status)
       true
     end
@@ -160,7 +160,7 @@ module Freeclimb
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered"])
+      validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered", "expired", "deleted", "unknown"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end

data/lib/freeclimb/models/out_dial.rb

@@ -42,6 +42,9 @@ module Freeclimb
     # 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`.
     attr_accessor :timeout
 
+    # Parameter `privacyMode` will not log the `text` as required by PCI compliance.
+    attr_accessor :privacy_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -53,7 +56,8 @@ module Freeclimb
         :'if_machine_url' => :'ifMachineUrl',
         :'send_digits' => :'sendDigits',
         :'status_callback_url' => :'statusCallbackUrl',
-        :'timeout' => :'timeout'
+        :'timeout' => :'timeout',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -68,7 +72,8 @@ module Freeclimb
         :'if_machine_url' => :'String',
         :'send_digits' => :'String',
         :'status_callback_url' => :'String',
-        :'timeout' => :'Integer'
+        :'timeout' => :'Integer',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -139,6 +144,10 @@ module Freeclimb
       if attributes.key?(:'timeout')
         self.timeout = attributes[:'timeout']
       end
+
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -187,7 +196,8 @@ module Freeclimb
           if_machine_url == o.if_machine_url &&
           send_digits == o.send_digits &&
           status_callback_url == o.status_callback_url &&
-          timeout == o.timeout && super(o)
+          timeout == o.timeout &&
+          privacy_mode == o.privacy_mode && super(o)
     end
 
     # @see the `==` method
@@ -199,7 +209,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, call_connect_url, calling_number, destination, if_machine, if_machine_url, send_digits, status_callback_url, timeout].hash
+      [action_url, call_connect_url, calling_number, destination, if_machine, if_machine_url, send_digits, status_callback_url, timeout, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/out_dial_all_of.rb

@@ -41,6 +41,9 @@ module Freeclimb
     # 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`.
     attr_accessor :timeout
 
+    # Parameter `privacyMode` will not log the `text` as required by PCI compliance.
+    attr_accessor :privacy_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -52,7 +55,8 @@ module Freeclimb
         :'if_machine_url' => :'ifMachineUrl',
         :'send_digits' => :'sendDigits',
         :'status_callback_url' => :'statusCallbackUrl',
-        :'timeout' => :'timeout'
+        :'timeout' => :'timeout',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -67,7 +71,8 @@ module Freeclimb
         :'if_machine_url' => :'String',
         :'send_digits' => :'String',
         :'status_callback_url' => :'String',
-        :'timeout' => :'Integer'
+        :'timeout' => :'Integer',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -127,6 +132,10 @@ module Freeclimb
       if attributes.key?(:'timeout')
         self.timeout = attributes[:'timeout']
       end
+
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -175,7 +184,8 @@ module Freeclimb
           if_machine_url == o.if_machine_url &&
           send_digits == o.send_digits &&
           status_callback_url == o.status_callback_url &&
-          timeout == o.timeout
+          timeout == o.timeout &&
+          privacy_mode == o.privacy_mode
     end
 
     # @see the `==` method
@@ -187,7 +197,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, call_connect_url, calling_number, destination, if_machine, if_machine_url, send_digits, status_callback_url, timeout].hash
+      [action_url, call_connect_url, calling_number, destination, if_machine, if_machine_url, send_digits, status_callback_url, timeout, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/play.rb

@@ -24,12 +24,16 @@ module Freeclimb
     # 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.
     attr_accessor :conference_id
 
+    # Parameter `privacyMode` will not log the `text` as required by PCI compliance.
+    attr_accessor :privacy_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'file' => :'file',
         :'loop' => :'loop',
-        :'conference_id' => :'conferenceId'
+        :'conference_id' => :'conferenceId',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -38,7 +42,8 @@ module Freeclimb
       {
         :'file' => :'String',
         :'loop' => :'Integer',
-        :'conference_id' => :'String'
+        :'conference_id' => :'String',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -85,6 +90,10 @@ module Freeclimb
       if attributes.key?(:'conference_id')
         self.conference_id = attributes[:'conference_id']
       end
+
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -112,7 +121,8 @@ module Freeclimb
       self.class == o.class &&
           file == o.file &&
           loop == o.loop &&
-          conference_id == o.conference_id && super(o)
+          conference_id == o.conference_id &&
+          privacy_mode == o.privacy_mode && super(o)
     end
 
     # @see the `==` method
@@ -124,7 +134,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [file, loop, conference_id].hash
+      [file, loop, conference_id, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/play_all_of.rb

@@ -23,12 +23,16 @@ module Freeclimb
     # 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.
     attr_accessor :conference_id
 
+    # Parameter `privacyMode` will not log the `text` as required by PCI compliance.
+    attr_accessor :privacy_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'file' => :'file',
         :'loop' => :'loop',
-        :'conference_id' => :'conferenceId'
+        :'conference_id' => :'conferenceId',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -37,7 +41,8 @@ module Freeclimb
       {
         :'file' => :'String',
         :'loop' => :'Integer',
-        :'conference_id' => :'String'
+        :'conference_id' => :'String',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -73,6 +78,10 @@ module Freeclimb
       if attributes.key?(:'conference_id')
         self.conference_id = attributes[:'conference_id']
       end
+
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -100,7 +109,8 @@ module Freeclimb
       self.class == o.class &&
           file == o.file &&
           loop == o.loop &&
-          conference_id == o.conference_id
+          conference_id == o.conference_id &&
+          privacy_mode == o.privacy_mode
     end
 
     # @see the `==` method
@@ -112,7 +122,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [file, loop, conference_id].hash
+      [file, loop, conference_id, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/record_utterance.rb

@@ -33,6 +33,9 @@ module Freeclimb
     # 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.
     attr_accessor :auto_start
 
+    # Parameter `privacyMode` will not log the `text` as required by PCI compliance.
+    attr_accessor :privacy_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -41,7 +44,8 @@ module Freeclimb
         :'finish_on_key' => :'finishOnKey',
         :'max_length_sec' => :'maxLengthSec',
         :'play_beep' => :'playBeep',
-        :'auto_start' => :'autoStart'
+        :'auto_start' => :'autoStart',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -53,7 +57,8 @@ module Freeclimb
         :'finish_on_key' => :'String',
         :'max_length_sec' => :'Integer',
         :'play_beep' => :'Boolean',
-        :'auto_start' => :'Boolean'
+        :'auto_start' => :'Boolean',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -112,6 +117,10 @@ module Freeclimb
       if attributes.key?(:'auto_start')
         self.auto_start = attributes[:'auto_start']
       end
+
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -142,7 +151,8 @@ module Freeclimb
           finish_on_key == o.finish_on_key &&
           max_length_sec == o.max_length_sec &&
           play_beep == o.play_beep &&
-          auto_start == o.auto_start && super(o)
+          auto_start == o.auto_start &&
+          privacy_mode == o.privacy_mode && super(o)
     end
 
     # @see the `==` method
@@ -154,7 +164,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, silence_timeout_ms, finish_on_key, max_length_sec, play_beep, auto_start].hash
+      [action_url, silence_timeout_ms, finish_on_key, max_length_sec, play_beep, auto_start, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/record_utterance_all_of.rb

@@ -32,6 +32,9 @@ module Freeclimb
     # 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.
     attr_accessor :auto_start
 
+    # Parameter `privacyMode` will not log the `text` as required by PCI compliance.
+    attr_accessor :privacy_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,7 +43,8 @@ module Freeclimb
         :'finish_on_key' => :'finishOnKey',
         :'max_length_sec' => :'maxLengthSec',
         :'play_beep' => :'playBeep',
-        :'auto_start' => :'autoStart'
+        :'auto_start' => :'autoStart',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -52,7 +56,8 @@ module Freeclimb
         :'finish_on_key' => :'String',
         :'max_length_sec' => :'Integer',
         :'play_beep' => :'Boolean',
-        :'auto_start' => :'Boolean'
+        :'auto_start' => :'Boolean',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -100,6 +105,10 @@ module Freeclimb
       if attributes.key?(:'auto_start')
         self.auto_start = attributes[:'auto_start']
       end
+
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -130,7 +139,8 @@ module Freeclimb
           finish_on_key == o.finish_on_key &&
           max_length_sec == o.max_length_sec &&
           play_beep == o.play_beep &&
-          auto_start == o.auto_start
+          auto_start == o.auto_start &&
+          privacy_mode == o.privacy_mode
     end
 
     # @see the `==` method
@@ -142,7 +152,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, silence_timeout_ms, finish_on_key, max_length_sec, play_beep, auto_start].hash
+      [action_url, silence_timeout_ms, finish_on_key, max_length_sec, play_beep, auto_start, privacy_mode].hash
     end
 
     # Builds the object from hash