@salesforce/cli 2.62.0 → 2.62.2

package/README.md

@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
 $ sf COMMAND
 running command...
 $ sf (--version|-v)
-@salesforce/cli/2.62.0 linux-x64 node-v20.17.0
+@salesforce/cli/2.62.2 linux-x64 node-v20.17.0
 $ sf --help [COMMAND]
 USAGE
   $ sf COMMAND
@@ -54,7 +54,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
 - [`sf apex run test`](#sf-apex-run-test)
 - [`sf apex tail log`](#sf-apex-tail-log)
 - [`sf api request graphql`](#sf-api-request-graphql)
-- [`sf api request rest ENDPOINT`](#sf-api-request-rest-endpoint)
+- [`sf api request rest [URL]`](#sf-api-request-rest-url)
 - [`sf autocomplete [SHELL]`](#sf-autocomplete-shell)
 - [`sf commands`](#sf-commands)
 - [`sf config get`](#sf-config-get)
@@ -903,31 +903,33 @@ EXAMPLES
     $ sf api request graphql --body example.txt --stream-to-file output.txt --include
 ```
 
-_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.2.2/src/commands/api/request/graphql.ts)_
+_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.0/src/commands/api/request/graphql.ts)_
 
-## `sf api request rest ENDPOINT`
+## `sf api request rest [URL]`
 
 Make an authenticated HTTP request using the Salesforce REST API.
 
 ```
 USAGE
-  $ sf api request rest ENDPOINT -o <value> [--flags-dir <value>] [--api-version <value>] [-i | -S Example:
-    report.xlsx] [-X GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE] [-H key:value...] [--body file]
+  $ sf api request rest [URL] -o <value> [--flags-dir <value>] [--api-version <value>] [-i | -S Example: report.xlsx]
+    [-X GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE] [-H key:value...] [-f file] [-b file]
 
 ARGUMENTS
-  ENDPOINT  Salesforce API endpoint
+  URL  Salesforce API endpoint
 
 FLAGS
   -H, --header=key:value...                  HTTP header in "key:value" format.
   -S, --stream-to-file=Example: report.xlsx  Stream responses to a file.
-  -X, --method=<option>                      [default: GET] HTTP method for the request.
+  -X, --method=<option>                      HTTP method for the request.
                                              <options: GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE>
+  -b, --body=file                            File or content for the body of the HTTP request. Specify "-" to read from
+                                             standard input or "" for an empty body.
+  -f, --file=file                            JSON file that contains values for the request header, body, method, and
+                                             URL.
   -i, --include                              Include the HTTP response status and headers in the output.
   -o, --target-org=<value>                   (required) Username or alias of the target org. Not required if the
                                              `target-org` configuration variable is already set.
       --api-version=<value>                  Override the api version used for api requests made by this command
-      --body=file                            File or content for the body of the HTTP request. Specify "-" to read from
-                                             standard input or "" for an empty body.
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -957,7 +959,7 @@ EXAMPLES
 
   Create an account record using the POST method; specify the request details directly in the "--body" flag:
 
-    $ sf api request rest 'sobjects/account' --body "{\"Name\" : \"Account from REST API\",\"ShippingCity\" : \
+    $ sf api request rest sobjects/account --body "{\"Name\" : \"Account from REST API\",\"ShippingCity\" : \
       \"Boise\"}" --method POST
 
   Create an account record using the information in a file called "info.json":
@@ -968,9 +970,49 @@ EXAMPLES
 
     $ sf api request rest 'sobjects/account/<Account ID>' --body "{\"BillingCity\": \"San Francisco\"}" --method \
       PATCH
+
+  Store the values for the request header, body, and so on, in a file, which you then specify with the --file flag;
+  see the description of --file for more information:
+
+    $ sf api request rest --file myFile.json
+
+FLAG DESCRIPTIONS
+  -f, --file=file  JSON file that contains values for the request header, body, method, and URL.
+
+    Use this flag instead of specifying the request details with individual flags, such as --body or --method. This
+    schema defines how to create the JSON file:
+
+    {
+    url: { raw: string } | string;
+    method: 'GET', 'POST', 'PUT', 'PATCH', 'HEAD', 'DELETE', 'OPTIONS', 'TRACE';
+    description?: string;
+    header: string | Array<Record<string, string>>;
+    body: { mode: 'raw' | 'formdata'; raw: string; formdata: FormData };
+    }
+
+    Salesforce CLI defined this schema to be mimic Postman schemas; both share similar properties. The CLI's schema also
+    supports Postman Collections to reuse and share requests. As a result, you can build an API call using Postman,
+    export and save it to a file, and then use the file as a value to this flag. For information about Postman, see
+    https://learning.postman.com/.
+
+    Here's a simple example of a JSON file that contains values for the request URL, method, and body:
+
+    {
+    "url": "sobjects/Account/<Account ID>",
+    "method": "PATCH",
+    "body" : {
+    "mode": "raw",
+    "raw": {
+    "BillingCity": "Boise"
+    }
+    }
+    }
+
+    See more examples in the plugin-api test directory, including JSON files that use "formdata" to define collections:
+    https://github.com/salesforcecli/plugin-api/tree/main/test/test-files/data-project.
 ```
 
-_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.2.2/src/commands/api/request/rest.ts)_
+_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.0/src/commands/api/request/rest.ts)_
 
 ## `sf autocomplete [SHELL]`
 
@@ -1030,7 +1072,7 @@ DESCRIPTION
   List all sf commands.
 ```
 
-_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/4.0.16/src/commands/commands.ts)_
+_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/4.1.1/src/commands/commands.ts)_
 
 ## `sf config get`
 
@@ -5611,7 +5653,7 @@ EXAMPLES
   $ sf plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.10/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.12/src/commands/plugins/index.ts)_
 
 ## `sf plugins discover`
 
@@ -5656,7 +5698,7 @@ EXAMPLES
   $ sf plugins inspect @salesforce/plugin-packaging
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.10/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.12/src/commands/plugins/inspect.ts)_
 
 ## `sf plugins install PLUGIN`
 
@@ -5705,7 +5747,7 @@ EXAMPLES
     $ sf plugins install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.10/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.12/src/commands/plugins/install.ts)_
 
 ## `sf plugins link PATH`
 
@@ -5725,6 +5767,7 @@ FLAGS
 
 DESCRIPTION
   Links a plugin into the CLI for development.
+
   Installation of a linked plugin will override a user-installed or core plugin.
 
   e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
@@ -5735,7 +5778,7 @@ EXAMPLES
   $ sf plugins link @salesforce/plugin-packaging
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.10/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.12/src/commands/plugins/link.ts)_
 
 ## `sf plugins reset`
 
@@ -5750,7 +5793,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.10/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.12/src/commands/plugins/reset.ts)_
 
 ## `sf plugins trust verify`
 
@@ -5807,7 +5850,7 @@ EXAMPLES
   $ sf plugins uninstall @salesforce/plugin-packaging
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.10/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.12/src/commands/plugins/uninstall.ts)_
 
 ## `sf plugins update`
 
@@ -5825,7 +5868,7 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.10/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.12/src/commands/plugins/update.ts)_
 
 ## `sf project convert mdapi`
 
@@ -7943,10 +7986,11 @@ update the sf CLI
 
 ```
 USAGE
-  $ sf update [CHANNEL] [--force |  | [-a | -v <value> | -i]]
+  $ sf update [CHANNEL] [--force |  | [-a | -v <value> | -i]] [-b ]
 
 FLAGS
   -a, --available        See available versions.
+  -b, --verbose          Show more details about the available versions.
   -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
   -v, --version=<value>  Install a specific version.
       --force            Force a re-download of the requested version.
@@ -7972,7 +8016,7 @@ EXAMPLES
     $ sf update --available
 ```
 
-_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.5.10/src/commands/update.ts)_
+_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.6.0/src/commands/update.ts)_
 
 ## `sf version`