sf_cli 0.0.7 → 0.0.9

data/lib/sf_cli/sf/data/query.rb

@@ -3,21 +3,18 @@ require_relative './query_helper'
 
 module SfCli::Sf::Data
   module Query
-    # get object records using SOQL.
-    #
-    # *soql* --- SOQL<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # *format* --- get the command's raw output. human, csv, json can be available<br>
-    #
-    # *model_class* --- the object model class<br>
-    #
-    # *bulk* --- use Bulk API<br>
-    #
-    # *timeout* --- max minutes to wait for the job complete in Bulk API mode<br>
-    #
-    # ======
+    # Get object records using SOQL.
+    # @param soql        [String]        SOQL
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param format      [Symbol,String] get the command's raw output. human, csv, json can be available
+    # @param model_class [Class]         the object model class
+    # @param bulk        [Boolean]       use Bulk API
+    # @param wait        [Integer]       max minutes to wait for the job complete in Bulk API mode
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
+    #
+    # @return [Array,[String,Array]] records or a tuple containing a flag and records
+    #
+    # @example
     #   sf.data.query 'SELECT Id, Name FROM Account LIMIT 1' # => [{Id: "abc", Name: "account name"}]
     #
     #   Account = Struct.new(:Id, :Name)
@@ -32,24 +29,23 @@ module SfCli::Sf::Data
     # When using Bulk API, you get the records when the query job completes within time limit.
     # The method returns a tapple(an array), which changes its contents according to the job result.
     #
-    # ======
+    # @example
     #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true              # max wait 1 min to get result (default)
-    #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, timeout: 5  # max wait 5 min to get result
-    #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, timeout: 0  # returns immediately
+    #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, wait: 5  # max wait 5 min to get result
+    #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, wait: 0  # returns immediately
     #
     #   rows = result   if done     # if job is completed, the result is an array of record
     #   job_id = result unless done # if job hasn't completed or it has aborted, the result is the job ID
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_unified]
-    #
-    # About querying with auto generated object model, see the section {"Object Model support"}[link://files/README_rdoc.html#label-Object+Model+support+-28experimental-2C+since+0.0.4-29] in README.
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_unified command reference
     #
-    def query(soql, target_org: nil, format: nil, bulk: false, timeout: nil, model_class: nil)
+    def query(soql, target_org: nil, format: nil, bulk: false, wait: nil, api_version: nil, model_class: nil)
       flags    = {
         :"query"    => %("#{soql}"),
         :"target-org" => target_org,
         :"result-format" => format,
-        :"wait" => (bulk ? timeout : nil),
+        :"wait" => (bulk ? wait : nil),
+        :"api-version" => api_version,
       }
       switches = {
         bulk: bulk,
@@ -62,19 +58,18 @@ module SfCli::Sf::Data
       return_result(result, raw_output, bulk, model_class)
     end
 
-    # resume a bulk query job, which you previously started, and get records
-    #
-    # *job_id* ---  job ID you want to resume<br>
+    # Resume a bulk query job, which you previously started, and get records
+    # @param job_id      [String]        job ID you want to resume
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param format      [Symbol,String] get the command's raw output. human, csv, json can be available
+    # @param model_class [Class]         the object model class
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
+    # @return [Array,[String,Array]] records or a tuple containing a flag and records
     #
-    # *format* --- get the command's raw output. human, csv, json can be available<br>
-    #
-    # *model_class* --- the object model class<br>
-    #
-    # ======
+    # @example
     #   # start a query job
-    #   result1 = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, timeout: 0  # returns immediately
+    #   result1 = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, wait: 0  # returns immediately
     #
     #   result1 # => [false, "<job id>"]
     #
@@ -86,12 +81,14 @@ module SfCli::Sf::Data
     #
     #   result2 # => if done is true, this is an array of record. Otherwise it should be the Job ID.
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_resume_unified]
-    def query_resume(job_id:, target_org: nil, format: nil, model_class: nil)
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_resume_unified command reference
+    #
+    def query_resume(job_id:, target_org: nil, format: nil, api_version: nil, model_class: nil)
       flags    = {
         :"bulk-query-id" => job_id,
         :"target-org" => target_org,
         :"result-format" => format,
+        :"api-version" => api_version,
       }
       raw_output = format ? true : false
       format = format || :json

data/lib/sf_cli/sf/data/query_helper.rb

@@ -2,6 +2,7 @@ require_relative './helper_methods'
 
 module SfCli::Sf::Data
   module Query
+    # @private
     class RegularResultAdjuster # :nodoc: all
       include ::SfCli::Sf::Data::HelperMethods
 
