sf_cli 0.0.7.beta2 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe11b6577f9c950bc7ebe9a602392f843462d2121e4b53bad470ae5fc88d70a
-  data.tar.gz: 7b8be5a7d4d7fe214968a41ed334df490c59fec0c1308c922b98c53d7e6d5bc4
+  metadata.gz: fa13644d7e9281efbbb57516775a5edd9b69fb7ff9fbc260332a54d0afebc227
+  data.tar.gz: feb9c574b8d0681fbe9ba43572cb9b7725558fc20f69eebbbd3a2b3734aa60b9
 SHA512:
-  metadata.gz: e5dd28989b46ed7044bf01f872197f29a591b005e0d150dd526c97d2c5fdf1e543a7112d3ccdff5867f967800f1673f2073a0585bb06223d8b541f8ac2ae2873
-  data.tar.gz: 25a31b68eed96337d806721c42c24ad1452728c00f2db8577c93f211a2147fab61c9a8b692978f67df8b690ea8aa94bbf21fea5200e8b6ac4c1c2ad71062474b
+  metadata.gz: ade35b3acd147ac13367c6d681c31028fef4b661ab2a97101e21b170221231c81c8d76a13c9e6f2688b085ae4889c8872ced4dd72b4f1d21cc8ac465cde78096
+  data.tar.gz: f7fb45fc3c50d2ab557f82d28b74119465fddad2c5930710aadbe0b44c19da49b8ac76c6815f0e18132d0f49d1590ed456ed42069ca07385e75db3d630f0812e

data/README.rdoc

@@ -5,137 +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
-  $ gem install sf_cli
-
-==== Bundler
-in Gemfile:
-  gem 'sf_cli'
-
-then,
-  $ bundle install
-
-== Examples
-=== Since 0.0.4
+Rubygem::
+  the simplest way:
+    $ gem install sf_cli
+Bundler::
+  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 records
-  sf.data.query 'SELECT Id, Name FROM Account LIMIT 1' # => [{Id: "abc", Name: "account name"}]
-
-  # generate a Salesforce DX project
-  sf.project.generate 'MyProject'
-
-=== Before 0.0.3
-  require 'sf_cli/sf'
+Get Salesforce Object schema 
+  sf.sobject.describe :Account
 
-  sf = SfCli::Sf.new
+Get a record
+  sf.data.get_record :Account, record_id: 'xxxxxxx'
+  sf.data.get_record :Account, where: {Name: 'Jonny B.Good', Country: 'USA'}
 
-  # login to org
-  sf.org.login_web
+Execute SOQL
+  sf.data.query "SELECT Id, Name FROM Account LIMIT 1" # => [{Id: "abc", Name: "account name"}]
 
-  # get Account records
-  sf.data.query 'SELECT Id, Name FROM Account LIMIT 3' # => returns an array containing 3 records
-  
-  # generate a Salesforce DX project
-  sf.project.generate 'MyProject'
+Create a record
+  sf.data.create_record :TheCustomObject__c, values: {Name: "John Smith", Age: 33}
 
-== \Object Model support (experimental, since 0.0.4)
-=== generate Models
-  require 'sf_cli/sf/model'
-  require 'sf_cli/sf/model/sf_command_connection'
+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}
 
-  # first, you must prepare the connection
-  conn = SfCli::Sf::Model::SfCommandConnection.new target_org: your_org, instance_url: your_org_url
+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'}
 
-  # then set it to Model module
-  SfCli::Sf::Model.set_connection conn
+Using Bulk API 2.0
+  sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', timeout: 5  # waiting for 5 minutes at maximum
 
-  # generates some model classes (for example, Account and Contact)
-  SfCli::Sf::Model.generate %w[Account Contact]
-=== apply to sf command
+Run Apex
+  sf.apex.run file: 'path/to/file'
+  sf.apex.run file: StringIO.new("System.debug('Hello World')")
+== Object Model Support (experimental)
+With sf command:
   rows = sf.data.query "SELECT Id, Name FROM Contact WHERE Name = 'Akin Kristen'", model_class: Contact
-
-  # the array object contains Contact object instances
-  rows.size  # 1
-  rows.first # <Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen">
+  rows.first      # <Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen">
   rows.first.Name # Akin Kristen
