carbon_ruby_sdk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0079046fb886087dd02811d7d0e550a31890f70ff9028e4f058410be329bf3a
-  data.tar.gz: 58492681bfb20d468b52e3664b5b9b3c0d51e0899f727a22a90b120fbb7e8ba1
+  metadata.gz: 0ac0406a2bcc091f1b785056208818772d945edc8634ccc1b4cb2a8bf5f73cd7
+  data.tar.gz: e5682cad97249914d7c5f922e80b2ee86a467d3634f6db822ea2cf5086f08795
 SHA512:
-  metadata.gz: 17bb4c1f38cbc7da7d15edfaf71266422107be105dbdf1f4d50970ac4ae6da145526b91901e4f2fb0bcd42e5b9285384ba3de9ab5e7edcf124ff7693bde6735d
-  data.tar.gz: 030cc1d03e549e6f00ac1dddf6aeefb439ce34af91a7deb6cc6869dbfcf6fffe037be43c8137e911807ca3adadd8b7e32ea6fad6b17d0763c0003f8920ce0e46
+  metadata.gz: d63ba01faf33b9020042e0ab85c476e2cf574313ad326f4a852991c1dbb763a87a93a13d8454bbc8ee6bf3d103c0a08b7f6a4e00837a442d7f8982bab75d396a
+  data.tar.gz: 9f7f119910df0a84786c48a82cee23fb2aa5e8775251e87e71ccde038545db693af9244b7305c328b63cd8bca07ba71bcb91aa2f485e275fd2eb83a35d6ea959

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.1.1)
+    carbon_ruby_sdk (0.1.2)
       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.1.1-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.1)
