@transcend-io/cli 4.48.1 → 4.49.0

package/README.md

@@ -29,38 +29,42 @@
     - [Authentication](#authentication-4)
     - [Arguments](#arguments-4)
     - [Usage](#usage-5)
-  - [tr-cron-pull-identifiers](#tr-cron-pull-identifiers)
+  - [tr-request-export](#tr-request-export)
     - [Authentication](#authentication-5)
     - [Arguments](#arguments-5)
     - [Usage](#usage-6)
-  - [tr-cron-mark-identifiers-completed](#tr-cron-mark-identifiers-completed)
+  - [tr-cron-pull-identifiers](#tr-cron-pull-identifiers)
     - [Authentication](#authentication-6)
     - [Arguments](#arguments-6)
     - [Usage](#usage-7)
-  - [tr-manual-enrichment-pull-identifiers](#tr-manual-enrichment-pull-identifiers)
+  - [tr-cron-mark-identifiers-completed](#tr-cron-mark-identifiers-completed)
     - [Authentication](#authentication-7)
     - [Arguments](#arguments-7)
     - [Usage](#usage-8)
-  - [tr-manual-enrichment-push-identifiers](#tr-manual-enrichment-push-identifiers)
+  - [tr-manual-enrichment-pull-identifiers](#tr-manual-enrichment-pull-identifiers)
     - [Authentication](#authentication-8)
     - [Arguments](#arguments-8)
     - [Usage](#usage-9)
-  - [tr-mark-request-data-silos-completed](#tr-mark-request-data-silos-completed)
+  - [tr-manual-enrichment-push-identifiers](#tr-manual-enrichment-push-identifiers)
     - [Authentication](#authentication-9)
     - [Arguments](#arguments-9)
     - [Usage](#usage-10)
-  - [tr-retry-request-data-silos](#tr-retry-request-data-silos)
+  - [tr-mark-request-data-silos-completed](#tr-mark-request-data-silos-completed)
     - [Authentication](#authentication-10)
     - [Arguments](#arguments-10)
     - [Usage](#usage-11)
-  - [tr-update-consent-manager](#tr-update-consent-manager)
+  - [tr-retry-request-data-silos](#tr-retry-request-data-silos)
     - [Authentication](#authentication-11)
     - [Arguments](#arguments-11)
     - [Usage](#usage-12)
-  - [tr-generate-api-keys](#tr-generate-api-keys)
+  - [tr-update-consent-manager](#tr-update-consent-manager)
     - [Authentication](#authentication-12)
     - [Arguments](#arguments-12)
     - [Usage](#usage-13)
+  - [tr-generate-api-keys](#tr-generate-api-keys)
+    - [Authentication](#authentication-13)
+    - [Arguments](#arguments-13)
+    - [Usage](#usage-14)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -83,9 +87,15 @@ yarn tr-pull --auth=$TRANSCEND_API_KEY
 yarn tr-push --auth=$TRANSCEND_API_KEY
 yarn tr-discover-silos --auth=$TRANSCEND_API_KEY
 yarn tr-request-upload --auth=$TRANSCEND_API_KEY
+yarn tr-request-export --auth=$TRANSCEND_API_KEY
 yarn tr-request-restart --auth=$TRANSCEND_API_KEY
 yarn tr-cron-pull-identifiers --auth=$TRANSCEND_API_KEY
 yarn tr-cron-mark-identifiers-completed --auth=$TRANSCEND_API_KEY
+yarn tr-manual-enrichment-pull-identifiers --auth=$TRANSCEND_API_KEY
+yarn tr-mark-request-data-silos-completed --auth=$TRANSCEND_API_KEY
+yarn tr-retry-request-data-silos --auth=$TRANSCEND_API_KEY
+yarn tr-update-consent-manager --auth=$TRANSCEND_API_KEY
+yarn tr-generate-api-keys --auth=$TRANSCEND_API_KEY
 ```
 
 or
@@ -99,9 +109,15 @@ tr-pull --auth=$TRANSCEND_API_KEY
 tr-push --auth=$TRANSCEND_API_KEY
 tr-discover-silos --auth=$TRANSCEND_API_KEY
 tr-request-upload --auth=$TRANSCEND_API_KEY
+tr-request-export --auth=$TRANSCEND_API_KEY
 tr-request-restart --auth=$TRANSCEND_API_KEY
 tr-cron-pull-identifiers --auth=$TRANSCEND_API_KEY
 tr-cron-mark-identifiers-completed --auth=$TRANSCEND_API_KEY
+tr-manual-enrichment-pull-identifiers --auth=$TRANSCEND_API_KEY
+tr-mark-request-data-silos-completed --auth=$TRANSCEND_API_KEY
+tr-retry-request-data-silos --auth=$TRANSCEND_API_KEY
+tr-update-consent-manager --auth=$TRANSCEND_API_KEY
+tr-generate-api-keys --auth=$TRANSCEND_API_KEY
 ```
 
 alternatively, you can install the cli globally on your machine:
@@ -797,6 +813,77 @@ Skip queued state of request and go straight to compiling
 yarn tr-request-restart --auth=$TRANSCEND_API_KEY --statuses=COMPILING,ENRICHING --actions=ACCESS,ERASURE --skipWaitingPeriod=true
 ```
 
+### tr-request-export
+
+Export privacy requests and request identifiers to a CSV file.
+
+#### 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).
+
+The API key needs the following scopes:
+
+- View Incoming Requests
+- View the Request Compilation
+
+#### Arguments
+
+| Argument        | Description                                                                                                                               | Type               | Default                        | Required |
+| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------------ | -------- |
+| auth            | The Transcend API capable of pulling privacy requests.                                                                                    | string             | N/A                            | true     |
+| actions         | The [request action](https://docs.transcend.io/docs/privacy-requests/configuring-requests/data-subject-requests#data-actions) to restart. | RequestAction[]    | N/A                            | false    |
+| statuses        | The [request statuses](https://docs.transcend.io/docs/privacy-requests/overview#request-statuses) to restart.                             | RequestStatus[]    | N/A                            | false    |
+| transcendUrl    | URL of the Transcend backend. Use https://api.us.transcend.io for US hosting.                                                             | string - URL       | https://api.transcend.io       | false    |
+| file            | Path to the CSV file where identifiers will be written to.                                                                                | string - file-path | ./transcend-request-export.csv | false    |
+| concurrency     | The concurrency to use when uploading requests in parallel.                                                                               | number             | 100                            | false    |
+| createdAtBefore | Pull requests that were submitted before this time                                                                                        | Date               | N/A                            | false    |
+| createdAtAfter  | Pull requests that were submitted after this time                                                                                         | Date               | N/A                            | false    |
+| showTests       | Filter for test requests or production requests - when not provided, pulls both                                                           | boolean            | N/A                            | false    |
+
+#### Usage
+
+Pull all requests:
+
+```sh
+yarn tr-request-export --auth=$TRANSCEND_API_KEY
+```
+
+Filter for specific actions and statuses:
+
+```sh
+yarn tr-request-export --auth=$TRANSCEND_API_KEY --statuses=COMPILING,ENRICHING --actions=ACCESS,ERASURE
+```
+
+Specifying the backend URL, needed for US hosted backend infrastructure.
+
+```sh
+yarn tr-request-export --auth=$TRANSCEND_API_KEY --transcendUrl=https://api.us.transcend.io
+```
+
+Increase the concurrency (defaults to 100)
+
+```sh
+yarn tr-request-export --auth=$TRANSCEND_API_KEY --concurrency=500
+```
+
+Filter for production requests only
+
+```sh
+yarn tr-request-export --auth=$TRANSCEND_API_KEY --showTests=false
+```
+
+Filter for requests within a date range
+
+```sh
+yarn tr-request-export --auth=$TRANSCEND_API_KEY --createdAtBefore="04/05/2023" --createdAtAfter="02/21/2023"
+```
+
+Write to a specific file location
+
+```sh
+yarn tr-request-export --auth=$TRANSCEND_API_KEY --file=./path/to/file.csv
+```
+
 ### tr-cron-pull-identifiers
 
 If you are using the cron job integration, you can run this command to pull the outstanding identifiers
@@ -1139,7 +1226,7 @@ The API key must have the following scopes:
 yarn tr-update-consent-manager --auth=$TRANSCEND_API_KEY
 ```
 
-Specifying the backend URL, needed for US hosted backend infrastructure.
+Specifying the backend URL, needed for US hosted backend infrastructu re.
 
 ```sh
 yarn tr-update-consent-manager --auth=$TRANSCEND_API_KEY --transcendUrl=https://api.us.transcend.io

package/build/cli-request-export.d.ts

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

package/build/cli-request-export.d.ts.map

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

package/build/cli-request-export.js

@@ -0,0 +1,71 @@
+#!/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 yargs_parser_1 = __importDefault(require("yargs-parser"));
+const colors_1 = __importDefault(require("colors"));
+const logger_1 = require("./logger");
+const privacy_types_1 = require("@transcend-io/privacy-types");
+const requests_1 = require("./requests");
+/**
+ * Pull down the metadata for a set of Privacy requests.
+ *
+ * Requires scopes:
+ * - View Incoming Requests
+ * - View the Request Compilation
+ *
+ * Dev Usage:
+ * yarn ts-node ./src/cli-request-export.ts --auth=asd123 \
+ *   --requestType=ERASURE \
+ *   --file=/Users/michaelfarrell/Desktop/test.csv
+ *
+ * Standard usage:
+ * yarn tr-request-export --auth=asd123  \
+ *   --requestType=ERASURE \
+ *   --file=/Users/michaelfarrell/Desktop/test.csv
+ */
+async function main() {
+    // Parse command line arguments
+    const { file = './transcend-request-export.csv', transcendUrl = 'https://api.transcend.io', auth, actions = '', statuses = '', showTests, createdAtBefore, createdAtAfter, pageLimit = '100', } = (0, yargs_parser_1.default)(process.argv.slice(2));
+    // Ensure auth is passed
+    if (!auth) {
+        logger_1.logger.error(colors_1.default.red('A Transcend API key must be provided. You can specify using --auth=asd123'));
+        process.exit(1);
+    }
+    // Validate actions
+    const parsedActions = (0, requests_1.splitCsvToList)(actions);
+    const invalidActions = parsedActions.filter(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (type) => !Object.values(privacy_types_1.RequestAction).includes(type));
+    if (invalidActions.length > 0) {
+        logger_1.logger.error(colors_1.default.red(`Failed to parse actions:"${invalidActions.join(',')}".\n` +
+            `Expected one of: \n${Object.values(privacy_types_1.RequestAction).join('\n')}`));
+        process.exit(1);
+    }
+    // Validate statuses
+    const parsedStatuses = (0, requests_1.splitCsvToList)(statuses);
+    const invalidStatuses = parsedStatuses.filter(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (type) => !Object.values(privacy_types_1.RequestAction).includes(type));
+    if (invalidStatuses.length > 0) {
+        logger_1.logger.error(colors_1.default.red(`Failed to parse statuses:"${invalidStatuses.join(',')}".\n` +
+            `Expected one of: \n${Object.values(privacy_types_1.RequestStatus).join('\n')}`));
+        process.exit(1);
+    }
+    // Pull privacy requests
+    await (0, requests_1.pullRequestsToCsv)({
+        file,
+        transcendUrl,
+        pageLimit: parseInt(pageLimit, 10),
+        actions: parsedActions,
+        statuses: parsedStatuses,
+        auth,
+        createdAtBefore: createdAtBefore ? new Date(createdAtBefore) : undefined,
+        createdAtAfter: createdAtAfter ? new Date(createdAtAfter) : undefined,
+        showTests: showTests === 'true' ? true : showTests === 'false' ? false : undefined,
+    });
+}
+main();
+//# sourceMappingURL=cli-request-export.js.map

package/build/cli-request-export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-request-export.js","sourceRoot":"","sources":["../src/cli-request-export.ts"],"names":[],"mappings":";;;;;;AAEA,gEAAiC;AACjC,oDAA4B;AAE5B,qCAAkC;AAClC,+DAA2E;AAC3E,yCAA+D;AAE/D;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,IAAI;IACjB,+BAA+B;IAC/B,MAAM,EACJ,IAAI,GAAG,gCAAgC,EACvC,YAAY,GAAG,0BAA0B,EACzC,IAAI,EACJ,OAAO,GAAG,EAAE,EACZ,QAAQ,GAAG,EAAE,EACb,SAAS,EACT,eAAe,EACf,cAAc,EACd,SAAS,GAAG,KAAK,GAClB,GAAG,IAAA,sBAAK,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAA8B,CAAC;IAE9D,wBAAwB;IACxB,IAAI,CAAC,IAAI,EAAE;QACT,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,2EAA2E,CAC5E,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,mBAAmB;IACnB,MAAM,aAAa,GAAG,IAAA,yBAAc,EAAC,OAAO,CAAoB,CAAC;IACjE,MAAM,cAAc,GAAG,aAAa,CAAC,MAAM;IACzC,8DAA8D;IAC9D,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,CAAC,QAAQ,CAAC,IAAW,CAAC,CAC9D,CAAC;IACF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;QAC7B,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,4BAA4B,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM;YACxD,sBAAsB,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAClE,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,oBAAoB;IACpB,MAAM,cAAc,GAAG,IAAA,yBAAc,EAAC,QAAQ,CAAoB,CAAC;IACnE,MAAM,eAAe,GAAG,cAAc,CAAC,MAAM;IAC3C,8DAA8D;IAC9D,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,CAAC,QAAQ,CAAC,IAAW,CAAC,CAC9D,CAAC;IACF,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;QAC9B,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,6BAA6B,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM;YAC1D,sBAAsB,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAClE,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,wBAAwB;IACxB,MAAM,IAAA,4BAAiB,EAAC;QACtB,IAAI;QACJ,YAAY;QACZ,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC;QAClC,OAAO,EAAE,aAAa;QACtB,QAAQ,EAAE,cAAc;QACxB,IAAI;QACJ,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS;QACxE,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS;QACrE,SAAS,EACP,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;KAC1E,CAAC,CAAC;AACL,CAAC;AAED,IAAI,EAAE,CAAC"}