-
-=== using models Independently
-==== initialize and save a record
-  c = Contact.new(:Name => "John Smith")
-  c.Name # "John Smith"
-  c.save
-
-==== find and update a record
-  # find by record ID and update
-  c2 = Contact.find(c.id)
-  c2.Name = "Johnny Smith"
-  c2.save # update
-
-==== delete a record
-  c2 = Contact.find(c.id)
-  c2.delete
-
-==== query and get a record
+Doing the same thing independently:
   contact = Contact.select(:Id, :Name).where(Name: 'Akin Kristen').take
-  contact # => #<Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen">
   contact.Name # Akin Kristen
-
-  # these 2 example are the same meaning
-  Contact.select(Name).where(Name: 'John Smith', LastModifiedDate: :Yesterday).take
-  Contact.select(Name).where(Name: 'John Smith').where(LastModifiedDate: :Yesterday).take
-
-==== query and get records
-  contacts = Contact.select(:Id, :Name).where(LastModifiedDate: :Yesterday).all # get all records that is modified yesterday
-
-==== child-parent relationship
-  contact = Contact.select(:Id, :Name, "Account.Name").where(Name: 'Akin Kristen').take
-  contact # <Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen", @Account= #<Account @Name="Aethna Home Products">>
-  contact.Account.Name # Aethna Home Products
-
-==== parent-children relationship
-  account = Account.select(:Id, :Name, "(SELECT Name FROM Contacts)").take
-  account # <Account @Contacts=[#<Contact @Name="Akin Kristen">], @Id="0015j00001dsDuhAAE", @Name="Aethna Home Products">
-  account.Name             # Aethna Home Products
-  rows.Contacts            # [#<Contact @Name="Akin Kristen">]
-  rows.Contacts.first.Name # Akin Kristen
-
-==== get all fields in a record
-  # just by not using 'select' method
-  contact = Contact.find(record_id) # <Contact @Id="...", @Name="...", other fields...>
-
-==== time keywords such as 'yesterday' or 'LAST_N_DAYS:N' with symbol style
-  Contact.select(:Name).where(LastModifiedDate: :Yesterday).take       # "SELECT Id, Name FROM Contact WHERE LastModifiedDate = Yesterday"
-  Contact.select(:Name).where(LastModifiedDate: :"LAST_N_DAYS:5").take # "SELECT Id, Name FROM Contact WHERE LastModifiedDate = LAST_N_DAYS:5"
-
-==== array for 'IN' keyword
-  Contact.select(:Name).where(Name: ['Jonny Good', 'John Smith']).all # same as "SELECT Name FROM Contact WHERE Name IN ('Jonny Good', 'John Smith')"
-
-==== using partial soql directly
-  Contact.select("Id, Name").where("LastModifiedDate = LAST_N_DAYS:5").all
-
-==== ternary style
-  Contact.select(:Id, :Name).where(:LastModifiedDate, :>=, :"LAST_N_DAYS:5").all # SELECT Id, Name FROM Contact WHERE LastModifiedDate >= LAST_N_DAYS:5
-  Account.select(:Id, :Name).where(:Name, :LIKE, "%OIL%").all                    # SELECT Id, Name FROM Account WHERE Name LIKE '%OIL%'
-
-==== get schema
-  schema = Account.describe
-  schema.name # Account
-  schema.field_names # [Id, Name, ....]
-
-== Documents
-The following steps generate *doc* directory, which all documents are generated in.
-  $ git clone https://github.com/tmkw/sf_cli.git
-  $ cd sf_cli
-  $ bundle install
-  $ bundle exec rake rdoc
-
-*Or*, you can read the same documents online at {rubygems.org}[https://rubygems.org/gems/sf_cli]

data/lib/sf_cli/console/commands.rb

@@ -0,0 +1,36 @@
+require 'sf_cli'
+require 'sf_cli/sf/model'
+require 'sf_cli/sf/model/sf_command_connection'
+require 'stringio'
+
+module SfCli
+  module Console
+    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)
+        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