@@ -20,6 +21,7 @@ module SfCli::Sf::Data
       end
     end
 
+    # @private
     class BulkResultAdjuster # :nodoc: all
       include ::SfCli::Sf::Data::HelperMethods
 
@@ -42,6 +44,7 @@ module SfCli::Sf::Data
       end
     end
 
+    # @private
     class RawOutputResultAdjuster # :nodoc: all
       attr_reader :result
 

data/lib/sf_cli/sf/data/resume.rb

@@ -49,12 +49,13 @@ module SfCli::Sf::Data
     end
 
     # View the status of a bulk job.
+    # @param job_id      [String]        job ID you want to resume
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
-    # *job_id* ---  job ID you want to resume<br>
+    # @return [JobInfo] job information
     #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
+    # @example
     #   # start a delete job
     #   jobinfo = sf.data.delete_bulk sobject: :TestCustomObject__c, file: 'delete.csv' # this returns immediately
     #   jobinfo.id  # => "750J4000003g1OaIAI" it's job ID
@@ -69,14 +70,15 @@ module SfCli::Sf::Data
     # - in_progress?
     # - completed?
     #
-    # To know job status more, take a look at {the bulk API developer guide}[https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/bulk_api_2_job_states.htm]
+    # To know job status more, take a look at {https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/bulk_api_2_job_states.htm the bulk API developer guide}
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_resume_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_resume_unified command reference
     #
-    def resume(job_id:, target_org: nil)
+    def resume(job_id:, target_org: nil, api_version: nil)
       flags = {
         :"job-id"     => job_id,
         :"target-org" => target_org,
+        :"api-version" => api_version,
       }
       json = exec(__method__, flags: flags, redirection: :null_stderr)
 

data/lib/sf_cli/sf/data/search.rb

@@ -1,16 +1,16 @@
 module SfCli::Sf::Data
   module Search
-    # search objects using SOSL.
+    # Search objects using SOSL.
+    # @param sosl        [String]        SOSL
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param format      [Symbol,String] get the command's raw output. human, csv, json can be available.
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
-    # *sosl* --- SOSL<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # *format* --- get the command's raw output. human, csv, json can be available. *NOTE*: if you choose csv, csv files are downloaded in current directory<br>
-    #
-    # ======
-    #  # example (in irb):
+    # @return [Hash] the search result
+    # @note if you choose csv as format, csv files are downloaded in current directory
     #
+    # @example
+    #  (in irb):
     #  > sf.data.search "FIND {TIM OR YOUNG OR OIL} IN Name Fields"
     #  =>
     #  {"Lead"=>["00Q5j00000WgEuDEAV"],
@@ -24,13 +24,14 @@ module SfCli::Sf::Data
     #     "0065j00001XHJLJAA5"],
     #   "User"=>["0055j00000CcL2bAAF", "0055j00000CcL1YAAV"]}
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_search_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_search_unified command reference
     #
-    def search(sosl, target_org: nil, format: nil)
+    def search(sosl, target_org: nil, format: nil, api_version: nil)
       flags = {
         :"query"         => %|"#{sosl}"|,
         :"target-org"    => target_org,
         :"result-format" => format,
+        :"api-version" => api_version,
       }
       raw_output = format ? true : false
       format = format&.to_sym || :json

data/lib/sf_cli/sf/data/update_record.rb

@@ -1,33 +1,32 @@
 module SfCli::Sf::Data
   module UpdateRecord
 
-    # update a object record.
-    #
-    # *object_type* --- \Object Type (ex. Account)<br>
-    #
-    # *record_id* --- id of the object<br>
-    #
-    # *where* --- field values that is used to identify a record<br>
-    #
-    # *values* --- field values for update<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ==== examples
+    # Update a object record.
+    # @param object_type [Symbol,String] object type(ex. Account)
+    # @param record_id   [String]        ID of the object
+    # @param where       [Hash]          field values to identify a record
+    # @param values      [Hash]          field values for update
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
+    # 
+    # @return [String] ID of the record updated 
+    # 
+    # @example
     #   sf.data.update_record :Account, record_id: 'xxxxxxx', values: {Name: 'New Account Name'}
     #   sf.data.update_record :Hoge__c, where: {Name: 'Jonny B.Good', Country: 'USA'}, values: {Phone: 'xxxxx', bar: 2000}
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_update_record_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_update_record_unified command reference
     #
