carbon_ruby_sdk 0.2.41 → 0.2.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6a3377f9d76f046be221f82a9245ff51891693ccd7da4871f731826ad9603fd
-  data.tar.gz: 16bb35d792953316029695d0931fedbcd7b0c49ff15ddf4e136074c92950a698
+  metadata.gz: 3cb19d4bb87096e93a501f8532b550859c7706bc52d16416b36e2298a59deb25
+  data.tar.gz: c7efd65f094791724b6f0dcd3ab154a95c0f3f47e4b1acee99de5bba6119a048
 SHA512:
-  metadata.gz: e6cd3fc358155e0c0f915b68da5898afecf7c03ddec2341c48187a0d3afc7e85645fc7ca3394e8df0f1d858bf96ecc893aaea8277ef570ea04283d613552b767
-  data.tar.gz: 4ad76f42235498b6ac475612e468fd1facc96d6fb28812cfce16dc2ecdf4d45a7c30cb951e64695dd9e4bc3991a6a1889d39ce31d3d5e4f883effa42c6b49a9d
+  metadata.gz: 01fc784420d00d6fbd842c89490f69e83170045b5a448e3a58faf2b46e48035e0cc18ad410e48c2e410fdb56cf824d8b9a6a2bd8993f23bcc42176646eaa69cd
+  data.tar.gz: 888a7225635431d0232a823d6801a99433632794cf7a2e7c344503e772ddda3356497d58316a4dae0e62e4e4f72a1a039a8ba66b1db83f6376cd7cb4cdff7fc5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.2.41)
+    carbon_ruby_sdk (0.2.42)
       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.41-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.41)
