freeclimb 4.7.0 → 4.8.0

data/lib/freeclimb/models/completion_result.rb

@@ -0,0 +1,274 @@
+=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
+Contact: support@freeclimb.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Freeclimb
+  class CompletionResult
+    # The generative response from the KnowledgeBase
+    attr_accessor :response
+
+    # Completion result status. Possible values: success, no_context
+    attr_accessor :status
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'response' => :'response',
+        :'status' => :'status'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'response' => :'String',
+        :'status' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::CompletionResult` 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::CompletionResult`. 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
+      }
+
+      if attributes.key?(:'response')
+        self.response = attributes[:'response']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      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 = Array.new
+      if @response.nil?
+        invalid_properties.push('invalid value for "response", response cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      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?
+      
+      if @response.nil?
+        false
+      else
+        list_invalid_properties.length() == 0
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["success", "no_context"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          response == o.response &&
+          status == o.status
+    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
+      [response, status].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)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Freeclimb.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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 = {}
+      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

data/lib/freeclimb/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.4.0
 =end
 
 module Freeclimb
-  VERSION = '4.7.0'
+  VERSION = '4.8.0'
 end

data/lib/freeclimb.rb

@@ -40,6 +40,8 @@ require 'freeclimb/models/call_result'
 require 'freeclimb/models/call_result_all_of'
 require 'freeclimb/models/call_status'
 require 'freeclimb/models/capabilities'
+require 'freeclimb/models/completion_request'
+require 'freeclimb/models/completion_result'
 require 'freeclimb/models/conference_list'
 require 'freeclimb/models/conference_list_all_of'
 require 'freeclimb/models/conference_participant_list'

data/openapi.json

@@ -1235,7 +1235,6 @@
                 "type": "string"
               },
               "from": {
-                "x-is-private-property": true,
                 "description": "E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb.",
                 "type": "string"
               },
@@ -1791,7 +1790,6 @@
                 "nullable": true
               },
               "from": {
-                "x-is-private-property": true,
                 "type": "string",
                 "description": "Phone number that initiated this Call.",
                 "nullable": true
@@ -1863,7 +1861,6 @@
         "required": ["from", "to"],
         "properties": {
           "from": {
-            "x-is-private-property": true,
             "type": "string",
             "description": "Phone number to use as the caller ID. This can be: (a) The To or From number provided in FreeClimb's initial request to your app or (b) Any incoming phone number you have purchased from FreeClimb."
           },
@@ -2136,7 +2133,6 @@
             "required": ["from", "to", "text"],
             "properties": {
               "from": {
-                "x-is-private-property": true,
                 "type": "string",
                 "description": "Phone number to use as the sender. This must be an incoming phone number that you have purchased from FreeClimb."
               },
@@ -2165,6 +2161,38 @@
           }
         ]
       },
+      "CompletionRequest": {
+        "type": "object",
+        "required": ["query"],
+        "properties": {
+          "query": {
+            "type": "string",
+            "maxLength": 2000,
+            "description": "Question to ask the Knowledge Base"
+          }
+        }
+      },
+      "CompletionResult": {
+        "type": "object",
+        "required": ["response", "status"],
+        "x-completion-result": true,
+        "properties": {
+          "response": {
+            "type": "string",
+            "description": "The generative response from the KnowledgeBase"
+          },
+          "status": {
+            "type": "string",
+            "x-has-writer": true,
+            "description": "Completion result status. Possible values: success, no_context",
+            "x-enum-type": "CompletionResultStatusEnum",
+            "x-enum-type-c-sharp": "StatusEnum",
+            "enum": ["success", "no_context"],
+            "x-enum-varnames": ["SUCCESS", "NO_CONTEXT"],
+            "x-enum-varnames-values": ["success", "no_context"]
+          }
+        }
+      },
       "ConferenceList": {
         "x-implements": "Pagination",
         "allOf": [
@@ -2208,7 +2236,6 @@
                 "$ref": "#/components/schemas/MessageStatus"
               },
               "from": {
-                "x-is-private-property": true,
                 "type": "string",
                 "description": "Phone number in E.164 format that sent the message.",
                 "nullable": true
@@ -3623,7 +3650,6 @@
             "description": "E.164 formatted phone number to which calls using this token will be made."
           },
           "from": {
-            "x-is-private-property": true,
             "type": "string",
             "description": "E.164 formatted phone number owned by the reqeusting account from which calls using this token will be made."
           },
@@ -4226,6 +4252,50 @@
         }
       }
     },
