carbon_ruby_sdk 0.2.34 → 0.2.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c615043a22001b809427090b655a09b2690f1f8f6c8255ce26a398c90c7c4177
-  data.tar.gz: 95408e90a58a24971983f24684703b22cc7523416b54ee4bc2093c5b0c749b73
+  metadata.gz: feb3bf140f11338eaf815475a55ba8751606f8f21374053373ec879382f29ddf
+  data.tar.gz: 889b8720854243b0dc2dc24a013decb6729ec4c2c4d4258eb91a3390bf5e384e
 SHA512:
-  metadata.gz: b04d6d46357ace8ce48a79a4ded1529481d5c884f8b8198e93fa68e9cb9323044d08f06951fcd8f1cb1368fa8cb3cfab0e28a12b81011845102feeb55e1e3593
-  data.tar.gz: 93515e462ac0ec85414edf4b616ad852e6e60bbb6aef4775f61c8d6b9084e676117f455628b13750efe9051aad23ec6f124cf015bbc5001a63fbb4b0b5e146de
+  metadata.gz: d6387b53a698980d8efb5a6ea15e93576a9c2e5a858f350eda44904d8a00ed29813a54520b6a1746ced917d3734c48cb9259b2ed9d0af2c733a2a5f1dcf30b70
+  data.tar.gz: b7c140b501299de1da58914dc2f1fb8803682b7c2a5249a14544dd006aaa6a3c6a71afec871bcc324e96142761c9266663545c6a0802ce54a64a2a3dc2e2eb9c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.2.34)
+    carbon_ruby_sdk (0.2.36)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

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.34-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.34)
+[![npm](https://img.shields.io/badge/gem-v0.2.36-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.36)
 
 </div>
 
@@ -20,6 +20,14 @@ Connect external data to LLMs, no matter the source.
 - [Reference](#reference)
   * [`carbon.auth.get_access_token`](#carbonauthget_access_token)
   * [`carbon.auth.get_white_labeling`](#carbonauthget_white_labeling)
+  * [`carbon.crm.get_account`](#carboncrmget_account)
+  * [`carbon.crm.get_accounts`](#carboncrmget_accounts)
+  * [`carbon.crm.get_contact`](#carboncrmget_contact)
+  * [`carbon.crm.get_contacts`](#carboncrmget_contacts)
+  * [`carbon.crm.get_lead`](#carboncrmget_lead)
+  * [`carbon.crm.get_leads`](#carboncrmget_leads)
+  * [`carbon.crm.get_opportunities`](#carboncrmget_opportunities)
+  * [`carbon.crm.get_opportunity`](#carboncrmget_opportunity)
   * [`carbon.data_sources.query_user_data_sources`](#carbondata_sourcesquery_user_data_sources)
   * [`carbon.data_sources.revoke_access_token`](#carbondata_sourcesrevoke_access_token)
   * [`carbon.embeddings.get_documents`](#carbonembeddingsget_documents)
@@ -56,6 +64,8 @@ Connect external data to LLMs, no matter the source.
   * [`carbon.integrations.list_labels`](#carbonintegrationslist_labels)
   * [`carbon.integrations.list_outlook_categories`](#carbonintegrationslist_outlook_categories)
   * [`carbon.integrations.list_repos`](#carbonintegrationslist_repos)
+  * [`carbon.integrations.sync_azure_blob_files`](#carbonintegrationssync_azure_blob_files)
+  * [`carbon.integrations.sync_azure_blob_storage`](#carbonintegrationssync_azure_blob_storage)
   * [`carbon.integrations.sync_confluence`](#carbonintegrationssync_confluence)
   * [`carbon.integrations.sync_data_source_items`](#carbonintegrationssync_data_source_items)
   * [`carbon.integrations.sync_files`](#carbonintegrationssync_files)
@@ -94,7 +104,7 @@ Connect external data to LLMs, no matter the source.
 Add to Gemfile:
 
 ```ruby
-gem 'carbon_ruby_sdk', '~> 0.2.34'
+gem 'carbon_ruby_sdk', '~> 0.2.36'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -186,6 +196,331 @@ p result
 ---
 
 
+### `carbon.crm.get_account`<a id="carboncrmget_account"></a>
+
+Get Account
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.crm.get_account(
+  id: "id_example",
+  data_source_id: 1,
+  include_remote_data: false,
+  includes: [
+        "string_example"
+    ],
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### id: `String`<a id="id-string"></a>
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
+##### include_remote_data: `Boolean`<a id="include_remote_data-boolean"></a>
+##### includes: Array<[`BaseIncludes`](./lib/carbon_ruby_sdk/models/base_includes.rb)><a id="includes-array"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[Account](./lib/carbon_ruby_sdk/models/account.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/data/crm/accounts/{id}` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.crm.get_accounts`<a id="carboncrmget_accounts"></a>
+
+Get Accounts
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.crm.get_accounts(
+  data_source_id: 1,
+  include_remote_data: false,
+  next_cursor: "string_example",
+  page_size: 1,
+  order_dir: "asc",
+  includes: [],
+  filters: {
+    },
+  order_by: "created_at",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
+##### include_remote_data: `Boolean`<a id="include_remote_data-boolean"></a>
+##### next_cursor: `String`<a id="next_cursor-string"></a>
+##### page_size: `Integer`<a id="page_size-integer"></a>
+##### order_dir: [`OrderDirV2Nullable`](./lib/carbon_ruby_sdk/models/order_dir_v2_nullable.rb)<a id="order_dir-orderdirv2nullablelibcarbon_ruby_sdkmodelsorder_dir_v2_nullablerb"></a>
+##### includes: Array<[`BaseIncludes`](./lib/carbon_ruby_sdk/models/base_includes.rb)><a id="includes-array"></a>
+##### filters: [`AccountFilters`](./lib/carbon_ruby_sdk/models/account_filters.rb)<a id="filters-accountfilterslibcarbon_ruby_sdkmodelsaccount_filtersrb"></a>
+##### order_by: [`AccountsOrderByNullable`](./lib/carbon_ruby_sdk/models/accounts_order_by_nullable.rb)<a id="order_by-accountsorderbynullablelibcarbon_ruby_sdkmodelsaccounts_order_by_nullablerb"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[AccountResponse](./lib/carbon_ruby_sdk/models/account_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/data/crm/accounts` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.crm.get_contact`<a id="carboncrmget_contact"></a>
+
+Get Contact
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.crm.get_contact(
+  id: "id_example",
+  data_source_id: 1,
+  include_remote_data: false,
+  includes: [
+        "string_example"
+    ],
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### id: `String`<a id="id-string"></a>
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
+##### include_remote_data: `Boolean`<a id="include_remote_data-boolean"></a>
+##### includes: Array<[`BaseIncludes`](./lib/carbon_ruby_sdk/models/base_includes.rb)><a id="includes-array"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[Contact](./lib/carbon_ruby_sdk/models/contact.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/data/crm/contacts/{id}` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.crm.get_contacts`<a id="carboncrmget_contacts"></a>
+
+Get Contacts
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.crm.get_contacts(
+  data_source_id: 1,
+  include_remote_data: false,
+  next_cursor: "string_example",
+  page_size: 1,
+  order_dir: "asc",
+  includes: [],
+  filters: {
+    },
+  order_by: "created_at",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
+##### include_remote_data: `Boolean`<a id="include_remote_data-boolean"></a>
+##### next_cursor: `String`<a id="next_cursor-string"></a>
+##### page_size: `Integer`<a id="page_size-integer"></a>
+##### order_dir: [`OrderDirV2Nullable`](./lib/carbon_ruby_sdk/models/order_dir_v2_nullable.rb)<a id="order_dir-orderdirv2nullablelibcarbon_ruby_sdkmodelsorder_dir_v2_nullablerb"></a>
+##### includes: Array<[`BaseIncludes`](./lib/carbon_ruby_sdk/models/base_includes.rb)><a id="includes-array"></a>
+##### filters: [`ContactFilters`](./lib/carbon_ruby_sdk/models/contact_filters.rb)<a id="filters-contactfilterslibcarbon_ruby_sdkmodelscontact_filtersrb"></a>
+##### order_by: [`ContactsOrderByNullable`](./lib/carbon_ruby_sdk/models/contacts_order_by_nullable.rb)<a id="order_by-contactsorderbynullablelibcarbon_ruby_sdkmodelscontacts_order_by_nullablerb"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[ContactsResponse](./lib/carbon_ruby_sdk/models/contacts_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/data/crm/contacts` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.crm.get_lead`<a id="carboncrmget_lead"></a>
+
+Get Lead
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.crm.get_lead(
+  id: "id_example",
+  data_source_id: 1,
+  include_remote_data: false,
+  includes: [
+        "string_example"
+    ],
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### id: `String`<a id="id-string"></a>
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
+##### include_remote_data: `Boolean`<a id="include_remote_data-boolean"></a>
+##### includes: Array<[`BaseIncludes`](./lib/carbon_ruby_sdk/models/base_includes.rb)><a id="includes-array"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[Lead](./lib/carbon_ruby_sdk/models/lead.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/data/crm/leads/{id}` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.crm.get_leads`<a id="carboncrmget_leads"></a>
+
+Get Leads
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.crm.get_leads(
+  data_source_id: 1,
+  include_remote_data: false,
+  next_cursor: "string_example",
+  page_size: 1,
+  order_dir: "asc",
+  includes: [],
+  filters: {
+    },
+  order_by: "created_at",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
+##### include_remote_data: `Boolean`<a id="include_remote_data-boolean"></a>
+##### next_cursor: `String`<a id="next_cursor-string"></a>
+##### page_size: `Integer`<a id="page_size-integer"></a>
+##### order_dir: [`OrderDirV2Nullable`](./lib/carbon_ruby_sdk/models/order_dir_v2_nullable.rb)<a id="order_dir-orderdirv2nullablelibcarbon_ruby_sdkmodelsorder_dir_v2_nullablerb"></a>
+##### includes: Array<[`BaseIncludes`](./lib/carbon_ruby_sdk/models/base_includes.rb)><a id="includes-array"></a>
+##### filters: [`LeadFilters`](./lib/carbon_ruby_sdk/models/lead_filters.rb)<a id="filters-leadfilterslibcarbon_ruby_sdkmodelslead_filtersrb"></a>
+##### order_by: [`LeadsOrderByNullable`](./lib/carbon_ruby_sdk/models/leads_order_by_nullable.rb)<a id="order_by-leadsorderbynullablelibcarbon_ruby_sdkmodelsleads_order_by_nullablerb"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[LeadsResponse](./lib/carbon_ruby_sdk/models/leads_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/data/crm/leads` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.crm.get_opportunities`<a id="carboncrmget_opportunities"></a>
+
+Get Opportunities
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.crm.get_opportunities(
+  data_source_id: 1,
+  include_remote_data: false,
+  next_cursor: "string_example",
+  page_size: 1,
+  order_dir: "asc",
+  includes: [],
+  filters: {
+        "status" => "WON",
+    },
+  order_by: "created_at",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
+##### include_remote_data: `Boolean`<a id="include_remote_data-boolean"></a>
+##### next_cursor: `String`<a id="next_cursor-string"></a>
+##### page_size: `Integer`<a id="page_size-integer"></a>
+##### order_dir: [`OrderDirV2Nullable`](./lib/carbon_ruby_sdk/models/order_dir_v2_nullable.rb)<a id="order_dir-orderdirv2nullablelibcarbon_ruby_sdkmodelsorder_dir_v2_nullablerb"></a>
+##### includes: Array<[`BaseIncludes`](./lib/carbon_ruby_sdk/models/base_includes.rb)><a id="includes-array"></a>
+##### filters: [`OpportunityFilters`](./lib/carbon_ruby_sdk/models/opportunity_filters.rb)<a id="filters-opportunityfilterslibcarbon_ruby_sdkmodelsopportunity_filtersrb"></a>
+##### order_by: [`OpportunitiesOrderByNullable`](./lib/carbon_ruby_sdk/models/opportunities_order_by_nullable.rb)<a id="order_by-opportunitiesorderbynullablelibcarbon_ruby_sdkmodelsopportunities_order_by_nullablerb"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[OpportunitiesResponse](./lib/carbon_ruby_sdk/models/opportunities_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/data/crm/opportunities` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.crm.get_opportunity`<a id="carboncrmget_opportunity"></a>
+
+Get Opportunity
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.crm.get_opportunity(
+  id: "id_example",
+  data_source_id: 1,
+  include_remote_data: false,
+  includes: [
+        "string_example"
+    ],
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### id: `String`<a id="id-string"></a>
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
+##### include_remote_data: `Boolean`<a id="include_remote_data-boolean"></a>
+##### includes: Array<[`BaseIncludes`](./lib/carbon_ruby_sdk/models/base_includes.rb)><a id="includes-array"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[Opportunity](./lib/carbon_ruby_sdk/models/opportunity.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/data/crm/opportunities/{id}` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `carbon.data_sources.query_user_data_sources`<a id="carbondata_sourcesquery_user_data_sources"></a>
 
 User Data Sources
@@ -2096,6 +2431,129 @@ p result
 ---
 
 
+### `carbon.integrations.sync_azure_blob_files`<a id="carbonintegrationssync_azure_blob_files"></a>
+
+After optionally loading the items via /integrations/items/sync and integrations/items/list, use the container name 
+and file name as the ID in this endpoint to sync them into Carbon. Additional parameters below can associate 
+data with the selected items or modify the sync behavior
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.integrations.sync_azure_blob_files(
+  ids: [
+        {
+        }
+    ],
+  tags: {},
+  chunk_size: 1500,
+  chunk_overlap: 20,
+  skip_embedding_generation: false,
+  embedding_model: "OPENAI",
+  generate_sparse_vectors: false,
+  prepend_filename_to_chunks: false,
+  max_items_per_chunk: 1,
+  set_page_as_boundary: false,
+  data_source_id: 1,
+  request_id: "string_example",
+  use_ocr: false,
+  parse_pdf_tables_with_ocr: false,
+  file_sync_config: {
+        "auto_synced_source_types" => ["ARTICLE"],
+        "sync_attachments" => false,
+        "detect_audio_language" => false,
+        "transcription_service" => "assemblyai",
+        "include_speaker_labels" => false,
+        "split_rows" => false,
+        "generate_chunks_only" => false,
+        "skip_file_processing" => false,
+    },
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### ids: Array<[`AzureBlobGetFileInput`](./lib/carbon_ruby_sdk/models/azure_blob_get_file_input.rb)><a id="ids-array"></a>
+##### tags: `Object`<a id="tags-object"></a>
+##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
+##### chunk_overlap: `Integer`<a id="chunk_overlap-integer"></a>
+##### skip_embedding_generation: `Boolean`<a id="skip_embedding_generation-boolean"></a>
+##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
+##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
+##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
+##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
+##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
+##### request_id: `String`<a id="request_id-string"></a>
+##### use_ocr: `Boolean`<a id="use_ocr-boolean"></a>
+##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
+##### file_sync_config: [`FileSyncConfigNullable`](./lib/carbon_ruby_sdk/models/file_sync_config_nullable.rb)<a id="file_sync_config-filesyncconfignullablelibcarbon_ruby_sdkmodelsfile_sync_config_nullablerb"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/azure_blob_storage/files` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.integrations.sync_azure_blob_storage`<a id="carbonintegrationssync_azure_blob_storage"></a>
+
+This endpoint can be used to connect Azure Blob Storage.
+
+For Azure Blob Storage, follow these steps:
+<ol>
+  <li>Create a new Azure Storage account and grant the following permissions:
+    <ul>
+      <li>List containers.</li>
+      <li>Read from specific containers and blobs to sync with Carbon. Ensure any future containers or blobs carry the same permissions.</li>
+    </ul>
+  </li>
+  <li>Generate a shared access signature (SAS) token or an access key for the storage account.</li>
+</ol>
+
+Once created, provide us with the following details to generate the connection URL:
+<ol>
+  <li>Storage Account KeyName.</li>
+  <li>Storage Account Name.</li>
+</ol>
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.integrations.sync_azure_blob_storage(
+  account_name: "string_example",
+  account_key: "string_example",
+  sync_source_items: true,
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_name: `String`<a id="account_name-string"></a>
+##### account_key: `String`<a id="account_key-string"></a>
+##### sync_source_items: `Boolean`<a id="sync_source_items-boolean"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[OrganizationUserDataSourceAPI](./lib/carbon_ruby_sdk/models/organization_user_data_source_api.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/azure_blob_storage` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `carbon.integrations.sync_confluence`<a id="carbonintegrationssync_confluence"></a>
 ![Deprecated](https://img.shields.io/badge/deprecated-yellow)