+[![npm](https://img.shields.io/badge/gem-v0.1.2-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.2)
 
 </div>
 
@@ -57,6 +57,7 @@ Connect external data to LLMs, no matter the source.
   * [`carbon.integrations.sync_rss_feed`](#carbonintegrationssync_rss_feed)
   * [`carbon.integrations.sync_s3_files`](#carbonintegrationssync_s3_files)
   * [`carbon.organizations.get`](#carbonorganizationsget)
+  * [`carbon.users.delete`](#carbonusersdelete)
   * [`carbon.users.get`](#carbonusersget)
   * [`carbon.users.toggle_user_features`](#carbonuserstoggle_user_features)
   * [`carbon.utilities.fetch_urls`](#carbonutilitiesfetch_urls)
@@ -76,7 +77,7 @@ Connect external data to LLMs, no matter the source.
 Add to Gemfile:
 
 ```ruby
-gem 'carbon_ruby_sdk', '~> 0.1.1'
+gem 'carbon_ruby_sdk', '~> 0.1.2'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1941,6 +1942,37 @@ p result
 ---
 
 
+### `carbon.users.delete`<a id="carbonusersdelete"></a>
+
+Delete Users
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.users.delete(
+  customer_ids: [
+        "string_example"
+    ],
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### customer_ids: Array<`String`><a id="customer_ids-array"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/delete_users` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `carbon.users.get`<a id="carbonusersget"></a>
 
 User Endpoint

data/lib/carbon_ruby_sdk/api/users_api.rb

@@ -16,6 +16,98 @@ module Carbon
       @api_client = api_client
     end
 
+    # Delete Users
+    #
+    # @param customer_ids [Array<String>] 
+    # @param body [DeleteUsersInput] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def delete(customer_ids:, extra: {})
+      _body = {}
+      _body[:customer_ids] = customer_ids if customer_ids != SENTINEL
+      delete_users_input = _body
+      api_response = delete_with_http_info_impl(delete_users_input, extra)
+      api_response.data
+    end
+
+    # Delete Users
+    #
+    # @param customer_ids [Array<String>] 
+    # @param body [DeleteUsersInput] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def delete_with_http_info(customer_ids:, extra: {})
+      _body = {}
+      _body[:customer_ids] = customer_ids if customer_ids != SENTINEL
+      delete_users_input = _body
+      delete_with_http_info_impl(delete_users_input, extra)
+    end
+
+    # Delete Users
+    # @param delete_users_input [DeleteUsersInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [GenericSuccessResponse]
+    private def delete_impl(delete_users_input, opts = {})
+      data, _status_code, _headers = delete_with_http_info(delete_users_input, opts)
+      data
+    end
+
+    # Delete Users
+    # @param delete_users_input [DeleteUsersInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [APIResponse] data is GenericSuccessResponse, status code, headers and response
+    private def delete_with_http_info_impl(delete_users_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.delete ...'
+      end
+      # verify the required parameter 'delete_users_input' is set
+      if @api_client.config.client_side_validation && delete_users_input.nil?
+        fail ArgumentError, "Missing the required parameter 'delete_users_input' when calling UsersApi.delete"
+      end
+      # resource path
+      local_var_path = '/delete_users'
+
+      # 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_users_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GenericSuccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['accessToken']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.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: UsersApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      APIResponse::new(data, status_code, headers, response)
+    end
+
+
     # User Endpoint
     #
     # @param customer_id [String] 

data/lib/carbon_ruby_sdk/models/delete_users_input.rb

@@ -0,0 +1,222 @@
+=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 DeleteUsersInput
+    attr_accessor :customer_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'customer_ids' => :'customer_ids'
+      }
+    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
+      {
+        :'customer_ids' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::DeleteUsersInput` 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::DeleteUsersInput`. 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?(:'customer_ids')
+        if (value = attributes[:'customer_ids']).is_a?(Array)
+          self.customer_ids = value
+        end
+      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 @customer_ids.nil?
+        invalid_properties.push('invalid value for "customer_ids", customer_ids 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 @customer_ids.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 &&
+          customer_ids == o.customer_ids
+    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
+      [customer_ids].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/version.rb

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

data/lib/carbon_ruby_sdk.rb

@@ -26,6 +26,7 @@ require 'carbon_ruby_sdk/models/data_source_sync_statuses'
 require 'carbon_ruby_sdk/models/data_source_type'
 require 'carbon_ruby_sdk/models/data_source_type_nullable'
 require 'carbon_ruby_sdk/models/delete_files_query_input'
+require 'carbon_ruby_sdk/models/delete_users_input'
 require 'carbon_ruby_sdk/models/directory_item'
 require 'carbon_ruby_sdk/models/document_response'
 require 'carbon_ruby_sdk/models/document_response_list'

data/spec/api/users_api_spec.rb

@@ -26,6 +26,17 @@ describe 'UsersApi' do
     end
   end
 
+  # unit tests for delete
+  # Delete Users
+  # @param delete_users_input 
+  # @param [Hash] opts the optional parameters
+  # @return [GenericSuccessResponse]
+  describe 'delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get
   # User Endpoint
   # @param user_request_content 

data/spec/models/delete_users_input_spec.rb

@@ -0,0 +1,28 @@
+=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::DeleteUsersInput
+describe Carbon::DeleteUsersInput do
+  let(:instance) { Carbon::DeleteUsersInput.new }
+
+  describe 'test an instance of DeleteUsersInput' do
+    it 'should create an instance of DeleteUsersInput' do
+      expect(instance).to be_instance_of(Carbon::DeleteUsersInput)
+    end
+  end
+  describe 'test attribute "customer_ids"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carbon_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Konfig
@@ -109,6 +109,7 @@ files:
 - lib/carbon_ruby_sdk/models/data_source_type.rb
 - lib/carbon_ruby_sdk/models/data_source_type_nullable.rb
 - lib/carbon_ruby_sdk/models/delete_files_query_input.rb
+- lib/carbon_ruby_sdk/models/delete_users_input.rb
 - lib/carbon_ruby_sdk/models/directory_item.rb
 - lib/carbon_ruby_sdk/models/document_response.rb
 - lib/carbon_ruby_sdk/models/document_response_list.rb
@@ -218,6 +219,7 @@ files:
 - spec/models/data_source_type_nullable_spec.rb
 - spec/models/data_source_type_spec.rb
 - spec/models/delete_files_query_input_spec.rb
+- spec/models/delete_users_input_spec.rb
 - spec/models/directory_item_spec.rb
 - spec/models/document_response_list_spec.rb
 - spec/models/document_response_spec.rb
@@ -429,6 +431,7 @@ test_files:
 - spec/models/fresh_desk_connect_request_spec.rb
 - spec/models/embeddings_and_chunks_filters_spec.rb
 - spec/models/raw_transcript_property_inner_value_spec.rb
+- spec/models/delete_users_input_spec.rb
 - spec/models/webhook_no_key_spec.rb
 - spec/models/s3_file_sync_input_spec.rb
 - spec/models/sync_directory_request_spec.rb