freeclimb 1.0.3 → 2.1.0

data/lib/freeclimb/models/create_conference_request.rb

@@ -29,9 +29,6 @@ module Freeclimb
     # This URL is invoked when the status of the Conference changes. For more information, see **statusCallbackUrl** (below).
     attr_accessor :status_callback_url
 
-    # 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>).
-    attr_accessor :request_id
-
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -61,8 +58,7 @@ module Freeclimb
         :'play_beep' => :'playBeep',
         :'record' => :'record',
         :'wait_url' => :'waitUrl',
-        :'status_callback_url' => :'statusCallbackUrl',
-        :'request_id' => :'requestId'
+        :'status_callback_url' => :'statusCallbackUrl'
       }
     end
 
@@ -73,8 +69,7 @@ module Freeclimb
         :'play_beep' => :'String',
         :'record' => :'Boolean',
         :'wait_url' => :'String',
-        :'status_callback_url' => :'String',
-        :'request_id' => :'String'
+        :'status_callback_url' => :'String'
       }
     end
 
@@ -120,10 +115,6 @@ module Freeclimb
       if attributes.key?(:'status_callback_url')
         self.status_callback_url = attributes[:'status_callback_url']
       end
-
-      if attributes.key?(:'request_id')
-        self.request_id = attributes[:'request_id']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -160,8 +151,7 @@ module Freeclimb
           play_beep == o.play_beep &&
           record == o.record &&
           wait_url == o.wait_url &&
-          status_callback_url == o.status_callback_url &&
-          request_id == o.request_id
+          status_callback_url == o.status_callback_url
     end
 
     # @see the `==` method
@@ -173,7 +163,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [_alias, play_beep, record, wait_url, status_callback_url, request_id].hash
+      [_alias, play_beep, record, wait_url, status_callback_url].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/filter_logs_request.rb

@@ -17,22 +17,17 @@ module Freeclimb
     # The filter query for retrieving logs. See **Performance Query Language** below.
     attr_accessor :pql
 
-    # 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>).
-    attr_accessor :request_id
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'pql' => :'pql',
-        :'request_id' => :'requestId'
+        :'pql' => :'pql'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'pql' => :'String',
-        :'request_id' => :'String'
+        :'pql' => :'String'
       }
     end
 
@@ -60,10 +55,6 @@ module Freeclimb
       if attributes.key?(:'pql')
         self.pql = attributes[:'pql']
       end
-
-      if attributes.key?(:'request_id')
-        self.request_id = attributes[:'request_id']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,8 +80,7 @@ module Freeclimb
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          pql == o.pql &&
-          request_id == o.request_id
+          pql == o.pql
     end
 
     # @see the `==` method
@@ -102,7 +92,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pql, request_id].hash
+      [pql].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/get_digits.rb

@@ -39,6 +39,9 @@ module Freeclimb
     # 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.
     attr_accessor :prompts
 