@@ -0,0 +1,18 @@
+require_relative '../core/base'
+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
+      # @private :nodoc: just for developers
+      class Core
+        include ::SfCli::Sf::Core::Base
+        include Run
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+require 'tempfile'
+require 'stringio'
+
+module SfCli::Sf::Apex
+  module Run
+    #
+    # 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
+    #
+    # @param target_org [Symbol,String]
+    #   an alias of paticular org, or username can be used.
+    #
+    # @param file [String,StringIO]
+    #   (1) path to a local file that contains Apex code. 
+    #   (2) StringIO object
+    #
+    # @return [ApexResult] Apex execution result.
+    #
+    # @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
+    #
+    # @example StringIO is usable instead of file path
+    #   require 'stringio'
+    #
+    #   pseudo_file = StringIO.new <<~EOS
+    #     Account acc = [SELECT Id, Name FROM Account Limit 1];
+    #     System.debug(acc.Name);
+    #   EOS
+    #
+    #   sf.apex.run target_org: :dev, file: pseudo_file
+    #
+    # @example Interactive Mode
+    #   irb(main:) > sf.apex.run target_org: :dev
+    #
+    #   Account acc = [SELECT Id, Name FROM Account LIMIT 1];
+    #   System.debug(acc.Name);
+    #   <press Ctrl-D>
+    #
+    #   =>
+    #   #<SfCli::Sf::Apex::Run::ApexResult:0x00007437b4e13218
+    #     @column=-1,
+    #     @compile_problem="",
+    #     @compiled=true,
+    #     @exception_message="",
+    #     @exception_stack_trace="",
+    #     @line=-1,
+    #     @logs=
+    #      ["61.0 APEX_CODE,DEBUG;APEX_PROFILING,INFO",
+    #       "Execute Anonymous: Account acc = [SELECT Id, Name FROM Account LIMIT 1];",
+    #       "Execute Anonymous: System.debug(acc.Name);",
+    #      ....]
+    #
+    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}
+
+      json = exec(__method__, flags: flags, redirection: :null_stderr)
+      ApexResult.new(json['result'])
+    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!
+    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!
+    end
+
+    class ApexResult
+      attr_reader :success, :compiled, :compile_problem, :exception_message, :exception_stack_trace, :line, :column, :logs
+
+      def initialize(attributes)
+        @success = attributes['success']
+        @compiled = attributes['compiled']
+        @compile_problem = attributes['compileProblem']
+        @exception_message = attributes['exceptionMessage']
+        @exception_stack_trace = attributes['exceptionStackTrace']
+        @line = attributes['line']
+        @column = attributes['column']
+        @logs = attributes['logs'].chomp.split("\n")
+      end
+    end
+  end
+end

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

@@ -2,6 +2,7 @@ require 'json'
 
 module SfCli
   module Sf
+    # @private :nodoc: just for developers
     module Core
       module Base
         attr_reader :varbose

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,19 +1,17 @@
 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
     #
-    # *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)
       field_values = field_value_pairs(values)
       flags = {

data/lib/sf_cli/sf/data/delete_bulk.rb

@@ -2,17 +2,15 @@ require_relative './bulk_result_v2'
 
 module SfCli::Sf::Data
   module DeleteBulk
-    # delete records using Bulk API 2.0
+    # Delete records using Bulk API 2.0
+    # @param file       [String]         path of a CSV file, which is written record IDs to delete
+    # @param sobject    [Symbol, String] object type (ex. Account)
+    # @param timeout    [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
     #
-    # *file* --- a CSV file, which is written record IDs to delete<br>
+    # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
     #
-    # *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>
-    #
-    # ======
+    # @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
@@ -23,7 +21,8 @@ module SfCli::Sf::Data
     #   # 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
     #
-    # 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]
+    # @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
+    #
     #
     def delete_bulk(file:, sobject:, timeout: nil, target_org: nil)
       flags = {

data/lib/sf_cli/sf/data/delete_record.rb

@@ -1,20 +1,19 @@
 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
     #
-    # *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)
       where_conditions = field_value_pairs(where)

data/lib/sf_cli/sf/data/delete_resume.rb

@@ -2,15 +2,15 @@ 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 timeout    [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>
     #
-    # *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
@@ -22,9 +22,7 @@ module SfCli::Sf::Data
     #
     #   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)
       flags = {

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'