carbon_ruby_sdk 0.2.28 → 0.2.30

data/lib/carbon_ruby_sdk/models/guru_authentication.rb

@@ -0,0 +1,244 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'date'
+require 'time'
+
+module Carbon
+  class GuruAuthentication
+    attr_accessor :source
+
+    attr_accessor :access_token
+
+    attr_accessor :username
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'source' => :'source',
+        :'access_token' => :'access_token',
+        :'username' => :'username'
+      }
+    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
+      {
+        :'source' => :'Object',
+        :'access_token' => :'String',
+        :'username' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'source',
+      ])
+    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 `Carbon::GuruAuthentication` 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 `Carbon::GuruAuthentication`. 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?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'access_token')
+        self.access_token = attributes[:'access_token']
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      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 @access_token.nil?
+        invalid_properties.push('invalid value for "access_token", access_token cannot be nil.')
+      end
+
+      if @username.nil?
+        invalid_properties.push('invalid value for "username", username 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?
+      return false if @access_token.nil?
+      return false if @username.nil?
+      true
+    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 &&
+          source == o.source &&
+          access_token == o.access_token &&
+          username == o.username
+    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
+      [source, access_token, username].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      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 = Carbon.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/carbon_ruby_sdk/models/guru_connect_request.rb

@@ -0,0 +1,359 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'date'
+require 'time'
+
+module Carbon
+  class GuruConnectRequest
+    attr_accessor :tags
+
+    attr_accessor :username
+
+    attr_accessor :access_token
+
+    attr_accessor :chunk_size
+
+    attr_accessor :chunk_overlap
+
+    attr_accessor :skip_embedding_generation
+
+    attr_accessor :embedding_model
+
+    attr_accessor :generate_sparse_vectors
+
+    attr_accessor :prepend_filename_to_chunks
+
+    attr_accessor :sync_files_on_connection
+
+    attr_accessor :request_id
+
+    # Enabling this flag will fetch all available content from the source to be listed via list items endpoint
+    attr_accessor :sync_source_items
+
+    attr_accessor :file_sync_config
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'tags' => :'tags',
+        :'username' => :'username',
+        :'access_token' => :'access_token',
+        :'chunk_size' => :'chunk_size',
+        :'chunk_overlap' => :'chunk_overlap',
+        :'skip_embedding_generation' => :'skip_embedding_generation',
+        :'embedding_model' => :'embedding_model',
+        :'generate_sparse_vectors' => :'generate_sparse_vectors',
+        :'prepend_filename_to_chunks' => :'prepend_filename_to_chunks',
+        :'sync_files_on_connection' => :'sync_files_on_connection',
+        :'request_id' => :'request_id',
+        :'sync_source_items' => :'sync_source_items',
+        :'file_sync_config' => :'file_sync_config'
+      }
+    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
+      {
+        :'tags' => :'Object',
+        :'username' => :'String',
+        :'access_token' => :'String',
+        :'chunk_size' => :'Integer',
+        :'chunk_overlap' => :'Integer',
+        :'skip_embedding_generation' => :'Boolean',
+        :'embedding_model' => :'EmbeddingGenerators',
+        :'generate_sparse_vectors' => :'Boolean',
+        :'prepend_filename_to_chunks' => :'Boolean',
+        :'sync_files_on_connection' => :'Boolean',
+        :'request_id' => :'String',
+        :'sync_source_items' => :'Boolean',
+        :'file_sync_config' => :'FileSyncConfigNullable'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'tags',
+        :'chunk_size',
+        :'chunk_overlap',
+        :'skip_embedding_generation',
+        :'generate_sparse_vectors',
+        :'prepend_filename_to_chunks',
+        :'sync_files_on_connection',
+        :'request_id',
+        :'file_sync_config'
+      ])
+    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 `Carbon::GuruConnectRequest` 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 `Carbon::GuruConnectRequest`. 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?(:'tags')
+        self.tags = attributes[:'tags']
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      end
+
+      if attributes.key?(:'access_token')
+        self.access_token = attributes[:'access_token']
+      end
+
+      if attributes.key?(:'chunk_size')
+        self.chunk_size = attributes[:'chunk_size']
+      else
+        self.chunk_size = 1500
+      end
+
+      if attributes.key?(:'chunk_overlap')
+        self.chunk_overlap = attributes[:'chunk_overlap']
+      else
+        self.chunk_overlap = 20
+      end
+
+      if attributes.key?(:'skip_embedding_generation')
+        self.skip_embedding_generation = attributes[:'skip_embedding_generation']
+      else
+        self.skip_embedding_generation = false
+      end
+
+      if attributes.key?(:'embedding_model')
+        self.embedding_model = attributes[:'embedding_model']
+      else
+        self.embedding_model = 'OPENAI'
+      end
+
+      if attributes.key?(:'generate_sparse_vectors')
+        self.generate_sparse_vectors = attributes[:'generate_sparse_vectors']
+      else
+        self.generate_sparse_vectors = false
+      end
+
+      if attributes.key?(:'prepend_filename_to_chunks')
+        self.prepend_filename_to_chunks = attributes[:'prepend_filename_to_chunks']
+      else
+        self.prepend_filename_to_chunks = false
+      end
+
+      if attributes.key?(:'sync_files_on_connection')
+        self.sync_files_on_connection = attributes[:'sync_files_on_connection']
+      else
+        self.sync_files_on_connection = true
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      end
+
+      if attributes.key?(:'sync_source_items')
+        self.sync_source_items = attributes[:'sync_source_items']
+      else
+        self.sync_source_items = true
+      end
+
+      if attributes.key?(:'file_sync_config')
+        self.file_sync_config = attributes[:'file_sync_config']
+      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 @username.nil?
+        invalid_properties.push('invalid value for "username", username cannot be nil.')
+      end
+
+      if @access_token.nil?
+        invalid_properties.push('invalid value for "access_token", access_token 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?
+      return false if @username.nil?
+      return false if @access_token.nil?
+      true
+    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 &&
+          tags == o.tags &&
+          username == o.username &&
+          access_token == o.access_token &&
+          chunk_size == o.chunk_size &&
+          chunk_overlap == o.chunk_overlap &&
+          skip_embedding_generation == o.skip_embedding_generation &&
+          embedding_model == o.embedding_model &&
+          generate_sparse_vectors == o.generate_sparse_vectors &&
+          prepend_filename_to_chunks == o.prepend_filename_to_chunks &&
+          sync_files_on_connection == o.sync_files_on_connection &&
+          request_id == o.request_id &&
+          sync_source_items == o.sync_source_items &&
+          file_sync_config == o.file_sync_config
+    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
+      [tags, username, access_token, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, generate_sparse_vectors, prepend_filename_to_chunks, sync_files_on_connection, request_id, sync_source_items, file_sync_config].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      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 = Carbon.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/carbon_ruby_sdk/models/o_auth_url_request.rb

@@ -67,7 +67,7 @@ module Carbon
     # Enabling this flag will fetch all available content from the source to be listed via list items endpoint
     attr_accessor :sync_source_items
 
-    # Only sync files if they have not already been synced or if the embedding properties have changed.         This flag is currently supported by ONEDRIVE, GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK, ZENDESK, CONFLUENCE, NOTION, SHAREPOINT. It will be ignored for other data sources.
+    # Only sync files if they have not already been synced or if the embedding properties have changed.         This flag is currently supported by ONEDRIVE, GOOGLE_DRIVE, BOX, DROPBOX, INTERCOM, GMAIL, OUTLOOK, ZENDESK, CONFLUENCE, NOTION, SHAREPOINT, SERVICENOW. It will be ignored for other data sources.
     attr_accessor :incremental_sync
 
     attr_accessor :file_sync_config
@@ -75,6 +75,8 @@ module Carbon
     # Automatically open source file picker after the OAuth flow is complete. This flag is currently supported by         BOX, DROPBOX, GOOGLE_DRIVE, ONEDRIVE, SHAREPOINT. It will be ignored for other data sources.
     attr_accessor :automatically_open_file_picker
 
+    attr_accessor :servicenow_credentials
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -104,7 +106,8 @@ module Carbon
         :'sync_source_items' => :'sync_source_items',
         :'incremental_sync' => :'incremental_sync',
         :'file_sync_config' => :'file_sync_config',
-        :'automatically_open_file_picker' => :'automatically_open_file_picker'
+        :'automatically_open_file_picker' => :'automatically_open_file_picker',
+        :'servicenow_credentials' => :'servicenow_credentials'
       }
     end
 
