carbon_ruby_sdk 0.2.29 → 0.2.31

data/lib/carbon_ruby_sdk/models/gong_authentication.rb

@@ -0,0 +1,254 @@
+=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 GongAuthentication
+    attr_accessor :source
+
+    attr_accessor :access_token
+
+    attr_accessor :refresh_token
+
+    attr_accessor :gong_account_email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'source' => :'source',
+        :'access_token' => :'access_token',
+        :'refresh_token' => :'refresh_token',
+        :'gong_account_email' => :'gong_account_email'
+      }
+    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',
+        :'refresh_token' => :'String',
+        :'gong_account_email' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'source',
+        :'refresh_token',
+      ])
+    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::GongAuthentication` 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::GongAuthentication`. 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?(:'refresh_token')
+        self.refresh_token = attributes[:'refresh_token']
+      end
+
+      if attributes.key?(:'gong_account_email')
+        self.gong_account_email = attributes[:'gong_account_email']
+      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 @gong_account_email.nil?
+        invalid_properties.push('invalid value for "gong_account_email", gong_account_email 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 @gong_account_email.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 &&
+          refresh_token == o.refresh_token &&
+          gong_account_email == o.gong_account_email
+    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, refresh_token, gong_account_email].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,11 @@ 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
 
+    # If you are connecting a Gong account, you need to input the email of the account you         wish to connect. This email will be used to identify your carbon data source.
+    attr_accessor :gong_account_email
+
+    attr_accessor :servicenow_credentials
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -104,7 +109,9 @@ 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',
+        :'gong_account_email' => :'gong_account_email',
+        :'servicenow_credentials' => :'servicenow_credentials'
       }
     end
 
@@ -118,7 +125,7 @@ module Carbon
       {
         :'tags' => :'Object',
         :'scope' => :'String',
-        :'service' => :'ExternalDataSourceType',
+        :'service' => :'OauthBasedConnectors',
         :'chunk_size' => :'Integer',
         :'chunk_overlap' => :'Integer',
         :'skip_embedding_generation' => :'Boolean',
@@ -142,7 +149,9 @@ module Carbon
         :'sync_source_items' => :'Boolean',
         :'incremental_sync' => :'Boolean',
         :'file_sync_config' => :'FileSyncConfigNullable',
-        :'automatically_open_file_picker' => :'Boolean'
+        :'automatically_open_file_picker' => :'Boolean',
+        :'gong_account_email' => :'String',
+        :'servicenow_credentials' => :'ServiceNowCredentialsNullable'
       }
     end
 
@@ -170,7 +179,9 @@ module Carbon
         :'use_ocr',
         :'parse_pdf_tables_with_ocr',
         :'file_sync_config',
-        :'automatically_open_file_picker'
+        :'automatically_open_file_picker',
+        :'gong_account_email',
+        :'servicenow_credentials'
       ])
     end
 
@@ -324,6 +335,14 @@ module Carbon
       if attributes.key?(:'automatically_open_file_picker')
         self.automatically_open_file_picker = attributes[:'automatically_open_file_picker']
       end
+
+      if attributes.key?(:'gong_account_email')
+        self.gong_account_email = attributes[:'gong_account_email']
+      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 +394,9 @@ 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 &&
+          gong_account_email == o.gong_account_email &&
+          servicenow_credentials == o.servicenow_credentials
     end
 
     # @see the `==` method
@@ -387,7 +408,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, gong_account_email, servicenow_credentials].hash
     end
 
     # Builds the object from hash

data/lib/carbon_ruby_sdk/models/{external_data_source_type.rb → oauth_based_connectors.rb}

@@ -10,7 +10,7 @@ require 'date'
 require 'time'
 
 module Carbon
-  class ExternalDataSourceType
+  class OauthBasedConnectors
     BOX = "BOX".freeze
     CONFLUENCE = "CONFLUENCE".freeze
     DROPBOX = "DROPBOX".freeze
@@ -26,9 +26,11 @@ module Carbon
     SLACK = "SLACK".freeze
     ZENDESK = "ZENDESK".freeze
     ZOTERO = "ZOTERO".freeze
+    GONG = "GONG".freeze
+    SERVICENOW = "SERVICENOW".freeze
 
     def self.all_vars
-      @all_vars ||= [BOX, CONFLUENCE, DROPBOX, GMAIL, GOOGLE_DRIVE, GOOGLE_CLOUD_STORAGE, INTERCOM, NOTION, ONEDRIVE, OUTLOOK, SALESFORCE, SHAREPOINT, SLACK, ZENDESK, ZOTERO].freeze
+      @all_vars ||= [BOX, CONFLUENCE, DROPBOX, GMAIL, GOOGLE_DRIVE, GOOGLE_CLOUD_STORAGE, INTERCOM, NOTION, ONEDRIVE, OUTLOOK, SALESFORCE, SHAREPOINT, SLACK, ZENDESK, ZOTERO, GONG, SERVICENOW].freeze
     end
 
     # Builds the enum from string
@@ -42,8 +44,8 @@ module Carbon
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if ExternalDataSourceType.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #ExternalDataSourceType"
+      return value if OauthBasedConnectors.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #OauthBasedConnectors"
     end
   end
 end

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
 

data/lib/carbon_ruby_sdk/models/raw_text_input.rb

@@ -29,6 +29,9 @@ module Carbon
 
     attr_accessor :cold_storage_params
 
+    # If this flag is enabled, the file will be chunked and stored with Carbon,         but no embeddings will be generated. This overrides the skip_embedding_generation flag.
+    attr_accessor :generate_chunks_only
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,7 +43,8 @@ module Carbon
         :'overwrite_file_id' => :'overwrite_file_id',
         :'embedding_model' => :'embedding_model',
         :'generate_sparse_vectors' => :'generate_sparse_vectors',
-        :'cold_storage_params' => :'cold_storage_params'
+        :'cold_storage_params' => :'cold_storage_params',
+        :'generate_chunks_only' => :'generate_chunks_only'
       }
     end
 
@@ -60,7 +64,8 @@ module Carbon
         :'overwrite_file_id' => :'Integer',
         :'embedding_model' => :'EmbeddingGeneratorsNullable',
         :'generate_sparse_vectors' => :'Boolean',
-        :'cold_storage_params' => :'ColdStorageProps'
+        :'cold_storage_params' => :'ColdStorageProps',
+        :'generate_chunks_only' => :'Boolean'
       }
     end
 
@@ -132,6 +137,12 @@ module Carbon
       if attributes.key?(:'cold_storage_params')
         self.cold_storage_params = attributes[:'cold_storage_params']
       end
+
+      if attributes.key?(:'generate_chunks_only')
+        self.generate_chunks_only = attributes[:'generate_chunks_only']
+      else
+        self.generate_chunks_only = false
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -184,7 +195,8 @@ module Carbon
           overwrite_file_id == o.overwrite_file_id &&
           embedding_model == o.embedding_model &&
           generate_sparse_vectors == o.generate_sparse_vectors &&
-          cold_storage_params == o.cold_storage_params
+          cold_storage_params == o.cold_storage_params &&
+          generate_chunks_only == o.generate_chunks_only
     end
 
     # @see the `==` method
@@ -196,7 +208,7 @@ module Carbon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [contents, name, chunk_size, chunk_overlap, skip_embedding_generation, overwrite_file_id, embedding_model, generate_sparse_vectors, cold_storage_params].hash
+      [contents, name, chunk_size, chunk_overlap, skip_embedding_generation, overwrite_file_id, embedding_model, generate_sparse_vectors, cold_storage_params, generate_chunks_only].hash
     end
 
     # Builds the object from hash