@transcend-io/cli 6.12.0 → 6.13.0

package/README.md

@@ -12,141 +12,145 @@
     - [Authentication](#authentication)
     - [Arguments](#arguments)
     - [Usage](#usage-1)
-  - [tr-push](#tr-push)
+  - [tr-pull-ot](#tr-pull-ot)
     - [Authentication](#authentication-1)
     - [Arguments](#arguments-1)
     - [Usage](#usage-2)
-    - [CI Integration](#ci-integration)
-    - [Dynamic Variables](#dynamic-variables)
-  - [tr-scan-packages](#tr-scan-packages)
+  - [tr-push](#tr-push)
     - [Authentication](#authentication-2)
     - [Arguments](#arguments-2)
     - [Usage](#usage-3)
-  - [tr-discover-silos](#tr-discover-silos)
+    - [CI Integration](#ci-integration)
+    - [Dynamic Variables](#dynamic-variables)
+  - [tr-scan-packages](#tr-scan-packages)
     - [Authentication](#authentication-3)
     - [Arguments](#arguments-3)
     - [Usage](#usage-4)
-  - [tr-request-approve](#tr-request-approve)
+  - [tr-discover-silos](#tr-discover-silos)
     - [Authentication](#authentication-4)
     - [Arguments](#arguments-4)
     - [Usage](#usage-5)
-  - [tr-request-cancel](#tr-request-cancel)
+  - [tr-request-approve](#tr-request-approve)
     - [Authentication](#authentication-5)
     - [Arguments](#arguments-5)
     - [Usage](#usage-6)
-  - [tr-request-notify-additional-time](#tr-request-notify-additional-time)
+  - [tr-request-cancel](#tr-request-cancel)
     - [Authentication](#authentication-6)
     - [Arguments](#arguments-6)
     - [Usage](#usage-7)
-  - [tr-request-mark-silent](#tr-request-mark-silent)
+  - [tr-request-notify-additional-time](#tr-request-notify-additional-time)
     - [Authentication](#authentication-7)
     - [Arguments](#arguments-7)
     - [Usage](#usage-8)
-  - [tr-request-upload](#tr-request-upload)
+  - [tr-request-mark-silent](#tr-request-mark-silent)
     - [Authentication](#authentication-8)
     - [Arguments](#arguments-8)
     - [Usage](#usage-9)
-  - [tr-request-restart](#tr-request-restart)
+  - [tr-request-upload](#tr-request-upload)
     - [Authentication](#authentication-9)
     - [Arguments](#arguments-9)
     - [Usage](#usage-10)
-  - [tr-request-enricher-restart](#tr-request-enricher-restart)
+  - [tr-request-restart](#tr-request-restart)
     - [Authentication](#authentication-10)
     - [Arguments](#arguments-10)
     - [Usage](#usage-11)
-  - [tr-request-reject-unverified-identifiers](#tr-request-reject-unverified-identifiers)
+  - [tr-request-enricher-restart](#tr-request-enricher-restart)
     - [Authentication](#authentication-11)
     - [Arguments](#arguments-11)
     - [Usage](#usage-12)
-  - [tr-request-export](#tr-request-export)
+  - [tr-request-reject-unverified-identifiers](#tr-request-reject-unverified-identifiers)
     - [Authentication](#authentication-12)
     - [Arguments](#arguments-12)
     - [Usage](#usage-13)
-  - [tr-cron-pull-identifiers](#tr-cron-pull-identifiers)
+  - [tr-request-export](#tr-request-export)
     - [Authentication](#authentication-13)
     - [Arguments](#arguments-13)
     - [Usage](#usage-14)
-  - [tr-cron-mark-identifiers-completed](#tr-cron-mark-identifiers-completed)
+  - [tr-cron-pull-identifiers](#tr-cron-pull-identifiers)
     - [Authentication](#authentication-14)
     - [Arguments](#arguments-14)
     - [Usage](#usage-15)
-  - [tr-manual-enrichment-pull-identifiers](#tr-manual-enrichment-pull-identifiers)
+  - [tr-cron-mark-identifiers-completed](#tr-cron-mark-identifiers-completed)
     - [Authentication](#authentication-15)
     - [Arguments](#arguments-15)
     - [Usage](#usage-16)
-  - [tr-manual-enrichment-push-identifiers](#tr-manual-enrichment-push-identifiers)
+  - [tr-manual-enrichment-pull-identifiers](#tr-manual-enrichment-pull-identifiers)
     - [Authentication](#authentication-16)
     - [Arguments](#arguments-16)
     - [Usage](#usage-17)
-  - [tr-mark-request-data-silos-completed](#tr-mark-request-data-silos-completed)
+  - [tr-manual-enrichment-push-identifiers](#tr-manual-enrichment-push-identifiers)
     - [Authentication](#authentication-17)
     - [Arguments](#arguments-17)
     - [Usage](#usage-18)
-  - [tr-skip-request-data-silos](#tr-skip-request-data-silos)
+  - [tr-mark-request-data-silos-completed](#tr-mark-request-data-silos-completed)
     - [Authentication](#authentication-18)
     - [Arguments](#arguments-18)
     - [Usage](#usage-19)
-  - [tr-retry-request-data-silos](#tr-retry-request-data-silos)
+  - [tr-skip-request-data-silos](#tr-skip-request-data-silos)
     - [Authentication](#authentication-19)
     - [Arguments](#arguments-19)
     - [Usage](#usage-20)
-  - [tr-update-consent-manager](#tr-update-consent-manager)
+  - [tr-retry-request-data-silos](#tr-retry-request-data-silos)
     - [Authentication](#authentication-20)
     - [Arguments](#arguments-20)
     - [Usage](#usage-21)
-  - [tr-consent-managers-to-business-entities](#tr-consent-managers-to-business-entities)
+  - [tr-update-consent-manager](#tr-update-consent-manager)
     - [Authentication](#authentication-21)
     - [Arguments](#arguments-21)
     - [Usage](#usage-22)
-  - [tr-consent-manager-service-json-to-yml](#tr-consent-manager-service-json-to-yml)
+  - [tr-consent-managers-to-business-entities](#tr-consent-managers-to-business-entities)
     - [Authentication](#authentication-22)
     - [Arguments](#arguments-22)
     - [Usage](#usage-23)
-  - [tr-derive-data-silos-from-data-flows](#tr-derive-data-silos-from-data-flows)
+  - [tr-consent-manager-service-json-to-yml](#tr-consent-manager-service-json-to-yml)
     - [Authentication](#authentication-23)
     - [Arguments](#arguments-23)
     - [Usage](#usage-24)
-  - [tr-derive-data-silos-from-data-flows-cross-instance](#tr-derive-data-silos-from-data-flows-cross-instance)
+  - [tr-derive-data-silos-from-data-flows](#tr-derive-data-silos-from-data-flows)
     - [Authentication](#authentication-24)
     - [Arguments](#arguments-24)
     - [Usage](#usage-25)
-  - [tr-pull-consent-metrics](#tr-pull-consent-metrics)
+  - [tr-derive-data-silos-from-data-flows-cross-instance](#tr-derive-data-silos-from-data-flows-cross-instance)
     - [Authentication](#authentication-25)
     - [Arguments](#arguments-25)
     - [Usage](#usage-26)
-  - [tr-pull-datapoints](#tr-pull-datapoints)
+  - [tr-pull-consent-metrics](#tr-pull-consent-metrics)
     - [Authentication](#authentication-26)
     - [Arguments](#arguments-26)
     - [Usage](#usage-27)
-  - [tr-upload-preferences](#tr-upload-preferences)
+  - [tr-pull-datapoints](#tr-pull-datapoints)
     - [Authentication](#authentication-27)
-    - [Authentication](#authentication-28)
     - [Arguments](#arguments-27)
     - [Usage](#usage-28)
-  - [tr-upload-consent-preferences](#tr-upload-consent-preferences)
+  - [tr-upload-preferences](#tr-upload-preferences)
+    - [Authentication](#authentication-28)
     - [Authentication](#authentication-29)
     - [Arguments](#arguments-28)
     - [Usage](#usage-29)
-  - [tr-pull-consent-preferences](#tr-pull-consent-preferences)
+  - [tr-upload-consent-preferences](#tr-upload-consent-preferences)
     - [Authentication](#authentication-30)
     - [Arguments](#arguments-29)
     - [Usage](#usage-30)
-  - [tr-upload-data-flows-from-csv](#tr-upload-data-flows-from-csv)
+  - [tr-pull-consent-preferences](#tr-pull-consent-preferences)
     - [Authentication](#authentication-31)
     - [Arguments](#arguments-30)
     - [Usage](#usage-31)
-  - [tr-upload-cookies-from-csv](#tr-upload-cookies-from-csv)
+  - [tr-upload-data-flows-from-csv](#tr-upload-data-flows-from-csv)
     - [Authentication](#authentication-32)
     - [Arguments](#arguments-31)
     - [Usage](#usage-32)
-  - [tr-generate-api-keys](#tr-generate-api-keys)
+  - [tr-upload-cookies-from-csv](#tr-upload-cookies-from-csv)
     - [Authentication](#authentication-33)
     - [Arguments](#arguments-32)
     - [Usage](#usage-33)
-  - [tr-build-xdi-sync-endpoint](#tr-build-xdi-sync-endpoint)
+  - [tr-generate-api-keys](#tr-generate-api-keys)
     - [Authentication](#authentication-34)
     - [Arguments](#arguments-33)
     - [Usage](#usage-34)
+  - [tr-build-xdi-sync-endpoint](#tr-build-xdi-sync-endpoint)
+    - [Authentication](#authentication-35)
+    - [Arguments](#arguments-34)
+    - [Usage](#usage-35)
 - [Prompt Manager](#prompt-manager)
 - [Proxy usage](#proxy-usage)
 
@@ -172,6 +176,7 @@ yarn add -D @transcend-io/cli
 
 # cli commands available within package
 yarn tr-pull --auth=$TRANSCEND_API_KEY
+yarn tr-pull-ot --auth=$ONE_TRUST_OAUTH_TOKEN --hostname=$ONE_TRUST_HOSTNAME --file=$ONE_TRUST_OUTPUT_FILE
 yarn tr-push --auth=$TRANSCEND_API_KEY
 yarn tr-scan-packages --auth=$TRANSCEND_API_KEY
 yarn tr-discover-silos --auth=$TRANSCEND_API_KEY
@@ -212,6 +217,7 @@ npm i -D @transcend-io/cli
 
 # cli commands available within package
 tr-pull --auth=$TRANSCEND_API_KEY
+tr-pull-ot --auth=$ONE_TRUST_OAUTH_TOKEN --hostname=$ONE_TRUST_HOSTNAME --file=$ONE_TRUST_OUTPUT_FILE
 tr-push --auth=$TRANSCEND_API_KEY
 tr-scan-packages --auth=$TRANSCEND_API_KEY
 tr-discover-silos --auth=$TRANSCEND_API_KEY
@@ -571,6 +577,43 @@ tr-pull --auth=./transcend-api-keys.json --resources=consentManager --file=./tra
 
 Note: This command will overwrite the existing transcend.yml file that you have locally.
 
+### tr-pull-ot
+
+Pulls resources from a OneTrust instance. For now, it only supports retrieving OneTrust Assessments. It sends a request to the [Get List of Assessments](https://developer.onetrust.com/onetrust/reference/getallassessmentbasicdetailsusingget) endpoint to fetch a list of all Assessments in your account. Then, it queries the [Get Assessment](https://developer.onetrust.com/onetrust/reference/exportassessmentusingget) and [Get Risk](https://developer.onetrust.com/onetrust/reference/getriskusingget) endpoints to enrich these assessments with more details such as respondents, approvers, assessment questions and responses, and assessment risks. Finally, it syncs the enriched resources to disk in the specified file and format.
+
+This command can be helpful if you are looking to:
+
+- Pull resources from your OneTrust account.
+- Migrate your resources from your OneTrust account to Transcend.
+
+#### Authentication
+
+In order to use this command, you will need to generate a OneTrust OAuth Token with scope for accessing the following endpoints:
+
+- [GET /v2/assessments](https://developer.onetrust.com/onetrust/reference/getallassessmentbasicdetailsusingget)
+- [GET /v2/assessments/{assessmentId}/export](https://developer.onetrust.com/onetrust/reference/exportassessmentusingget)
+- [GET /risks/{riskId}](https://developer.onetrust.com/onetrust/reference/getriskusingget)
+
+To learn how to generate the token, see the [OAuth 2.0 Scopes](https://developer.onetrust.com/onetrust/reference/oauth-20-scopes) and [Generate Access Token](https://developer.onetrust.com/onetrust/reference/getoauthtoken) pages.
+
+#### Arguments
+
+| Argument   | Description                                                                                       | Type    | Default     | Required |
+| ---------- | ------------------------------------------------------------------------------------------------- | ------- | ----------- | -------- |
+| auth       | The OAuth access token with the scopes necessary to access the OneTrust Public APIs.              | string  | N/A         | true     |
+| hostname   | The domain of the OneTrust environment from which to pull the resource (e.g. trial.onetrust.com). | string  | N/A         | true     |
+| file       | Path to the file to pull the resource into. Its format must match the fileFormat argument.        | string  | N/A         | true     |
+| fileFormat | The format of the output file. For now, only json is supported.                                   | string  | json        | false    |
+| resource   | The resource to pull from OneTrust. For now, only assessments is supported.                       | string  | assessments | false    |
+| debug      | Whether to print detailed logs in case of error.                                                  | boolean | false       | false    |
+
+#### Usage
+
+```sh
+# Writes out file to ./oneTrustAssessments.json
+tr-pull-ot --auth=$ONE_TRUST_OAUTH_TOKEN --hostname=trial.onetrust.com --file=./oneTrustAssessments.json
+```
+
 ### tr-push
 
 Given a transcend.yml file, sync the contents up to your connected services view (https://app.transcend.io/privacy-requests/connected-services).
@@ -792,12 +835,13 @@ The API key needs the following scopes:
 
 #### Arguments
 
-| Argument    | Description                                                   | Type     | Default                                                   | Required |
-| ----------- | ------------------------------------------------------------- | -------- | --------------------------------------------------------- | -------- |
-| auth        | Transcend API key.                                            | string   | N/A                                                       | true     |
-| scanPath    | File path in the project to scan.                             | string   | ./                                                        | false    |
-| ignoreDirs  | List of directories to ignore in scan                         | string[] | []                                                        | false    |
-| packageName | Name of the git repository that the package should be tied to | string   | $(`cd ${scanPath} && git config --get remote.origin.url`) | false    |
+| Argument     | Description                                                                   | Type         | Default                                                   | Required |
+| ------------ | ----------------------------------------------------------------------------- | ------------ | --------------------------------------------------------- | -------- |
+| auth         | Transcend API key.                                                            | string       | N/A                                                       | true     |
+| scanPath     | File path in the project to scan.                                             | string       | ./                                                        | false    |
+| ignoreDirs   | List of directories to ignore in scan                                         | string[]     | []                                                        | false    |
+| packageName  | Name of the git repository that the package should be tied to                 | string       | $(`cd ${scanPath} && git config --get remote.origin.url`) | false    |
+| transcendUrl | URL of the Transcend backend. Use https://api.us.transcend.io for US hosting. | string - URL | https://api.transcend.io                                  | false    |
 
 #### Usage
 

package/build/cli-pull-ot.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli-pull-ot.d.ts.map

package/build/cli-pull-ot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-pull-ot.d.ts","sourceRoot":"","sources":["../src/cli-pull-ot.ts"],"names":[],"mappings":""}

package/build/cli-pull-ot.js

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("./logger");
+const colors_1 = __importDefault(require("colors"));
+const oneTrust_1 = require("./oneTrust");
+const enums_1 = require("./enums");
+const bluebird_1 = require("bluebird");
+/**
+ * Pull configuration from OneTrust down locally to disk
+ *
+ * Dev Usage:
+ * yarn ts-node ./src/cli-pull-ot.ts --hostname=customer.my.onetrust.com --auth=$ONE_TRUST_OAUTH_TOKEN --file=./oneTrustAssessment.json
+ *
+ * Standard usage
+ * yarn cli-pull-ot --hostname=customer.my.onetrust.com --auth=$ONE_TRUST_OAUTH_TOKEN --file=./oneTrustAssessment.json
+ */
+async function main() {
+    const { file, fileFormat, hostname, auth, resource, debug } = (0, oneTrust_1.parseCliPullOtArguments)();
+    try {
+        if (resource === enums_1.OneTrustPullResource.Assessments) {
+            // use the hostname and auth token to instantiate a client to talk to OneTrust
+            const oneTrust = (0, oneTrust_1.createOneTrustGotInstance)({ hostname, auth });
+            // fetch the list of all assessments in the OneTrust organization
+            const assessments = await (0, oneTrust_1.getListOfAssessments)({ oneTrust });
+            // fetch details about one assessment at a time and sync to disk right away to avoid running out of memory
+            await (0, bluebird_1.mapSeries)(assessments, async (assessment, index) => {
+                logger_1.logger.info(`Fetching details about assessment ${index + 1} of ${assessments.length}...`);
+                const assessmentDetails = await (0, oneTrust_1.getAssessment)({
+                    oneTrust,
+                    assessmentId: assessment.assessmentId,
+                });
+                (0, oneTrust_1.writeOneTrustAssessment)({
+                    assessment,
+                    assessmentDetails,
+                    index,
+                    total: assessments.length,
+                    file,
+                    fileFormat,
+                });
+            });
+        }
+    }
+    catch (err) {
+        logger_1.logger.error(colors_1.default.red(`An error occurred pulling the resource ${resource} from OneTrust: ${debug ? err.stack : err.message}`));
+        process.exit(1);
+    }
+    // Indicate success
+    logger_1.logger.info(colors_1.default.green(`Successfully synced OneTrust ${resource} to disk at "${file}"!`));
+}
+main();
+//# sourceMappingURL=cli-pull-ot.js.map

package/build/cli-pull-ot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-pull-ot.js","sourceRoot":"","sources":["../src/cli-pull-ot.ts"],"names":[],"mappings":";;;;;;AACA,qCAAkC;AAClC,oDAA4B;AAC5B,yCAMoB;AACpB,mCAA+C;AAC/C,uCAAqC;AAErC;;;;;;;;GAQG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GACzD,IAAA,kCAAuB,GAAE,CAAC;IAE5B,IAAI;QACF,IAAI,QAAQ,KAAK,4BAAoB,CAAC,WAAW,EAAE;YACjD,8EAA8E;YAC9E,MAAM,QAAQ,GAAG,IAAA,oCAAyB,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;YAE/D,iEAAiE;YACjE,MAAM,WAAW,GAAG,MAAM,IAAA,+BAAoB,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YAE7D,0GAA0G;YAC1G,MAAM,IAAA,oBAAS,EAAC,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE;gBACvD,eAAM,CAAC,IAAI,CACT,qCAAqC,KAAK,GAAG,CAAC,OAC5C,WAAW,CAAC,MACd,KAAK,CACN,CAAC;gBACF,MAAM,iBAAiB,GAAG,MAAM,IAAA,wBAAa,EAAC;oBAC5C,QAAQ;oBACR,YAAY,EAAE,UAAU,CAAC,YAAY;iBACtC,CAAC,CAAC;gBAEH,IAAA,kCAAuB,EAAC;oBACtB,UAAU;oBACV,iBAAiB;oBACjB,KAAK;oBACL,KAAK,EAAE,WAAW,CAAC,MAAM;oBACzB,IAAI;oBACJ,UAAU;iBACX,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;SACJ;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,0CAA0C,QAAQ,mBAChD,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAC1B,EAAE,CACH,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,mBAAmB;IACnB,eAAM,CAAC,IAAI,CACT,gBAAM,CAAC,KAAK,CACV,gCAAgC,QAAQ,gBAAgB,IAAI,IAAI,CACjE,CACF,CAAC;AACJ,CAAC;AAED,IAAI,EAAE,CAAC"}

package/build/codecs.d.ts

@@ -113,7 +113,6 @@ export declare const TeamInput: t.IntersectionC<[t.TypeC<{
         viewScopes: unknown;
         viewSSO: unknown;
         viewEmployees: unknown;
-        viewOptOutStatus: unknown;
         viewDataInventory: unknown;
         manageDataInventory: unknown;
         manageGlobalAttributes: unknown;
@@ -48473,7 +48472,6 @@ export declare const TranscendInput: t.PartialC<{
             viewScopes: unknown;
             viewSSO: unknown;
             viewEmployees: unknown;
-            viewOptOutStatus: unknown;
             viewDataInventory: unknown;
             manageDataInventory: unknown;
             manageGlobalAttributes: unknown;