carbon_ruby_sdk 0.2.25 → 0.2.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 744d7329a0dd05a7632f4b4738194bea0627fb74b8fe2f9f35f9bc18c073f885
-  data.tar.gz: 966a7e4c665bc51a25afa98e53ef4d162eaed77a09e0d5a8d95e269fe53e8aa9
+  metadata.gz: '00969f44903e2698da2cdf106e0051ceeeff09c68652799607ce5e5fae9b7a3a'
+  data.tar.gz: b59ee278e57db1ce4f5003787f146158865a172b782f6fcf73c5881a1c74d3e4
 SHA512:
-  metadata.gz: 436e1932ef9c0933cdefa4646123806d5a342c29700bf9a01c4104e1d31e1e9511400e63c436137361c80943fc8d4fe3c3d87a410c06c10dc6b7c6bb0d54e790
-  data.tar.gz: 1b4199c6ae7fc7f2ea6761aa308614672e1871b8f81f75da2ac7ac87e405260649c0fcfa0edc4011ffde778a83762d990251bc4b8662accf8dc1af9948a32bea
+  metadata.gz: d8f090188e03d6a29d1cbd2164799b513fd4498c573ad4ab8b3ea4839e448bec35831e0065e4409b77429dc044d76bddc64b2d187147b8c1590e72b33e703ad8
+  data.tar.gz: abfdbe67b5f27b6e015980f2fc633195cf3fd7b6126b9cacc2e65144418d923c6348acf7c40dd52d990f8ebe0224043c836918960144e268872f894eca0d97d8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.2.25)
+    carbon_ruby_sdk (0.2.27)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -44,7 +44,7 @@ GEM
     regexp_parser (2.9.2)
     reline (0.5.9)
       io-console (~> 0.5)
-    rexml (3.3.5)
+    rexml (3.3.6)
       strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)

data/README.md

@@ -6,7 +6,7 @@
 
 Connect external data to LLMs, no matter the source.
 