-    def update_record(object_type, record_id: nil, where: nil, values: nil, target_org: nil)
+    def update_record(object_type, record_id: nil, where: nil, values: nil, target_org: nil, api_version: nil)
       where_conditions  = field_value_pairs(where)
       field_values      = field_value_pairs(values)
       flags = {
-        :"sobject"    => object_type,
-        :"record-id"  => record_id,
-        :"where"      => (where_conditions.nil? ? nil : %|"#{where_conditions}"|),
-        :"values"     => (field_values.nil? ? nil : %|"#{field_values}"|),
-        :"target-org" => target_org,
+        :"sobject"     => object_type,
+        :"record-id"   => record_id,
+        :"where"       => (where_conditions.nil? ? nil : %|"#{where_conditions}"|),
+        :"values"      => (field_values.nil? ? nil : %|"#{field_values}"|),
+        :"target-org"  => target_org,
+        :"api-version" => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
       json = exec(action, flags: flags, redirection: :null_stderr)

data/lib/sf_cli/sf/data/upsert_bulk.rb

@@ -2,19 +2,19 @@ require_relative './bulk_result_v2'
 
 module SfCli::Sf::Data
   module UpsertBulk
-    # update records using Bulk API 2.0
+    # Update records using Bulk API 2.0
+    # @param file [String,#read]
+    #   (1)path of a CSV file, which is written record IDs to delete.
+    #   (2) IO-like object, which has #read method
+    # @param sobject     [Symbol,String] object type(ex. Account)
+    # @param external_id [String]        name of the external ID field.Otherwise it must be Id
+    # @param wait        [Integer]       max minutes to wait for the job complete the task
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
-    # *file* --- a \CSV file for update records<br>
+    # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
     #
-    # *sobject* --- \Object Type (ex. Account)<br>
-    #
-    # *external_id* --- Name of the external ID field, or the Id field<br>
-    #
-    # *timeout* --- max minutes to wait for the job complete the task.<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
+    # @example
     #   # start a upsert job
     #   jobinfo = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv' # this returns immediately
     #   jobinfo.id  # => "750J4000003g1OaIAI" it's job ID
@@ -23,17 +23,29 @@ module SfCli::Sf::Data
     #   sf.data.upsert_resume job_id: jobinfo.id
     #
     #   # Or, you can wait for the job completion with one try.
-    #   result = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', timeout: 5  # wait within 5 minutes
+    #   result = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', wait: 5  # wait within 5 minutes
+    #
+    #   # you can use IO-like object, which has #read, to `file` keyword:
+    #   require 'stringio'
+    #   csv = StringIO.new <<CSV
+    #     Id,Name
+    #     001J400000Ki61uIAB,John Smith
+    #     001J400000Ki3WRIAZ,Foo Baz Bar
+    #   CSV
+    #   jobinfo = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: csv
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_upsert_bulk_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_upsert_bulk_unified command reference
     #
-    def upsert_bulk(file:, sobject:, external_id:, timeout: nil, target_org: nil)
+    def upsert_bulk(file:, sobject:, external_id:, wait: nil, target_org: nil, api_version: nil)
+      _file = create_tmpfile_by_io(file)
+      path  = _file&.path || file
       flags = {
-        :"file"    => file,
-        :"sobject"    => sobject,
-        :"external-id"  => external_id,
-        :"wait"      => timeout,
-        :"target-org" => target_org,
+        :"file"        => path,
+        :"sobject"     => sobject,
+        :"external-id" => external_id,
+        :"wait"        => wait,
+        :"target-org"  => target_org,
+        :"api-version"  => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
       json = exec(action, flags: flags, redirection: :null_stderr)
@@ -45,6 +57,8 @@ module SfCli::Sf::Data
         job_info: job_info,
         records:  ::SfCli::Sf::Data::BulkRecordsV2.new(**json['result']['records'])
       )
+    ensure
+      _file&.close!
     end
   end
 end

data/lib/sf_cli/sf/data/upsert_resume.rb

@@ -2,35 +2,34 @@ require_relative './bulk_result_v2'
 
 module SfCli::Sf::Data
   module UpsertResume
-    # resume a bulk upsert job you previously started with Bulk API 2.0 and return a bulk result object.
+    # Resume a bulk upsert job you previously started with Bulk API 2.0 and return a bulk result object.
+    # @param job_id      [String]        job ID you want to resume
+    # @param wait        [Integer]       max minutes to wait for the job complete the task
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
-    # *job_id* ---  job ID you want to resume<br>
+    # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
     #
-    # *timeout* --- max minutes to wait for the job complete the task.<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
+    # @example
     #   # start a upsert job
     #   jobinfo = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv' # this returns immediately
     #   jobinfo.id  # => "750J4000003g1OaIAI" it's job ID
     #
     #   # the job has already started asynchronously.
     #   # So you should check its progress.
-    #   # if you want to wait for the job complete the task, try 'timeout' option.
+    #   # if you want to wait for the job complete the task, try 'wait' option.
     #   result = sf.data.upsert_resume job_id: jobinfo.id
     #
     #   puts 'yey!' if result.job_info.completed? # the job has completed
     #
-    # To know more about a job result, take a look at SfCli::Sf::Data module
-    #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_upsert_resume_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_upsert_resume_unified command reference
     #
-    def upsert_resume(job_id:, timeout: nil, target_org: nil)
+    def upsert_resume(job_id:, wait: nil, target_org: nil, api_version: nil)
       flags = {
         :"job-id"     => job_id,
-        :"wait"       => timeout,
+        :"wait"       => wait,
         :"target-org" => target_org,
+        :"api-version"  => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
       json = exec(action, flags: flags, redirection: :null_stderr)

data/lib/sf_cli/sf/main.rb

@@ -3,14 +3,15 @@ require 'json'
 
 module SfCli
   module Sf
-    # ==== description
-    # The entry class of sf command. It is returned by sf method.
+
+    # The entry class of sf command. It is returned by the sf method.
     # With including Singleton module, the instance of this class is guaranteed as singleton.
     #
-    # ==== examples
+    # @example
     #   sf             # returns a instance of SfCli::Sf
     #   sf.org.display # you can follow the similar syntax to the original command by using method chain.
     #
+    # @private :nodoc: just for developers
     class Main
       include Singleton
 
@@ -21,6 +22,9 @@ module SfCli
         attr_reader category.downcase.to_sym
       end
 
+      # Generate each sub command object such as org, data and sobject
+      # so that it can chain like `sf.org.display`.
+      #
       def initialize
         OPERATION_CATEGORIES.each do |category|
           instance_variable_set(:"@#{category.downcase}", Object.const_get(%|::SfCli::Sf::#{category}::Core|).new)

data/lib/sf_cli/sf/model/base_methods.rb

@@ -1,6 +1,7 @@
 module SfCli
   module Sf
     module Model
+      # @private :nodoc: just for developers
       module BaseMethods
         def self.included(c)
           c.extend ClassMethods

data/lib/sf_cli/sf/model/class_definition.rb

@@ -5,6 +5,7 @@ require_relative './query_methods'
 module SfCli
   module Sf
     module Model
+      # @private :nodoc: just for developers
       class ClassDefinition
         attr_reader :schema
 

data/lib/sf_cli/sf/model/dml_methods.rb

@@ -1,6 +1,7 @@
 module SfCli
   module Sf
     module Model
+      # @private :nodoc: just for developers
       module DmlMethods
         def self.included(c)
           c.extend ClassMethods

data/lib/sf_cli/sf/model/generator.rb

@@ -3,8 +3,9 @@ require_relative './class_definition'
 module SfCli
   module Sf
     module Model
+      # @private :nodoc: just for developers
       class Generator
-        attr_reader :sf_sobject, :connection
+        attr_reader :connection
 
         def initialize(connection)
           @connection = connection

data/lib/sf_cli/sf/model/query_condition.rb

@@ -4,6 +4,7 @@ module SfCli
   module Sf
     module Model
       module QueryMethods
+        # @private :nodoc: just for developers
         class QueryCondition
           attr_reader :connection, :object_name, :all_field_names, :fields, :conditions, :limit_num, :row_order
 

data/lib/sf_cli/sf/model/query_methods.rb

@@ -3,6 +3,7 @@ require_relative './query_condition'
 module SfCli
   module Sf
     module Model
+      # @private :nodoc: just for developers
       module QueryMethods
         def self.included(c)
           c.extend ClassMethods
@@ -25,6 +26,11 @@ module SfCli
             connection.find(name.to_sym, id, Object.const_get(name.to_sym))
           end
 
+          def find_by(*find_condition)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.where(*find_condition).take
+          end
+
           def limit(num)
             qc = QueryCondition.new(connection, self.name, self.field_names)
             qc.limit(num)

data/lib/sf_cli/sf/model/sf_command_connection.rb

@@ -5,9 +5,18 @@ require_relative '../org/core'
 module SfCli
   module Sf
     module Model
+      #
+      # Connection object to access Salesforce based on Sf command
+      #
       class SfCommandConnection
-        attr_reader :sf_data, :sf_org, :sf_sobject, :target_org, :instance_url
+        attr_reader :target_org, :instance_url
 
+        # @private :nodoc: just for developers
+        attr_reader :sf_data, :sf_org, :sf_sobject
+
+        # @param target_org   [Symbol,String] an alias of paticular org, or username can be used
+        # @param instance_url [String]        URL of the instance that the org lives on.
+        #
         def initialize(target_org: nil, instance_url: nil)
           @sf_org = ::SfCli::Sf::Org::Core.new
           @sf_data = ::SfCli::Sf::Data::Core.new
@@ -24,10 +33,20 @@ module SfCli
           end
         end
 
+        # Sf command style query interface for Model module
+        #
+        # For query details, see {SfCli::Sf::Data::Query sf data query}
+        #
+        def exec_query(soql, format: nil, bulk: false, wait: nil, model_class: nil)
+          sf_data.query(soql, target_org: target_org, format: format, bulk: bulk, wait: wait, model_class: model_class)
+        end
+
+        # @private :nodoc: just for developers
         def find(object_type, id, klass)
           sf_data.get_record object_type, record_id: id, target_org: target_org, model_class: klass
         end
 
+        # @private :nodoc: just for developers
         def create(object_type, values, klass = nil)
           id = sf_data.create_record object_type, values: values, target_org: target_org
           return id if klass.nil?
@@ -35,22 +54,22 @@ module SfCli
           find(object_type, id, klass)
         end
 
+        # @private :nodoc: just for developers
         def update(object_type, id, values)
           sf_data.update_record object_type, record_id: id, where: nil, values: values, target_org: target_org
         end
 
+        # @private :nodoc: just for developers
         def delete(object_type, id)
           sf_data.delete_record object_type, record_id: id, where: nil, target_org: target_org
         end
 
+        # @private :nodoc: just for developers
         def query(soql, klass)
           sf_data.query soql, target_org: target_org, model_class: klass
         end
 
-        def exec_query(soql, format: nil, bulk: false, timeout: nil, model_class: nil)
-          sf_data.query(soql, target_org: target_org, format: format, bulk: bulk, timeout: timeout, model_class: model_class)
-        end
-
+        # @private :nodoc: just for developers
         def describe(object_type)
           sf_sobject.describe(object_type, target_org: target_org)
         end

data/lib/sf_cli/sf/model.rb

@@ -3,20 +3,22 @@ require_relative 'model/generator'
 module SfCli
   module Sf
     #
-    # ==== description
-    # The module for \Object \Model definition and generation
-    #
-    # see the section {"Object Model support"}[link://files/README_rdoc.html#label-Object+Model+support+-28experimental-2C+since+0.0.4-29] in README.
+    # The module for object model definition and generation
     #
     module Model
+      # The connection object to access Salesforce
       def self.connection
         @@connection
       end
 
+      # set the connection
       def self.set_connection(conn)
         @@connection = conn
       end
 
+      # generate object models
+      # @param object_names [Array] a list of object name
+      #
       def self.generate(object_names)
         generator = Generator.new(connection)
 

data/lib/sf_cli/sf/org/core.rb

@@ -5,13 +5,13 @@ require_relative './list'
 
 module SfCli
   module Sf
+    #
+    # Org Commands
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm command reference
+    #
     module Org
-      #
-      # ==== description
-      # The class representing *sf* *org*.
-      #
-      # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm
-      #
+      # @private :nodoc: just for developers
       class Core
         include ::SfCli::Sf::Core::Base
         include Login

data/lib/sf_cli/sf/org/display.rb

@@ -3,13 +3,15 @@ module SfCli::Sf::Org
     ConnectionInfo = Struct.new(:id, :access_token, :alias, :instance_url, :user_name, :api_version, :status)
 
     #
-    # returns the org's connection information. (equivalent to *sf* *org* *display*)
+    # Returns the org's connection information
+    # @param target_org [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]      override the api version used for api requests made by this command
     #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
-    #  # example (in irb):
+    # @note this function returns the org information including security sensitive things such as access token, username and so on.
+    # @return [ConnectionInfo] the org's connection information
     #
+    # @example
+    #  (in irb):
     #  > sf.org.display
     #  =>
     #  #<struct SfCli::Sf::Org::Display::ConnectionInfo
@@ -21,10 +23,10 @@ module SfCli::Sf::Org
     #   api_version="61.0",
     #   status="Connected">
     #
-    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_display_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_display_unified command reference
     #
-    def display(target_org: nil)
-      flags    = {:"target-org" => target_org}
+    def display(target_org: nil, api_version: nil)
+      flags    = {:"target-org" => target_org, :"api-version" => api_version}
       json = exec(__method__, flags: flags, redirection: :null_stderr)
 
       ConnectionInfo.new(