sf_cli 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98f07645a79ccfa6a8f8bbac048a4da5aae6f21bf294445a0888f861d91b8f27
-  data.tar.gz: a608a4eeb21ff2fd065cac874d6834e1a6c8aec83f9a40ada0f73917e4029ffb
+  metadata.gz: 64f11658c0b90ce494643c625b80f6826ec42597723315fd52690aefc6d97c8c
+  data.tar.gz: e0318c64547346287a378766a3441249cf2906539693bc982e486d6bca4b7836
 SHA512:
-  metadata.gz: 9f5949bdba034feb1a7265a79fa9cd41c9e6f9d1402e4cf173fc585b0ab44d904570591382066633f5258f55503f0503410d648fb3700856029471678090efed
-  data.tar.gz: 32a39625a575b1f9e465d9090c1e63a0ec8ee8ed605c4f5c3104b3866121a931780cf7c2f82200ab84ca5924ff798790cf116cf9580280ab1e1e6a26458d1ef4
+  metadata.gz: 57c9f53f54298b2bcb7e566bceb48704012154c6a160e08402eb48d998cd2dc361d1f021bedb7866fade1beecfddab30affb0dcffa812cdfb20b7b6417c69df5
+  data.tar.gz: 875b18097589d7f4df8a212a078bbaf98e35de738782a8d4522f2a198861f280457ed23828838a77c645d170305423985edc16ee4e23ef77bd0afaeb8f0986af

data/{rdoc/README.rdoc → README.rdoc}

@@ -5,75 +5,61 @@ This is a class library for introducing {Salesforce CLI}[https://developer.sales
 It is designed to be similar usability to the original command.<br>
 Currently only *sf* command is the target of development.
 
+[rubygems]          https://rubygems.org/gems/sf_cli
+[official document] https://tmkw.github.io/sf_cli/
+
 == prerequisite
-Salesforce CLI must be installed.<br>
+{Salesforce CLI}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_top.htm] must be installed.<br>
 As of as of September in 2024, ver.2.56.7 is the development target.
 
 == install
 Rubygem::
-    the simplest way:
-        $ gem install sf_cli
+  the simplest way:
+    $ gem install sf_cli
 Bundler::
-    in Gemfile:
-        gem 'sf_cli'
-    then,
-        $ bundle install
-== Documents
-Class Library Reference::
-    {Online document}[https://www.rubydoc.info/gems/sf_cli/0.0.7] at rubygems.org
-
-    Or,
-    Generate locally:
-      $ git clone https://github.com/tmkw/sf_cli.git
-      $ cd sf_cli
-      $ bundle install
-      $ bundle exec rake rdoc
-    *As* *of* *0.0.7*, *this* *may* *be* *better* *to* *know* *what* *it* *is* *exactly*.
-Salesforce CLI and Sf command::
-    1. {Salesforce CLI reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_top.htm]
-    2. {sf command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_unified.htm]
-
-== Short Examples
+  in Gemfile:
+    gem 'sf_cli'
+  then,
+    $ bundle install
+== Usage
+Load module
   require 'sf_cli'
 
-  # login to org
+Login to org
   sf.org.login_web
 
-  # get salesforce object schema 
+Get Salesforce Object schema 
   sf.sobject.describe :Account
 
-  # get a record
+Get a record
   sf.data.get_record :Account, record_id: 'xxxxxxx'
   sf.data.get_record :Account, where: {Name: 'Jonny B.Good', Country: 'USA'}
 
-  # execute soql
+Execute SOQL
   sf.data.query "SELECT Id, Name FROM Account LIMIT 1" # => [{Id: "abc", Name: "account name"}]
 
-  # create a record
+Create a record
   sf.data.create_record :TheCustomObject__c, values: {Name: "John Smith", Age: 33}
 
-  # update a record
+Update a record
   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}
 
-  # delete a record
+Delete a record
   sf.data.delete_record :Hoge__c, record_id: 'xxxxxxx'
   sf.data.delete_record :Hoge__c, where: {Name: 'Jonny B.Good', Country: 'USA'}
 