-[![npm](https://img.shields.io/badge/gem-v0.2.25-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.25)
+[![npm](https://img.shields.io/badge/gem-v0.2.27-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.27)
 
 </div>
 
@@ -93,7 +93,7 @@ Connect external data to LLMs, no matter the source.
 Add to Gemfile:
 
 ```ruby
-gem 'carbon_ruby_sdk', '~> 0.2.25'
+gem 'carbon_ruby_sdk', '~> 0.2.27'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1566,7 +1566,7 @@ the same permissions.</li>
 </ol>
 Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.  
 For Digital Ocean Spaces, generate the above credentials in your Applications and API page here https://cloud.digitalocean.com/account/api/spaces.
-Endpoint URL is required to connect Digital Ocean Spaces.
+Endpoint URL is required to connect Digital Ocean Spaces. It should look like <<region>>.digitaloceanspaces.com
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1617,7 +1617,7 @@ success state.
 
 ```ruby
 result = carbon.integrations.get_oauth_url(
-  service: "GOOGLE_CLOUD_STORAGE",
+  service: "BOX",
   tags: None,
   scope: "string_example",
   chunk_size: 1500,
@@ -1657,7 +1657,7 @@ p result
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### service: [`DataSourceType`](./lib/carbon_ruby_sdk/models/data_source_type.rb)<a id="service-datasourcetypelibcarbon_ruby_sdkmodelsdata_source_typerb"></a>
+##### service: [`ExternalDataSourceType`](./lib/carbon_ruby_sdk/models/external_data_source_type.rb)<a id="service-externaldatasourcetypelibcarbon_ruby_sdkmodelsexternal_data_source_typerb"></a>
 ##### tags: `Object`<a id="tags-object"></a>
 ##### scope: `String`<a id="scope-string"></a>
 ##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
@@ -1695,7 +1695,7 @@ This request id will be added to all files that get synced using the generated
 OAuth URL
 
 ##### use_ocr: `Boolean`<a id="use_ocr-boolean"></a>
-Enable OCR for files that support it. Supported formats: pdf, jpg, png
+Enable OCR for files that support it. Supported formats: pdf, png, jpg
 
 ##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
 ##### enable_file_picker: `Boolean`<a id="enable_file_picker-boolean"></a>

data/lib/carbon_ruby_sdk/api/integrations_api.rb

@@ -517,7 +517,7 @@ module Carbon
     # </ol>
     # Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.  
     # For Digital Ocean Spaces, generate the above credentials in your Applications and API page here https://cloud.digitalocean.com/account/api/spaces.
-    # Endpoint URL is required to connect Digital Ocean Spaces.
+    # Endpoint URL is required to connect Digital Ocean Spaces. It should look like <<region>>.digitaloceanspaces.com
     #
     # @param access_key [String] 
     # @param access_key_secret [String] 
@@ -547,7 +547,7 @@ module Carbon
     # </ol>
     # Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.  
     # For Digital Ocean Spaces, generate the above credentials in your Applications and API page here https://cloud.digitalocean.com/account/api/spaces.
-    # Endpoint URL is required to connect Digital Ocean Spaces.
+    # Endpoint URL is required to connect Digital Ocean Spaces. It should look like <<region>>.digitaloceanspaces.com
     #
     # @param access_key [String] 
     # @param access_key_secret [String] 
@@ -566,7 +566,7 @@ module Carbon
     end
 
     # S3 Auth
-    # This endpoint can be used to connect S3 as well as Digital Ocean Spaces (S3 compatible)   For S3, create a new IAM user with permissions to: <ol> <li>List all buckets.</li> <li>Read from the specific buckets and objects to sync with Carbon. Ensure any future buckets or objects carry  the same permissions.</li> </ol> Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.   For Digital Ocean Spaces, generate the above credentials in your Applications and API page here https://cloud.digitalocean.com/account/api/spaces. Endpoint URL is required to connect Digital Ocean Spaces.
+    # This endpoint can be used to connect S3 as well as Digital Ocean Spaces (S3 compatible)   For S3, create a new IAM user with permissions to: <ol> <li>List all buckets.</li> <li>Read from the specific buckets and objects to sync with Carbon. Ensure any future buckets or objects carry  the same permissions.</li> </ol> Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.   For Digital Ocean Spaces, generate the above credentials in your Applications and API page here https://cloud.digitalocean.com/account/api/spaces. Endpoint URL is required to connect Digital Ocean Spaces. It should look like <<region>>.digitaloceanspaces.com
     # @param s3_auth_request [S3AuthRequest] 
     # @param [Hash] opts the optional parameters
     # @return [OrganizationUserDataSourceAPI]
@@ -576,7 +576,7 @@ module Carbon
     end
 
     # S3 Auth
-    # This endpoint can be used to connect S3 as well as Digital Ocean Spaces (S3 compatible)   For S3, create a new IAM user with permissions to: &lt;ol&gt; &lt;li&gt;List all buckets.&lt;/li&gt; &lt;li&gt;Read from the specific buckets and objects to sync with Carbon. Ensure any future buckets or objects carry  the same permissions.&lt;/li&gt; &lt;/ol&gt; Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.   For Digital Ocean Spaces, generate the above credentials in your Applications and API page here https://cloud.digitalocean.com/account/api/spaces. Endpoint URL is required to connect Digital Ocean Spaces.
+    # This endpoint can be used to connect S3 as well as Digital Ocean Spaces (S3 compatible)   For S3, create a new IAM user with permissions to: &lt;ol&gt; &lt;li&gt;List all buckets.&lt;/li&gt; &lt;li&gt;Read from the specific buckets and objects to sync with Carbon. Ensure any future buckets or objects carry  the same permissions.&lt;/li&gt; &lt;/ol&gt; Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.   For Digital Ocean Spaces, generate the above credentials in your Applications and API page here https://cloud.digitalocean.com/account/api/spaces. Endpoint URL is required to connect Digital Ocean Spaces. It should look like &lt;&lt;region&gt;&gt;.digitaloceanspaces.com
     # @param s3_auth_request [S3AuthRequest] 
     # @param [Hash] opts the optional parameters
     # @return [APIResponse] data is OrganizationUserDataSourceAPI, status code, headers and response
@@ -641,7 +641,7 @@ module Carbon
     # - A file syncing URL which skips the OAuth flow if the user already has a valid access token and takes them to the
     # success state.
     #
-    # @param service [DataSourceType] 
+    # @param service [ExternalDataSourceType] 
     # @param tags [Object] 
     # @param scope [String] 
     # @param chunk_size [Integer] 
@@ -661,7 +661,7 @@ module Carbon
     # @param data_source_id [Integer] Used to specify a data source to sync from if you have multiple connected. It can be skipped if you only have one data source of that type connected or are connecting a new account.
     # @param connecting_new_account [Boolean] Used to connect a new data source. If not specified, we will attempt to create a sync URL for an existing data source based on type and ID.
     # @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
-    # @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf, jpg, png
+    # @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf, png, jpg
     # @param parse_pdf_tables_with_ocr [Boolean] 
     # @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: BOX, DROPBOX, GOOGLE_DRIVE, ONEDRIVE, SHAREPOINT
     # @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
@@ -711,7 +711,7 @@ module Carbon
     # - A file syncing URL which skips the OAuth flow if the user already has a valid access token and takes them to the
     # success state.
     #
-    # @param service [DataSourceType] 
+    # @param service [ExternalDataSourceType] 
     # @param tags [Object] 
     # @param scope [String] 
     # @param chunk_size [Integer] 
@@ -731,7 +731,7 @@ module Carbon
     # @param data_source_id [Integer] Used to specify a data source to sync from if you have multiple connected. It can be skipped if you only have one data source of that type connected or are connecting a new account.
     # @param connecting_new_account [Boolean] Used to connect a new data source. If not specified, we will attempt to create a sync URL for an existing data source based on type and ID.
     # @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
-    # @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf, jpg, png
+    # @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf, png, jpg
     # @param parse_pdf_tables_with_ocr [Boolean] 
     # @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: BOX, DROPBOX, GOOGLE_DRIVE, ONEDRIVE, SHAREPOINT
     # @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint

data/lib/carbon_ruby_sdk/models/external_data_source_type.rb

@@ -0,0 +1,49 @@
+=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 ExternalDataSourceType
+    BOX = "BOX".freeze
+    CONFLUENCE = "CONFLUENCE".freeze
+    DROPBOX = "DROPBOX".freeze
+    GMAIL = "GMAIL".freeze
+    GOOGLE_DRIVE = "GOOGLE_DRIVE".freeze
+    GOOGLE_CLOUD_STORAGE = "GOOGLE_CLOUD_STORAGE".freeze
+    INTERCOM = "INTERCOM".freeze
+    NOTION = "NOTION".freeze
+    ONEDRIVE = "ONEDRIVE".freeze
+    OUTLOOK = "OUTLOOK".freeze
+    SALESFORCE = "SALESFORCE".freeze
+    SHAREPOINT = "SHAREPOINT".freeze
+    SLACK = "SLACK".freeze
+    ZENDESK = "ZENDESK".freeze
+    ZOTERO = "ZOTERO".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
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @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"
+    end
+  end
+end

data/lib/carbon_ruby_sdk/models/o_auth_url_request.rb

@@ -56,7 +56,7 @@ module Carbon
     # This request id will be added to all files that get synced using the generated OAuth URL
     attr_accessor :request_id
 
-    # Enable OCR for files that support it. Supported formats: pdf, jpg, png
+    # Enable OCR for files that support it. Supported formats: pdf, png, jpg
     attr_accessor :use_ocr
 
     attr_accessor :parse_pdf_tables_with_ocr
@@ -118,7 +118,7 @@ module Carbon
       {
         :'tags' => :'Object',
         :'scope' => :'String',
-        :'service' => :'DataSourceType',
+        :'service' => :'ExternalDataSourceType',
         :'chunk_size' => :'Integer',
         :'chunk_overlap' => :'Integer',
         :'skip_embedding_generation' => :'Boolean',

data/lib/carbon_ruby_sdk/version.rb

@@ -7,5 +7,5 @@ The version of the OpenAPI document: 1.0.0
 =end
 
 module Carbon
-  VERSION = '0.2.25'
+  VERSION = '0.2.27'
 end

data/lib/carbon_ruby_sdk.rb

@@ -50,6 +50,7 @@ require 'carbon_ruby_sdk/models/embeddings_and_chunks_order_by_columns'
 require 'carbon_ruby_sdk/models/embeddings_and_chunks_query_input'
 require 'carbon_ruby_sdk/models/embeddings_and_chunks_query_input_v2'
 require 'carbon_ruby_sdk/models/embeddings_and_chunks_response'
+require 'carbon_ruby_sdk/models/external_data_source_type'
 require 'carbon_ruby_sdk/models/external_file_sync_statuses'
 require 'carbon_ruby_sdk/models/external_source_item'
 require 'carbon_ruby_sdk/models/external_source_items_order_by'

data/spec/api/integrations_api_spec.rb

@@ -74,7 +74,7 @@ describe 'IntegrationsApi' do
 
   # unit tests for create_aws_iam_user
   # S3 Auth
-  # This endpoint can be used to connect S3 as well as Digital Ocean Spaces (S3 compatible)   For S3, create a new IAM user with permissions to: <ol> <li>List all buckets.</li> <li>Read from the specific buckets and objects to sync with Carbon. Ensure any future buckets or objects carry  the same permissions.</li> </ol> Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.   For Digital Ocean Spaces, generate the above credentials in your Applications and API page here https://cloud.digitalocean.com/account/api/spaces. Endpoint URL is required to connect Digital Ocean Spaces.
+  # This endpoint can be used to connect S3 as well as Digital Ocean Spaces (S3 compatible)   For S3, create a new IAM user with permissions to: <ol> <li>List all buckets.</li> <li>Read from the specific buckets and objects to sync with Carbon. Ensure any future buckets or objects carry  the same permissions.</li> </ol> Once created, generate an access key for this user and share the credentials with us. We recommend testing this key beforehand.   For Digital Ocean Spaces, generate the above credentials in your Applications and API page here https://cloud.digitalocean.com/account/api/spaces. Endpoint URL is required to connect Digital Ocean Spaces. It should look like <<region>>.digitaloceanspaces.com
   # @param s3_auth_request 
   # @param [Hash] opts the optional parameters
   # @return [OrganizationUserDataSourceAPI]

data/spec/models/external_data_source_type_spec.rb

@@ -0,0 +1,22 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Carbon::ExternalDataSourceType
+describe Carbon::ExternalDataSourceType do
+  let(:instance) { Carbon::ExternalDataSourceType.new }
+
+  describe 'test an instance of ExternalDataSourceType' do
+    it 'should create an instance of ExternalDataSourceType' do
+      expect(instance).to be_instance_of(Carbon::ExternalDataSourceType)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carbon_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.25
+  version: 0.2.27
 platform: ruby
 authors:
 - Konfig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-21 00:00:00.000000000 Z
+date: 2024-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -132,6 +132,7 @@ files:
 - lib/carbon_ruby_sdk/models/embeddings_and_chunks_query_input.rb
 - lib/carbon_ruby_sdk/models/embeddings_and_chunks_query_input_v2.rb
 - lib/carbon_ruby_sdk/models/embeddings_and_chunks_response.rb
+- lib/carbon_ruby_sdk/models/external_data_source_type.rb
 - lib/carbon_ruby_sdk/models/external_file_sync_statuses.rb
 - lib/carbon_ruby_sdk/models/external_source_item.rb
 - lib/carbon_ruby_sdk/models/external_source_items_order_by.rb
@@ -305,6 +306,7 @@ files:
 - spec/models/embeddings_and_chunks_query_input_spec.rb
 - spec/models/embeddings_and_chunks_query_input_v2_spec.rb
 - spec/models/embeddings_and_chunks_response_spec.rb
+- spec/models/external_data_source_type_spec.rb
 - spec/models/external_file_sync_statuses_spec.rb
 - spec/models/external_source_item_spec.rb
 - spec/models/external_source_items_order_by_spec.rb
@@ -600,6 +602,7 @@ test_files:
 - spec/models/list_users_request_spec.rb
 - spec/models/gitbook_sync_request_spec.rb
 - spec/models/http_validation_error_spec.rb
+- spec/models/external_data_source_type_spec.rb
 - spec/models/embedding_and_chunk_spec.rb
 - spec/models/embedding_properties_spec.rb
 - spec/models/file_sync_config_nullable_spec.rb