+[![npm](https://img.shields.io/badge/gem-v0.2.42-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.42)
 
 </div>
 
@@ -103,6 +103,10 @@ Connect external data to LLMs, no matter the source.
   * [`carbon.webhooks.add_url`](#carbonwebhooksadd_url)
   * [`carbon.webhooks.delete_url`](#carbonwebhooksdelete_url)
   * [`carbon.webhooks.urls`](#carbonwebhooksurls)
+  * [`carbon.white_label.create`](#carbonwhite_labelcreate)
+  * [`carbon.white_label.delete`](#carbonwhite_labeldelete)
+  * [`carbon.white_label.list`](#carbonwhite_labellist)
+  * [`carbon.white_label.update`](#carbonwhite_labelupdate)
 
 <!-- tocstop -->
 
@@ -111,7 +115,7 @@ Connect external data to LLMs, no matter the source.
 Add to Gemfile:
 
 ```ruby
-gem 'carbon_ruby_sdk', '~> 0.2.41'
+gem 'carbon_ruby_sdk', '~> 0.2.42'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -4359,5 +4363,139 @@ p result
 ---
 
 
+### `carbon.white_label.create`<a id="carbonwhite_labelcreate"></a>
+
+Create White Labels
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.white_label.create(
+  body: [
+        {
+            "data_source_type" => None,
+            "credentials" => {
+                "client_id" => "client_id_example",
+                "redirect_uri" => "redirect_uri_example",
+            },
+        }
+    ],
+)
+p result
+```
+
+#### ⚙️ body<a id="⚙️-body"></a>
+
+Array<[`WhiteLabelCreateRequestInner`](./lib/carbon_ruby_sdk/models/white_label_create_request_inner.rb)>
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/white_label/create` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.white_label.delete`<a id="carbonwhite_labeldelete"></a>
+
+Delete White Labels
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.white_label.delete(
+  ids: [
+        1
+    ],
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### ids: Array<`Integer`><a id="ids-array"></a>
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/white_label/delete` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.white_label.list`<a id="carbonwhite_labellist"></a>
+
+List White Labels
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.white_label.list(
+  pagination: {
+        "limit" => 10,
+        "offset" => 0,
+    },
+  order_by: "created_at",
+  order_dir: "desc",
+  filters: {
+        "ids" => [],
+        "data_source_type" => [],
+    },
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb)<a id="pagination-paginationlibcarbon_ruby_sdkmodelspaginationrb"></a>
+##### order_by: [`WhiteLabelOrderByColumns`](./lib/carbon_ruby_sdk/models/white_label_order_by_columns.rb)<a id="order_by-whitelabelorderbycolumnslibcarbon_ruby_sdkmodelswhite_label_order_by_columnsrb"></a>
+##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb)<a id="order_dir-orderdirlibcarbon_ruby_sdkmodelsorder_dirrb"></a>
+##### filters: [`WhiteLabelFilters`](./lib/carbon_ruby_sdk/models/white_label_filters.rb)<a id="filters-whitelabelfilterslibcarbon_ruby_sdkmodelswhite_label_filtersrb"></a>
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/white_label/list` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `carbon.white_label.update`<a id="carbonwhite_labelupdate"></a>
+
+Update White Label
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.white_label.update(
+  data_source_type: "INTERCOM",
+  credentials: {
+        "client_id" => "client_id_example",
+        "redirect_uri" => "redirect_uri_example",
+    },
+  body: {
+        "data_source_type" => None,
+        "credentials" => {
+            "client_id" => "client_id_example",
+            "redirect_uri" => "redirect_uri_example",
+        },
+    },
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### data_source_type: [`WhiteLabelInputDataSourceType`](./lib/carbon_ruby_sdk/models/white_label_input_data_source_type.rb)<a id="data_source_type-whitelabelinputdatasourcetypelibcarbon_ruby_sdkmodelswhite_label_input_data_source_typerb"></a>
+##### credentials: [`Credentials`](./lib/carbon_ruby_sdk/models/credentials.rb)<a id="credentials-credentialslibcarbon_ruby_sdkmodelscredentialsrb"></a>
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/white_label/update` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ## Author<a id="author"></a>
 This TypeScript package is automatically generated by [Konfig](https://konfigthis.com)

data/lib/carbon_ruby_sdk/api/white_label_api.rb

@@ -0,0 +1,393 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'cgi'
+
+module Carbon
+  class WhiteLabelApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Create White Labels
+    #
+    # @param body [Array<WhiteLabelCreateRequestInner>] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def create(body:, extra: {})
+      white_label_create_request_inner = body
+      api_response = create_with_http_info_impl(white_label_create_request_inner, extra)
+      api_response.data
+    end
+
+    # Create White Labels
+    #
+    # @param body [Array<WhiteLabelCreateRequestInner>] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def create_with_http_info(body:, extra: {})
+      white_label_create_request_inner = body
+      create_with_http_info_impl(white_label_create_request_inner, extra)
+    end
+
+    # Create White Labels
+    # @param white_label_create_request_inner [Array<WhiteLabelCreateRequestInner>] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    private def create_impl(white_label_create_request_inner, opts = {})
+      data, _status_code, _headers = create_with_http_info(white_label_create_request_inner, opts)
+      data
+    end
+
+    # Create White Labels
+    # @param white_label_create_request_inner [Array<WhiteLabelCreateRequestInner>] 
+    # @param [Hash] opts the optional parameters
+    # @return [APIResponse] data is Object, status code, headers and response
+    private def create_with_http_info_impl(white_label_create_request_inner, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WhiteLabelApi.create ...'
+      end
+      # verify the required parameter 'white_label_create_request_inner' is set
+      if @api_client.config.client_side_validation && white_label_create_request_inner.nil?
+        fail ArgumentError, "Missing the required parameter 'white_label_create_request_inner' when calling WhiteLabelApi.create"
+      end
+      # resource path
+      local_var_path = '/white_label/create'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(white_label_create_request_inner)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"WhiteLabelApi.create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WhiteLabelApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      APIResponse::new(data, status_code, headers, response)
+    end
+
+
+    # Delete White Labels
+    #
+    # @param ids [Array<Integer>] 
+    # @param body [DeleteWhiteLabelRequest] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def delete(ids:, extra: {})
+      _body = {}
+      _body[:ids] = ids if ids != SENTINEL
+      delete_white_label_request = _body
+      api_response = delete_with_http_info_impl(delete_white_label_request, extra)
+      api_response.data
+    end
+
+    # Delete White Labels
+    #
+    # @param ids [Array<Integer>] 
+    # @param body [DeleteWhiteLabelRequest] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def delete_with_http_info(ids:, extra: {})
+      _body = {}
+      _body[:ids] = ids if ids != SENTINEL
+      delete_white_label_request = _body
+      delete_with_http_info_impl(delete_white_label_request, extra)
+    end
+
+    # Delete White Labels
+    # @param delete_white_label_request [DeleteWhiteLabelRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    private def delete_impl(delete_white_label_request, opts = {})
+      data, _status_code, _headers = delete_with_http_info(delete_white_label_request, opts)
+      data
+    end
+
+    # Delete White Labels
+    # @param delete_white_label_request [DeleteWhiteLabelRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [APIResponse] data is Object, status code, headers and response
+    private def delete_with_http_info_impl(delete_white_label_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WhiteLabelApi.delete ...'
+      end
+      # verify the required parameter 'delete_white_label_request' is set
+      if @api_client.config.client_side_validation && delete_white_label_request.nil?
+        fail ArgumentError, "Missing the required parameter 'delete_white_label_request' when calling WhiteLabelApi.delete"
+      end
+      # resource path
+      local_var_path = '/white_label/delete'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(delete_white_label_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"WhiteLabelApi.delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WhiteLabelApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      APIResponse::new(data, status_code, headers, response)
+    end
+
+
+    # List White Labels
+    #
+    # @param pagination [Pagination] 
+    # @param order_by [WhiteLabelOrderByColumns] 
+    # @param order_dir [OrderDir] 
+    # @param filters [WhiteLabelFilters] 
+    # @param body [ListWhiteLabelRequest] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def list(pagination: SENTINEL, order_by: 'created_at', order_dir: 'asc', filters: SENTINEL, extra: {})
+      _body = {}
+      _body[:pagination] = pagination if pagination != SENTINEL
+      _body[:order_by] = order_by if order_by != SENTINEL
+      _body[:order_dir] = order_dir if order_dir != SENTINEL
+      _body[:filters] = filters if filters != SENTINEL
+      list_white_label_request = _body
+      api_response = list_with_http_info_impl(list_white_label_request, extra)
+      api_response.data
+    end
+
+    # List White Labels
+    #
+    # @param pagination [Pagination] 
+    # @param order_by [WhiteLabelOrderByColumns] 
+    # @param order_dir [OrderDir] 
+    # @param filters [WhiteLabelFilters] 
+    # @param body [ListWhiteLabelRequest] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def list_with_http_info(pagination: SENTINEL, order_by: 'created_at', order_dir: 'asc', filters: SENTINEL, extra: {})
+      _body = {}
+      _body[:pagination] = pagination if pagination != SENTINEL
+      _body[:order_by] = order_by if order_by != SENTINEL
+      _body[:order_dir] = order_dir if order_dir != SENTINEL
+      _body[:filters] = filters if filters != SENTINEL
+      list_white_label_request = _body
+      list_with_http_info_impl(list_white_label_request, extra)
+    end
+
+    # List White Labels
+    # @param list_white_label_request [ListWhiteLabelRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    private def list_impl(list_white_label_request, opts = {})
+      data, _status_code, _headers = list_with_http_info(list_white_label_request, opts)
+      data
+    end
+
+    # List White Labels
+    # @param list_white_label_request [ListWhiteLabelRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [APIResponse] data is Object, status code, headers and response
+    private def list_with_http_info_impl(list_white_label_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WhiteLabelApi.list ...'
+      end
+      # verify the required parameter 'list_white_label_request' is set
+      if @api_client.config.client_side_validation && list_white_label_request.nil?
+        fail ArgumentError, "Missing the required parameter 'list_white_label_request' when calling WhiteLabelApi.list"
+      end
+      # resource path
+      local_var_path = '/white_label/list'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(list_white_label_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"WhiteLabelApi.list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WhiteLabelApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      APIResponse::new(data, status_code, headers, response)
+    end
+
+
+    # Update White Label
+    #
+    # @param data_source_type [WhiteLabelInputDataSourceType] 
+    # @param credentials [Credentials] 
+    # @param body [WhiteLabelUpdateRequest] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def update(data_source_type: SENTINEL, credentials: SENTINEL, body:, extra: {})
+      white_label_update_request = body
+      api_response = update_with_http_info_impl(white_label_update_request, extra)
+      api_response.data
+    end
+
+    # Update White Label
+    #
+    # @param data_source_type [WhiteLabelInputDataSourceType] 
+    # @param credentials [Credentials] 
+    # @param body [WhiteLabelUpdateRequest] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def update_with_http_info(data_source_type: SENTINEL, credentials: SENTINEL, body:, extra: {})
+      white_label_update_request = body
+      update_with_http_info_impl(white_label_update_request, extra)
+    end
+
+    # Update White Label
+    # @param white_label_update_request [WhiteLabelUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    private def update_impl(white_label_update_request, opts = {})
+      data, _status_code, _headers = update_with_http_info(white_label_update_request, opts)
+      data
+    end
+
+    # Update White Label
+    # @param white_label_update_request [WhiteLabelUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [APIResponse] data is Object, status code, headers and response
+    private def update_with_http_info_impl(white_label_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WhiteLabelApi.update ...'
+      end
+      # verify the required parameter 'white_label_update_request' is set
+      if @api_client.config.client_side_validation && white_label_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'white_label_update_request' when calling WhiteLabelApi.update"
+      end
+      # resource path
+      local_var_path = '/white_label/update'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(white_label_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"WhiteLabelApi.update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WhiteLabelApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      APIResponse::new(data, status_code, headers, response)
+    end
+  end
+
+  # top-level client access to avoid having the user to insantiate their own API instances
+  WhiteLabel = WhiteLabelApi::new
+end