@salesforce/plugin-api 1.2.0 → 1.2.1

package/README.md

@@ -66,7 +66,7 @@ sf plugins
 
 Execute GraphQL statements
 
-````
+```
 USAGE
   $ sf api request graphql -o <value> --body file [--json] [--flags-dir <value>] [--api-version <value>] [-S Example:
     report.xlsx | -i]
@@ -94,86 +94,78 @@ EXAMPLES
   - Runs the graphql query directly via the command line
     sf api request graphql --body "query accounts { uiapi { query { Account { edges { node { Id \n Name { value } } } } } } }"
   - Runs a mutation to create an Account, with an `example.txt` file, containing
-  ```text
-  mutation AccountExample{
-    uiapi {
-      AccountCreate(input: {
-        Account: {
-          Name: "Trailblazer Express"
-        }
-      }) {
-        Record {
-          Id
-          Name {
-            value
+    mutation AccountExample{
+      uiapi {
+        AccountCreate(input: {
+          Account: {
+            Name: "Trailblazer Express"
+          }
+        }) {
+          Record {
+            Id
+            Name {
+              value
+            }
           }
         }
       }
     }
-  }
-````
-
-$ sf api request graphql --body example.txt
-will create a new account returning specified fields (Id, Name)
-
+  $ sf api request graphql --body example.txt
+  will create a new account returning specified fields (Id, Name)
 ```
 
-_See code: [src/commands/api/request/graphql.ts](https://github.com/salesforcecli/plugin-api/blob/1.2.0/src/commands/api/request/graphql.ts)_
+_See code: [src/commands/api/request/graphql.ts](https://github.com/salesforcecli/plugin-api/blob/1.2.1/src/commands/api/request/graphql.ts)_
 
 ## `sf api request rest ENDPOINT`
 
 Make an authenticated HTTP request to Salesforce REST API and print the response.
 
 ```
-
 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 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]
 
 ARGUMENTS
-ENDPOINT Salesforce API endpoint
+  ENDPOINT  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.
-<options: GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE>
--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 to use as the body for the request. Specify "-" to read from standard
-input; specify "" for an empty body.
+  -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.
+                                             <options: GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE>
+  -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 to use as the body for the request. Specify "-" to read from standard
+                                             input; specify "" for an empty body.
 
 GLOBAL FLAGS
---flags-dir=<value> Import flag values from a directory.
+  --flags-dir=<value>  Import flag values from a directory.
 
 EXAMPLES
-
-- List information about limits in the org with alias "my-org":
-  sf api request rest 'limits' --target-org my-org
-- List all endpoints
-  sf api request rest '/'
-- Get the response in XML format by specifying the "Accept" HTTP header:
-  sf api request rest 'limits' --target-org my-org --header 'Accept: application/xml'
-- POST to create an Account object
-  sf api request rest 'sobjects/account' --body "{\"Name\" : \"Account from REST API\",\"ShippingCity\" : \"Boise\"}" --method POST
-- or with a file 'info.json' containing
-
-```json
-{
-  "Name": "Demo",
-  "ShippingCity": "Boise"
-}
+  - List information about limits in the org with alias "my-org":
+    sf api request rest 'limits' --target-org my-org
+  - List all endpoints
+    sf api request rest '/'
+  - Get the response in XML format by specifying the "Accept" HTTP header:
+    sf api request rest 'limits' --target-org my-org --header 'Accept: application/xml'
+  - POST to create an Account object
+    sf api request rest 'sobjects/account' --body "{\"Name\" : \"Account from REST API\",\"ShippingCity\" : \"Boise\"}" --method POST
+  - or with a file 'info.json' containing
+    {
+      "Name": "Demo",
+      "ShippingCity": "Boise"
+    }
+  $ sf api request rest 'sobjects/account' --body info.json --method POST
+  - Update object
+    sf api request rest 'sobjects/account/<Account ID>' --body "{\"BillingCity\": \"San Francisco\"}" --method PATCH
 ```
 
-$ sf api request rest 'sobjects/account' --body info.json --method POST
+_See code: [src/commands/api/request/rest.ts](https://github.com/salesforcecli/plugin-api/blob/1.2.1/src/commands/api/request/rest.ts)_
 
-- Update object
-  sf api request rest 'sobjects/account/<Account ID>' --body "{\"BillingCity\": \"San Francisco\"}" --method PATCH
+<!-- commandsstop -->
 
 ```
 
-_See code: [src/commands/api/request/rest.ts](https://github.com/salesforcecli/plugin-api/blob/1.2.0/src/commands/api/request/rest.ts)_
-<!-- commandsstop -->
 ```

package/messages/graphql.md

@@ -14,24 +14,22 @@ Run any valid GraphQL statement via the /graphql [API](https://developer.salesfo
 
 - Runs a mutation to create an Account, with an `example.txt` file, containing
 
-```text
-mutation AccountExample{
-  uiapi {
-    AccountCreate(input: {
-      Account: {
-        Name: "Trailblazer Express"
-      }
-    }) {
-      Record {
-        Id
-        Name {
-          value
+  mutation AccountExample{
+    uiapi {
+      AccountCreate(input: {
+        Account: {
+          Name: "Trailblazer Express"
+        }
+      }) {
+        Record {
+          Id
+          Name {
+            value
+          }
         }
       }
     }
   }
-}
-```
 
 <%= config.bin %> <%= command.id %> --body example.txt
 

package/messages/rest.md

@@ -22,12 +22,10 @@ Make an authenticated HTTP request to Salesforce REST API and print the response
 
 - or with a file 'info.json' containing
 
-```json
-{
-  "Name": "Demo",
-  "ShippingCity": "Boise"
-}
-```
+  {
+    "Name": "Demo",
+    "ShippingCity": "Boise"
+  }
 
 <%= config.bin %> <%= command.id %> 'sobjects/account' --body info.json --method POST
 

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@salesforce/plugin-api",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@salesforce/plugin-api",
-      "version": "1.2.0",
+      "version": "1.2.1",
       "license": "BSD-3-Clause",
       "dependencies": {
         "@oclif/core": "^4",

package/oclif.manifest.json

@@ -5,7 +5,7 @@
       "args": {},
       "description": "Run any valid GraphQL statement via the /graphql [API](https://developer.salesforce.com/docs/platform/graphql/guide/graphql-about.html)",
       "examples": [
-        "- Runs the graphql query directly via the command line\n\n  <%= config.bin %> <%= command.id %> --body \"query accounts { uiapi { query { Account { edges { node { Id \\n Name { value } } } } } } }\"\n\n- Runs a mutation to create an Account, with an `example.txt` file, containing\n\n```text\nmutation AccountExample{\n  uiapi {\n    AccountCreate(input: {\n      Account: {\n        Name: \"Trailblazer Express\"\n      }\n    }) {\n      Record {\n        Id\n        Name {\n          value\n        }\n      }\n    }\n  }\n}\n```\n\n<%= config.bin %> <%= command.id %> --body example.txt\n\nwill create a new account returning specified fields (Id, Name)"
+        "- Runs the graphql query directly via the command line\n\n  <%= config.bin %> <%= command.id %> --body \"query accounts { uiapi { query { Account { edges { node { Id \\n Name { value } } } } } } }\"\n\n- Runs a mutation to create an Account, with an `example.txt` file, containing\n\n  mutation AccountExample{\n    uiapi {\n      AccountCreate(input: {\n        Account: {\n          Name: \"Trailblazer Express\"\n        }\n      }) {\n        Record {\n          Id\n          Name {\n            value\n          }\n        }\n      }\n    }\n  }\n\n<%= config.bin %> <%= command.id %> --body example.txt\n\nwill create a new account returning specified fields (Id, Name)"
       ],
       "flags": {
         "json": {
@@ -110,7 +110,7 @@
         }
       },
       "examples": [
-        "- List information about limits in the org with alias \"my-org\":\n\n  <%= config.bin %> <%= command.id %> 'limits' --target-org my-org\n\n- List all endpoints\n\n  <%= config.bin %> <%= command.id %> '/'\n\n- Get the response in XML format by specifying the \"Accept\" HTTP header:\n\n  <%= config.bin %> <%= command.id %> 'limits' --target-org my-org --header 'Accept: application/xml'\n\n- POST to create an Account object\n\n  <%= config.bin %> <%= command.id %> 'sobjects/account' --body \"{\\\"Name\\\" : \\\"Account from REST API\\\",\\\"ShippingCity\\\" : \\\"Boise\\\"}\" --method POST\n\n- or with a file 'info.json' containing\n\n```json\n{\n  \"Name\": \"Demo\",\n  \"ShippingCity\": \"Boise\"\n}\n```\n\n<%= config.bin %> <%= command.id %> 'sobjects/account' --body info.json --method POST\n\n- Update object\n\n  <%= config.bin %> <%= command.id %> 'sobjects/account/<Account ID>' --body \"{\\\"BillingCity\\\": \\\"San Francisco\\\"}\" --method PATCH"
+        "- List information about limits in the org with alias \"my-org\":\n\n  <%= config.bin %> <%= command.id %> 'limits' --target-org my-org\n\n- List all endpoints\n\n  <%= config.bin %> <%= command.id %> '/'\n\n- Get the response in XML format by specifying the \"Accept\" HTTP header:\n\n  <%= config.bin %> <%= command.id %> 'limits' --target-org my-org --header 'Accept: application/xml'\n\n- POST to create an Account object\n\n  <%= config.bin %> <%= command.id %> 'sobjects/account' --body \"{\\\"Name\\\" : \\\"Account from REST API\\\",\\\"ShippingCity\\\" : \\\"Boise\\\"}\" --method POST\n\n- or with a file 'info.json' containing\n\n  {\n    \"Name\": \"Demo\",\n    \"ShippingCity\": \"Boise\"\n  }\n\n<%= config.bin %> <%= command.id %> 'sobjects/account' --body info.json --method POST\n\n- Update object\n\n  <%= config.bin %> <%= command.id %> 'sobjects/account/<Account ID>' --body \"{\\\"BillingCity\\\": \\\"San Francisco\\\"}\" --method PATCH"
       ],
       "flags": {
         "flags-dir": {
@@ -226,5 +226,5 @@
       ]
     }
   },
-  "version": "1.2.0"
+  "version": "1.2.1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-api",
     "description": "A plugin to call API endpoints via CLI commands",
-    "version": "1.2.0",
+    "version": "1.2.1",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
@@ -202,7 +202,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-api/1.2.0.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-api/1.2.0.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-api/1.2.1.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-api/1.2.1.sig"
     }
 }