-  # using Bulk API 2.0
-  sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', timeout: 5  # waiting for 5 minutes at maximum
+Using Bulk API 2.0
+  sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', wait: 5  # waiting for 5 minutes at maximum
 
-  # run Apex
+Run Apex
   sf.apex.run file: 'path/to/file'
   sf.apex.run file: StringIO.new("System.debug('Hello World')")
-== \Object Model Support
-As of now, there is experimental support for object model in Salesforce.
-=== Short examples
-===== With sf command:
+== Object Model Support
+With sf command:
   rows = sf.data.query "SELECT Id, Name FROM Contact WHERE Name = 'Akin Kristen'", model_class: Contact
   rows.first      # <Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen">
   rows.first.Name # Akin Kristen
-===== Doing the same thing with model independently
+Doing the same thing independently:
   contact = Contact.select(:Id, :Name).where(Name: 'Akin Kristen').take
   contact.Name # Akin Kristen
-For more details, take a look at {the object model section}[link://files/rdoc/ObjectModel_rdoc.html]

data/lib/sf_cli/console/commands.rb

@@ -0,0 +1,52 @@
+require 'sf_cli'
+require 'sf_cli/sf/model'
+require 'sf_cli/sf/model/sf_command_connection'
+require 'stringio'
+
+module SfCli
+  # @private :nodoc: just for developers
+  module Console
+    #
+    # Developer Console commands
+    # @example
+    #  $ bundle exec rake irb[your_target_org]
+    #  irb(main):001> gen :Account, :Contact  # generate Account and Contact class
+    #  => [:Account, :Contact]
+    #
+    #  irb(main):002> Account.describe.label
+    #  => "Account"
+    #
+    #  irb(main):003> apex "System.debug('abc');" # execute Apex code
+    #  => returns the result
+    #
+    module Commands
+      def use(_target_org)
+        target_org = _target_org.to_sym == :default ? nil : _target_org
+        org_info = sf.org.display target_org: target_org
+        conn = SfCli::Sf::Model::SfCommandConnection.new target_org: target_org, instance_url: org_info.instance_url
+        SfCli::Sf::Model.set_connection conn
+      end
+
+      def generate(*object_types)
+        SfCli::Sf::Model.generate object_types
+      end
+
+      def connection
+        SfCli::Sf::Model.connection
+      end
+
+      def target_org
+        connection.target_org
+      end
+
+      def apex(apex_code = nil)
+        return sf.apex.run target_org: target_org if apex_code.nil?
+
+        sf.apex.run target_org: target_org, file: StringIO.new(apex_code)
+      end
+
+      alias :gen  :generate
+      alias :conn :connection
+    end
+  end
+end

data/lib/sf_cli/console.rb

@@ -0,0 +1,5 @@
+require 'sf_cli/console/commands'
+
+include SfCli::Console::Commands
+
+use ARGV[0]

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

@@ -3,13 +3,12 @@ require_relative './run'
 
 module SfCli
   module Sf
+    # Apex Commands
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_apex_commands_unified.htm command reference
+    #
     module Apex
-      #
-      # ==== description
-      # The class representing *sf* *apex*.
-      #
-      # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_apex_commands_unified.htm
-      #
+      # @private :nodoc: just for developers
       class Core
         include ::SfCli::Sf::Core::Base
         include Run

data/lib/sf_cli/sf/apex/run.rb

@@ -1,22 +1,28 @@
 require 'tempfile'
-require 'stringio'
 
 module SfCli::Sf::Apex
   module Run
     #
-    # run apex code and returns its result
+    # Run apex code and returns its result.
+    # If you don't specify the script file, it starts interactive mode.
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_apex_commands_unified.htm#cli_reference_apex_run_unified CLI reference
     #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
+    # @param target_org [Symbol,String]
+    #   an alias of paticular org, or username can be used.
+    # @param file [String,#read]
+    #   (1) path to a local file that contains Apex code. 
+    #   (2) object that has #read method
+    # @param api_version [Numeric]
+    #   override the api version used for api requests made by this command
     #
-    # *file* --- (1) path to a local file that contains \Apex code. (2) StringIO object
+    # @return [ApexResult] Apex execution result.
     #
-    # == Examples
-    # Execute apex code in a file
+    # @example Execute apex code in a file
     #   result = sf.apex.run file: "path/to/apex"
     #   result.success # true if the execution succeeds
     #   result.logs    # execution log
     #
-    # StringIO is usable instead of file path
+    # @example StringIO is usable instead of file path
     #   require 'stringio'
     #
     #   pseudo_file = StringIO.new <<~EOS
@@ -26,9 +32,7 @@ module SfCli::Sf::Apex
     #
     #   sf.apex.run target_org: :dev, file: pseudo_file
     #
-    # == Interactive Mode
-    #
-    # If you don't specify *file* argument, it starts interactive mode that may be helpful in IRB environment.
+    # @example Interactive Mode
     #   irb(main:) > sf.apex.run target_org: :dev
     #
     #   Account acc = [SELECT Id, Name FROM Account LIMIT 1];
@@ -48,48 +52,34 @@ module SfCli::Sf::Apex
     #       "Execute Anonymous: Account acc = [SELECT Id, Name FROM Account LIMIT 1];",
     #       "Execute Anonymous: System.debug(acc.Name);",
     #      ....]
-    # 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_apex_commands_unified.htm#cli_reference_apex_run_unified]
     #
-    def run(target_org: nil, file: nil)
-      return run_interactive(target_org) if file.nil?
-      return run_by_io(target_org, file) if file.is_a? StringIO
-
-      return unless file.is_a? String
-
-      flags = {:"target-org" => target_org, :"file" => file}
+    def run(target_org: nil, file: nil, api_version: nil)
+      _file = crate_tmpfile(file)
+      path = _file&.path || file
+      flags = {:"target-org" => target_org, :"file" => path, :"api-version" => api_version}
 
       json = exec(__method__, flags: flags, redirection: :null_stderr)
       ApexResult.new(json['result'])
+    ensure
+      _file&.close!
     end
 
     private
 
-    def run_by_io(target_org, io)
-      file = Tempfile.open(%w[sf apex]){|f| f.write(io.read); f}
-
-      flags = {:"target-org" => target_org, :"file" => file.path}
-      json = exec(:run, flags: flags, redirection: :null_stderr)
-      ApexResult.new(json['result'])
-    ensure
-      file&.close!
+    def crate_tmpfile(path_or_io)
+      return create_tmpfile_by_user_input if path_or_io.nil?
+      create_tmpfile_by_io(path_or_io)
     end
 
-    def run_interactive(target_org)
-      file = Tempfile.open(%w[sf apex]) do |f|
-               s = $stdin.gets
-               while s
-                 f.puts(s)
-                 s = $stdin.gets
-               end
-               f
-             end
-
-      flags = {:"target-org" => target_org, :"file" => file.path}
-
-      json = exec(:run, flags: flags, redirection: :null_stderr)
-      ApexResult.new(json['result'])
-    ensure
-      file&.close!
+    def create_tmpfile_by_user_input
+      Tempfile.open(%w[sf apex]) do |f|
+        s = $stdin.gets
+        while s
+          f.puts(s)
+          s = $stdin.gets
+        end
+        f
+      end
     end
 
     class ApexResult

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

@@ -1,7 +1,9 @@
 require 'json'
+require 'tempfile'
 
 module SfCli
   module Sf
+    # @private :nodoc: just for developers
     module Core
       module Base
         attr_reader :varbose
@@ -76,6 +78,12 @@ module SfCli
               ' 2> /dev/null'
             end
         end
+
+        def create_tmpfile_by_io(io)
+          return nil unless io.respond_to? :read
+
+          Tempfile.open(%w[sf]){|f| f.write(io.read); f}
+        end
       end
     end
   end

data/lib/sf_cli/sf/data/bulk_result_v2.rb

@@ -1,7 +1,6 @@
 module SfCli
   module Sf
     module Data
-      #
       # Bulk Job information.
       #
       # You can check the job status using the following method:
@@ -9,11 +8,11 @@ module SfCli
       # - upload_completed?
       # - in_progress?
       # - completed?
-      # ==== example:
+      # @example
       #   result = sf.data.delete_resume job_id: jobinfo.id
       #   puts 'yey!' if result.job_info.completed? # the job has completed
       #
-      # For more details, see {the guide document}[https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/bulk_api_2_job_states.htm]
+      # See Also: {https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/bulk_api_2_job_states.htm the guide document}
       #
       JobInfo = Struct.new(
         :id,

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

@@ -13,13 +13,12 @@ require_relative './search'
 
 module SfCli
   module Sf
+    #
+    # Data Command
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm command reference
+    #
     module Data
-      #
-      # ==== description
-      # The class representing *sf* *data*
-      #
-      # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm
-      #
+      # @private :nodoc: just for developers
       class Core
         include ::SfCli::Sf::Core::Base
         include Query

data/lib/sf_cli/sf/data/create_record.rb

@@ -1,25 +1,25 @@
 module SfCli::Sf::Data
   module CreateRecord
     # create a object record.
+    # @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_create_record_unified command reference
+    # @param object_type [Symbol, String] object type(ex. Account)
+    # @param values      [Hash]           field values to be assigned
+    # @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
     #
-    # *object_type* --- \Object Type (ex. Account)<br>
+    # @return [String] record ID
     #
-    # *values* --- field values to be assigned<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
+    # @example
     #   # create a TheCustomObject record with name and age
     #   sf.data.create_record :TheCustomObject__c, values: {Name: "John Smith", Age: 33}
     #
-    # 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_create_record_unified]
-    #
-    def create_record(object_type, values: {}, target_org: nil)
+    def create_record(object_type, values: {}, target_org: nil, api_version: nil)
       field_values = field_value_pairs(values)
       flags = {
         :"sobject"    => object_type,
         :"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/delete_bulk.rb

@@ -2,17 +2,18 @@ require_relative './bulk_result_v2'
 
 module SfCli::Sf::Data
   module DeleteBulk
-    # delete records using Bulk API 2.0
-    #
-    # *file* --- a CSV file, which is written record IDs to delete<br>
-    #
-    # *sobject* --- \Object Type (ex. Account)<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>
-    #
-    # ======
+    # Delete 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 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
+    #
+    # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
+    #
+    # @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
@@ -21,16 +22,29 @@ module SfCli::Sf::Data
     #   sf.data.delete_resume job_id: jobinfo.id
     #
     #   # Or, you can wait for the job completion with one try.
-    #   result = sf.data.delete_bulk sobject: :TestCustomObject__c, file: 'delete.csv', timeout: 5  # wait within 5 minutes
+    #   result = sf.data.delete_bulk sobject: :TestCustomObject__c, file: 'delete.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
+    #     001J400000Ki61uIAB
+    #     001J400000Ki3WRIAZ
+    #   CSV
+    #   jobinfo = sf.data.delete_bulk sobject: :TestCustomObject__c, file: csv
+    #
+    # @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_delete_bulk_unified command reference
     #
-    # 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_delete_bulk_unified]
     #
-    def delete_bulk(file:, sobject:, timeout: nil, target_org: nil)
+    def delete_bulk(file:, sobject:, wait: nil, target_org: nil, api_version: nil)
+      _file = create_tmpfile_by_io(file)
+      path  = _file&.path || file
       flags = {
-        :"file"    => file,
+        :"file"    => path,
         :"sobject"    => sobject,
-        :"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)
@@ -42,6 +56,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/delete_record.rb

@@ -1,28 +1,29 @@
 module SfCli::Sf::Data
   module DeleteRecord
-    # delete a object record.
+    # Delete a object record.
     #
-    # *object_type* --- \Object Type (ex. Account)<br>
+    # @param object_type [Symbol, String] Object Type (ex. Account)
+    # @param record_id   [String]         Id of the object
+    # @param where       [Hash]           conditions to identify a record
+    # @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
     #
-    # *record_id* --- id of the object<br>
+    # @return [String] ID that is deleted.
     #
-    # *where* --- hash object that is used to identify a record<br>
-    #
-    # *target_org* --- an alias of paticular org, or username can be used<br>
-    #
-    # ======
+    # @example
     #   sf.data.delete_record :Hoge__c, record_id: 'xxxxxxx'
     #   sf.data.delete_record :Hoge__c, where: {Name: 'Jonny B.Good', Country: 'USA'}
     #
-    # 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_delete_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_delete_record_unified the command reference
     #
-    def delete_record(object_type, record_id: nil, where: nil, target_org: nil)
+    def delete_record(object_type, record_id: nil, where: nil, target_org: nil, api_version: nil)
       where_conditions = field_value_pairs(where)
       flags = {
         :"sobject"    => object_type,
         :"record-id"  => record_id,
         :"where"      => (where_conditions.nil? ? nil : %|"#{where_conditions}"|),
         :"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/delete_resume.rb

@@ -2,35 +2,35 @@ require_relative './bulk_result_v2'
 
 module SfCli::Sf::Data
   module DeleteResume
-    # resume a bulk delete job you previously started with Bulk API 2.0 and return a bulk result object.
+    # Resume a bulk delete job you previously started with Bulk API 2.0 and return a bulk result object.
     #
-    # *job_id* ---  job ID you want to resume<br>
+    # @param job_id      [String]         job ID you want to resume<br>
+    # @param wait        [Integer]        max minutes to wait for the job complete the task.<br>
+    # @param target_org  [Symbol, String] an alias of paticular org, or username can be used<br>
+    # @param api_version [Numeric]        override the api version used for api requests made by this command
     #
-    # *timeout* --- max minutes to wait for the job complete the task.<br>
+    # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
     #
-    # *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
     #
     #   # 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.delete_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_delete_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_delete_resume_unified the command reference
     #
-    def delete_resume(job_id:, timeout: nil, target_org: nil)
+    def delete_resume(job_id:, wait: nil, target_org: nil, api_version: nil)
       flags = {
-        :"job-id"     => job_id,
-        :"wait"       => timeout,
-        :"target-org" => target_org,
+        :"job-id"      => job_id,
+        :"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/data/get_record.rb

@@ -1,26 +1,24 @@
 module SfCli::Sf::Data
   module GetRecord
 
-    # get a object record. (eqivalent to *sf* *data* *get* *record*)
+    # Get a object record.
+    # @param object_type [Symbol,String] object type(ex. Account)
+    # @param record_id   [String]        id of the object
+    # @param where       [Hash]          conditions to identify a record
+    # @param target_org  [Symbol,String] an alias of paticular org, not default one
+    # @param model_class [Class]         the object model class
     #
-    # *object_type* --- \Object Type (ex. Account)<br>
+    # @return [Hash,Class] if proper model class is specified, the return value is the instance of the class. Otherwise, it's a Hash object.
     #
-    # *record_id* --- id of the object<br>
-    #
-    # *where* --- hash object that is used to identify a record<br>
-    #
-    # *target_org* --- an alias of paticular org, not default one<br>
-    #
-    # *model_class* --- the object model class<br>
-    #
-    # ======
+    # @example
     #   sf.data.get_record :Account, record_id: 'xxxxxxx'
     #   sf.data.get_record :Account, where: {Name: 'Jonny B.Good', Country: 'USA'}
     #
     #   CustomObject = Struct.new(:Id, :Name)
-    #   sf.data.get_record :TheCustomObject__c, record_id: 'xxxxx', model_class: CustomObject  # returns a CustomObject instance
+    #   obj = sf.data.get_record :TheCustomObject__c, record_id: 'xxxxx', model_class: CustomObject # returns a CustomObject instance
+    #   obj.Name # Name field of the record
     #
-    # 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_get_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_get_record_unified command reference
     #
     def get_record(object_type, record_id: nil, where: nil, target_org: nil, model_class: nil)
       where_conditions = field_value_pairs(where)

data/lib/sf_cli/sf/data/helper_methods.rb

@@ -1,6 +1,7 @@
 module SfCli
   module Sf
     module Data
+      # @private
       module HelperMethods
         def prepare_record(hash) # :doc:
           hash.delete 'attributes'