readme

transcend-io · Dec 2, 2024 · b433323 · b433323
1 parent c406035
commit b433323
Showing 1 changed file with 24 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -2316,8 +2316,6 @@ Once the mapping process is done once, it does not need to be done again.
 Additionally, the JSON cache file will store the result of any preferences that fail to be uploaded so that the
 script can be run multiple times if an issue happens.
 
-FIXME video
-
 #### Authentication
 
 In order to use this cli, you will first need to generate an API key on the Transcend Admin Dashboard (https://app.transcend.io/infrastructure/api-keys).
@@ -2331,18 +2329,22 @@ The API key needs the following scopes:
 #### Authentication
 
 In order to use this cli, you will first need to follow [this guide](https://docs.transcend.io/docs/consent/reference/managed-consent-database#authenticate-a-user's-consent) in order
-to grab your encryption and signing keys.
 
 #### Arguments
 
-| Argument     | Description                                                                          | Type         | Default                      | Required |
-| ------------ | ------------------------------------------------------------------------------------ | ------------ | ---------------------------- | -------- |
-| auth         | The Transcend API key with the scopes necessary for the command.                     | string       | N/A                          | true     |
-| partition    | The partition key to download consent preferences to                                 | string       | N/A                          | true     |
-| sombraAuth   | The sombra internal key, use for additional authentication when self-hosting sombra. | string       | N/A                          | false    |
-| transcendUrl | URL of the Transcend backend. Use https://consent.us.transcend.io for US hosting.    | string - URL | https://consent.transcend.io | false    |
-
-FIXME other args
+| Argument             | Description                                                                                       | Type               | Default                                      | Required |
+| -------------------- | ------------------------------------------------------------------------------------------------- | ------------------ | -------------------------------------------- | -------- |
+| auth                 | The Transcend API key with the scopes necessary for the command.                                  | string             | N/A                                          | true     |
+| partition            | The partition key to download consent preferences to                                              | string             | N/A                                          | true     |
+| sombraAuth           | The sombra internal key, use for additional authentication when self-hosting sombra.              | string             | N/A                                          | false    |
+| transcendUrl         | URL of the Transcend backend. Use https://consent.us.transcend.io for US hosting.                 | string - URL       | https://consent.transcend.io                 | false    |
+| file                 | Path to the CSV file to load preferences from                                                     | string - file-path | ./preferences.csv                            | false    |
+| dryRun               | Whether to do a dry run only - will write results ti receiptFilepath without updating Transcend   | boolean            | false                                        | false    |
+| skipWorkflowTriggers | Whether to skip workflow triggers when uploading to preference store                              | boolean            | false                                        | false    |
+| skipConflictUpdates  | Whether to skip uploading of any records where the preference store and file have a hard conflict | boolean            | false                                        | false    |
+| isSilent             | Whether to skip sending emails in workflows                                                       | boolean            | true                                         | false    |
+| attributes           | Attributes to add to any DSR request if created                                                   | string             | Tags:transcend-cli,Source:transcend-cli      | false    |
+| receiptFilepath      | Store resulting, continuing where left off                                                        | string - file-path | ./preference-management-upload-receipts.json | false    |
 
 #### Usage
 
@@ -2352,7 +2354,17 @@ Upload consent preferences to partition key `4d1c5daa-90b7-4d18-aa40-f86a43d2c72
 yarn tr-upload-preferences --auth=$TRANSCEND_API_KEY --partition=4d1c5daa-90b7-4d18-aa40-f86a43d2c726
 ```
 
-FIXME other usage
+Upload consent preferences with additional options
+
+```sh
+yarn tr-upload-preferences --auth=$TRANSCEND_API_KEY --partition=4d1c5daa-90b7-4d18-aa40-f86a43d2c726 --file=./preferences.csv --dryRun=true --skipWorkflowTriggers=true --skipConflictUpdates=true --isSilent=false --attributes="Tags:transcend-cli,Source:transcend-cli" --receiptFilepath=./preference-management-upload-receipts.json
+```
+
+Specifying the backend URL, needed for US hosted backend infrastructure.
+
+```sh
+yarn tr-upload-preferences --auth=$TRANSCEND_API_KEY --partition=4d1c5daa-90b7-4d18-aa40-f86a43d2c726 --transcendUrl=https://consent.us.transcend.io
+```
 
 ### tr-upload-consent-preferences