+    # 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
       {
@@ -49,7 +52,8 @@ module Freeclimb
         :'initial_timeout_ms' => :'initialTimeoutMs',
         :'max_digits' => :'maxDigits',
         :'min_digits' => :'minDigits',
-        :'prompts' => :'prompts'
+        :'prompts' => :'prompts',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -63,7 +67,8 @@ module Freeclimb
         :'initial_timeout_ms' => :'String',
         :'max_digits' => :'Integer',
         :'min_digits' => :'Integer',
-        :'prompts' => :'Array<PerclCommand>'
+        :'prompts' => :'Array<PerclCommand>',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -132,6 +137,10 @@ module Freeclimb
           self.prompts = value
         end
       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?
@@ -164,7 +173,8 @@ module Freeclimb
           initial_timeout_ms == o.initial_timeout_ms &&
           max_digits == o.max_digits &&
           min_digits == o.min_digits &&
-          prompts == o.prompts && super(o)
+          prompts == o.prompts &&
+          privacy_mode == o.privacy_mode && super(o)
     end
 
     # @see the `==` method
@@ -176,7 +186,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, digit_timeout_ms, finish_on_key, flush_buffer, initial_timeout_ms, max_digits, min_digits, prompts].hash
+      [action_url, digit_timeout_ms, finish_on_key, flush_buffer, initial_timeout_ms, max_digits, min_digits, prompts, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/get_digits_all_of.rb

@@ -38,6 +38,9 @@ module Freeclimb
     # 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.
     attr_accessor :prompts
 
+    # 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
       {
@@ -48,7 +51,8 @@ module Freeclimb
         :'initial_timeout_ms' => :'initialTimeoutMs',
         :'max_digits' => :'maxDigits',
         :'min_digits' => :'minDigits',
-        :'prompts' => :'prompts'
+        :'prompts' => :'prompts',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -62,7 +66,8 @@ module Freeclimb
         :'initial_timeout_ms' => :'String',
         :'max_digits' => :'Integer',
         :'min_digits' => :'Integer',
-        :'prompts' => :'Array<PerclCommand>'
+        :'prompts' => :'Array<PerclCommand>',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -120,6 +125,10 @@ module Freeclimb
           self.prompts = value
         end
       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?
@@ -152,7 +161,8 @@ module Freeclimb
           initial_timeout_ms == o.initial_timeout_ms &&
           max_digits == o.max_digits &&
           min_digits == o.min_digits &&
-          prompts == o.prompts
+          prompts == o.prompts &&
+          privacy_mode == o.privacy_mode
     end
 
     # @see the `==` method
@@ -164,7 +174,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, digit_timeout_ms, finish_on_key, flush_buffer, initial_timeout_ms, max_digits, min_digits, prompts].hash
+      [action_url, digit_timeout_ms, finish_on_key, flush_buffer, initial_timeout_ms, max_digits, min_digits, prompts, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/get_speech.rb

@@ -51,8 +51,8 @@ module Freeclimb
     # 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.
     attr_accessor :speech_incomplete_timeout_ms
 
-    # Parameter enforcePCI will not log the `text` as required by PCI compliance.
-    attr_accessor :enforce_pci
+    # 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
@@ -69,7 +69,7 @@ module Freeclimb
         :'sensitivity_level' => :'sensitivityLevel',
         :'speech_complete_timeout_ms' => :'speechCompleteTimeoutMs',
         :'speech_incomplete_timeout_ms' => :'speechIncompleteTimeoutMs',
-        :'enforce_pci' => :'enforcePCI'
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -88,7 +88,7 @@ module Freeclimb
         :'sensitivity_level' => :'Float',
         :'speech_complete_timeout_ms' => :'Integer',
         :'speech_incomplete_timeout_ms' => :'Integer',
-        :'enforce_pci' => :'Boolean'
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -174,8 +174,8 @@ module Freeclimb
         self.speech_incomplete_timeout_ms = attributes[:'speech_incomplete_timeout_ms']
       end
 
-      if attributes.key?(:'enforce_pci')
-        self.enforce_pci = attributes[:'enforce_pci']
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
       end
     end
 
@@ -219,7 +219,7 @@ module Freeclimb
           sensitivity_level == o.sensitivity_level &&
           speech_complete_timeout_ms == o.speech_complete_timeout_ms &&
           speech_incomplete_timeout_ms == o.speech_incomplete_timeout_ms &&
-          enforce_pci == o.enforce_pci && super(o)
+          privacy_mode == o.privacy_mode && super(o)
     end
 
     # @see the `==` method
@@ -231,7 +231,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, grammar_type, grammar_file, grammar_rule, play_beep, prompts, no_input_timeout_ms, recognition_timeout_ms, confidence_threshold, sensitivity_level, speech_complete_timeout_ms, speech_incomplete_timeout_ms, enforce_pci].hash
+      [action_url, grammar_type, grammar_file, grammar_rule, play_beep, prompts, no_input_timeout_ms, recognition_timeout_ms, confidence_threshold, sensitivity_level, speech_complete_timeout_ms, speech_incomplete_timeout_ms, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/get_speech_all_of.rb

@@ -50,8 +50,8 @@ module Freeclimb
     # 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.
     attr_accessor :speech_incomplete_timeout_ms
 
-    # Parameter enforcePCI will not log the `text` as required by PCI compliance.
-    attr_accessor :enforce_pci
+    # 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
@@ -68,7 +68,7 @@ module Freeclimb
         :'sensitivity_level' => :'sensitivityLevel',
         :'speech_complete_timeout_ms' => :'speechCompleteTimeoutMs',
         :'speech_incomplete_timeout_ms' => :'speechIncompleteTimeoutMs',
-        :'enforce_pci' => :'enforcePCI'
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -87,7 +87,7 @@ module Freeclimb
         :'sensitivity_level' => :'Float',
         :'speech_complete_timeout_ms' => :'Integer',
         :'speech_incomplete_timeout_ms' => :'Integer',
-        :'enforce_pci' => :'Boolean'
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -162,8 +162,8 @@ module Freeclimb
         self.speech_incomplete_timeout_ms = attributes[:'speech_incomplete_timeout_ms']
       end
 
-      if attributes.key?(:'enforce_pci')
-        self.enforce_pci = attributes[:'enforce_pci']
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
       end
     end
 
@@ -207,7 +207,7 @@ module Freeclimb
           sensitivity_level == o.sensitivity_level &&
           speech_complete_timeout_ms == o.speech_complete_timeout_ms &&
           speech_incomplete_timeout_ms == o.speech_incomplete_timeout_ms &&
-          enforce_pci == o.enforce_pci
+          privacy_mode == o.privacy_mode
     end
 
     # @see the `==` method
@@ -219,7 +219,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, grammar_type, grammar_file, grammar_rule, play_beep, prompts, no_input_timeout_ms, recognition_timeout_ms, confidence_threshold, sensitivity_level, speech_complete_timeout_ms, speech_incomplete_timeout_ms, enforce_pci].hash
+      [action_url, grammar_type, grammar_file, grammar_rule, play_beep, prompts, no_input_timeout_ms, recognition_timeout_ms, confidence_threshold, sensitivity_level, speech_complete_timeout_ms, speech_incomplete_timeout_ms, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/hangup.rb

@@ -0,0 +1,220 @@
+=begin
+#FreeClimb API
+
+#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module Freeclimb
+  # The `Hangup` command terminates a Call. If `Hangup` is used as the first action in a PerCL response, it does not prevent FreeClimb from answering the Call and billing your account. See the `Reject` command to hang up at no charge.
+  class Hangup < PerclCommand
+    # 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.
+    attr_accessor :reason
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'reason' => :'reason'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'reason' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'HangupAllOf',
+      :'PerclCommand'
+      ]
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::Hangup` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::Hangup`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      # call parent's initialize
+      super(attributes)
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = super
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true && super
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          reason == o.reason && super(o)
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [reason].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      super(attributes)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Freeclimb.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = super
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end