+    "/Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion": {
+      "post": {
+        "tags": [],
+        "summary": "Query the knowledge base",
+        "operationId": "create-knowledge-base-completion",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "knowledgeBaseId",
+            "in": "path",
+            "description": "A string that uniquely identifies the KnowledgeBase resource.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "description": "Completion request details",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CompletionRequest"
+              }
+            }
+          }
+        },
+        "deprecated": false,
+        "responses": {
+          "200": {
+            "description": "KnowledgeaBase completion response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CompletionResult"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/Accounts/{accountId}/Calls/{callId}": {
       "get": {
         "tags": [],

data/package.json

@@ -3,6 +3,8 @@
     "@stoplight/prism-cli": "5.6.0"
   },
   "resolutions": {
-    "@stoplight/json": "3.20.0"
+    "@stoplight/json": "3.20.0",
+    "jsonpath-plus": "^10.0.0",
+    "fast-xml-parser": "^4.5.0"
   }
 }

data/spec/api/default_api_spec.rb

@@ -252,6 +252,9 @@ describe 'DefaultApi' do
 
     @create_web_rtc_token_make_a_webrtc_jwt_test_value=Freeclimb::CreateWebRTCToken.new({to: 'to_example', from: 'from_example', uses: 2})
 
+    @knowledge_base_id_create_knowledge_base_completion_test_value= 'knowledgeBaseId_example'
+
+    @completion_request_create_knowledge_base_completion_test_value=Freeclimb::CompletionRequest.new({query: 'query_example'})
   end
 
   after do
@@ -361,6 +364,32 @@ describe 'DefaultApi' do
     end
   end
 
+  # unit tests for create_knowledge_base_completion
+  # Query the knowledge base
+  # @param knowledge_base_id A string that uniquely identifies the KnowledgeBase resource.
+  # @param [Hash] opts the optional parameters
+  # @option opts [CompletionRequest] :completion_request Completion request details
+  # @return [CompletionResult]
+  describe 'create_knowledge_base_completion test' do
+    it 'should work' do
+      
+      knowledge_base_id = @knowledge_base_id_create_knowledge_base_completion_test_value
+      completion_request = @completion_request_create_knowledge_base_completion_test_value
+      
+      result = @api_instance.create_knowledge_base_completion(
+        knowledge_base_id,
+        {
+          :completion_request => completion_request,
+        }
+      )
+      false
+      
+      expect(result).to be_a Freeclimb::CompletionResult
+      
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for delete_a_recording
   # Delete a Recording
   # @param recording_id String that uniquely identifies this recording resource.

data/spec/models/account_request_spec.rb

@@ -74,7 +74,8 @@ describe Freeclimb::AccountRequest do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::AccountRequest.new(
         
       )

data/spec/models/account_result_spec.rb

@@ -197,7 +197,8 @@ describe Freeclimb::AccountResult do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::AccountResult.new(
         
       )

data/spec/models/add_to_conference_spec.rb

@@ -158,14 +158,9 @@ describe Freeclimb::AddToConference do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::AddToConference.new(
-        allow_call_control: nil,
-        
-        conference_id: nil,
-        listen: nil,
-        start_conf_on_enter: nil,
-        talk: nil,
         
       )
       expect(instance.valid?).to eq(false)

data/spec/models/application_list_spec.rb

@@ -158,7 +158,8 @@ describe Freeclimb::ApplicationList do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::ApplicationList.new(
         
       )

data/spec/models/application_request_spec.rb

@@ -134,7 +134,8 @@ describe Freeclimb::ApplicationRequest do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::ApplicationRequest.new(
         
       )

data/spec/models/application_result_spec.rb

@@ -208,7 +208,8 @@ describe Freeclimb::ApplicationResult do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::ApplicationResult.new(
         
       )

data/spec/models/available_number_list_spec.rb

@@ -158,7 +158,8 @@ describe Freeclimb::AvailableNumberList do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::AvailableNumberList.new(
         
       )

data/spec/models/available_number_spec.rb

@@ -134,10 +134,9 @@ describe Freeclimb::AvailableNumber do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::AvailableNumber.new(
-        voice_enabled: nil,
-        sms_enabled: nil,
         
       )
       expect(instance.valid?).to eq(false)

data/spec/models/buy_incoming_number_request_spec.rb

@@ -86,11 +86,10 @@ describe Freeclimb::BuyIncomingNumberRequest do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::BuyIncomingNumberRequest.new(
         
-        phone_number: nil,
-        
       )
       expect(instance.valid?).to eq(false)
     end

data/spec/models/call_list_spec.rb

@@ -158,7 +158,8 @@ describe Freeclimb::CallList do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::CallList.new(
         
       )

data/spec/models/call_result_spec.rb

@@ -325,7 +325,8 @@ describe Freeclimb::CallResult do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::CallResult.new(
         
       )

data/spec/models/capabilities_spec.rb

@@ -110,23 +110,9 @@ describe Freeclimb::Capabilities do
       expect(instance.valid?).to eq(true)
     end
 
-    it 'checks if properties are invalid' do
+
+    skip 'checks if properties are invalid' do
       instance = Freeclimb::Capabilities.new(
-        voice: nil,
-        
-        voice: nil,
-        sms: nil,
-        
-        sms: nil,
-        toll_free: nil,
-        
-        toll_free: nil,
-        ten_dlc: nil,
-        
-        ten_dlc: nil,
-        short_code: nil,
-        
-        short_code: nil,
         
       )
       expect(instance.valid?).to eq(false)