@@ -142,7 +145,8 @@ module Carbon
         :'sync_source_items' => :'Boolean',
         :'incremental_sync' => :'Boolean',
         :'file_sync_config' => :'FileSyncConfigNullable',
-        :'automatically_open_file_picker' => :'Boolean'
+        :'automatically_open_file_picker' => :'Boolean',
+        :'servicenow_credentials' => :'ServiceNowCredentialsNullable'
       }
     end
 
@@ -170,7 +174,8 @@ module Carbon
         :'use_ocr',
         :'parse_pdf_tables_with_ocr',
         :'file_sync_config',
-        :'automatically_open_file_picker'
+        :'automatically_open_file_picker',
+        :'servicenow_credentials'
       ])
     end
 
@@ -324,6 +329,10 @@ module Carbon
       if attributes.key?(:'automatically_open_file_picker')
         self.automatically_open_file_picker = attributes[:'automatically_open_file_picker']
       end
+
+      if attributes.key?(:'servicenow_credentials')
+        self.servicenow_credentials = attributes[:'servicenow_credentials']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -375,7 +384,8 @@ module Carbon
           sync_source_items == o.sync_source_items &&
           incremental_sync == o.incremental_sync &&
           file_sync_config == o.file_sync_config &&
-          automatically_open_file_picker == o.automatically_open_file_picker
+          automatically_open_file_picker == o.automatically_open_file_picker &&
+          servicenow_credentials == o.servicenow_credentials
     end
 
     # @see the `==` method
@@ -387,7 +397,7 @@ module Carbon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [tags, scope, service, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, zendesk_subdomain, microsoft_tenant, sharepoint_site_name, confluence_subdomain, generate_sparse_vectors, prepend_filename_to_chunks, max_items_per_chunk, salesforce_domain, sync_files_on_connection, set_page_as_boundary, data_source_id, connecting_new_account, request_id, use_ocr, parse_pdf_tables_with_ocr, enable_file_picker, sync_source_items, incremental_sync, file_sync_config, automatically_open_file_picker].hash
+      [tags, scope, service, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, zendesk_subdomain, microsoft_tenant, sharepoint_site_name, confluence_subdomain, generate_sparse_vectors, prepend_filename_to_chunks, max_items_per_chunk, salesforce_domain, sync_files_on_connection, set_page_as_boundary, data_source_id, connecting_new_account, request_id, use_ocr, parse_pdf_tables_with_ocr, enable_file_picker, sync_source_items, incremental_sync, file_sync_config, automatically_open_file_picker, servicenow_credentials].hash
     end
 
     # Builds the object from hash

data/lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb

@@ -111,7 +111,7 @@ module Carbon
         :'sync_error_message' => :'String',
         :'include_containers' => :'Boolean',
         :'external_urls' => :'Array<String>',
-        :'file_types_at_source' => :'Array<HelpdeskFileTypes>'
+        :'file_types_at_source' => :'Array<AutoSyncedSourceTypesPropertyInner>'
       }
     end