@transcend-io/cli 6.22.1 → 6.24.0

package/README.md

@@ -90,71 +90,75 @@
     - [Authentication](#authentication-19)
     - [Arguments](#arguments-19)
     - [Usage](#usage-20)
-  - [tr-retry-request-data-silos](#tr-retry-request-data-silos)
+  - [tr-skip-preflight-jobs](#tr-skip-preflight-jobs)
     - [Authentication](#authentication-20)
     - [Arguments](#arguments-20)
     - [Usage](#usage-21)
-  - [tr-update-consent-manager](#tr-update-consent-manager)
+  - [tr-retry-request-data-silos](#tr-retry-request-data-silos)
     - [Authentication](#authentication-21)
     - [Arguments](#arguments-21)
     - [Usage](#usage-22)
-  - [tr-consent-managers-to-business-entities](#tr-consent-managers-to-business-entities)
+  - [tr-update-consent-manager](#tr-update-consent-manager)
     - [Authentication](#authentication-22)
     - [Arguments](#arguments-22)
     - [Usage](#usage-23)
-  - [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-23)
     - [Arguments](#arguments-23)
     - [Usage](#usage-24)
-  - [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-24)
     - [Arguments](#arguments-24)
     - [Usage](#usage-25)
-  - [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-25)
     - [Arguments](#arguments-25)
     - [Usage](#usage-26)
-  - [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-26)
     - [Arguments](#arguments-26)
     - [Usage](#usage-27)
-  - [tr-pull-datapoints](#tr-pull-datapoints)
+  - [tr-pull-consent-metrics](#tr-pull-consent-metrics)
     - [Authentication](#authentication-27)
     - [Arguments](#arguments-27)
     - [Usage](#usage-28)
-  - [tr-pull-pull-unstructured-discovery-files](#tr-pull-pull-unstructured-discovery-files)
+  - [tr-pull-datapoints](#tr-pull-datapoints)
     - [Authentication](#authentication-28)
     - [Arguments](#arguments-28)
     - [Usage](#usage-29)
-  - [tr-upload-preferences](#tr-upload-preferences)
+  - [tr-pull-pull-unstructured-discovery-files](#tr-pull-pull-unstructured-discovery-files)
     - [Authentication](#authentication-29)
-    - [Authentication](#authentication-30)
     - [Arguments](#arguments-29)
     - [Usage](#usage-30)
-  - [tr-upload-consent-preferences](#tr-upload-consent-preferences)
+  - [tr-upload-preferences](#tr-upload-preferences)
+    - [Authentication](#authentication-30)
     - [Authentication](#authentication-31)
     - [Arguments](#arguments-30)
     - [Usage](#usage-31)
-  - [tr-pull-consent-preferences](#tr-pull-consent-preferences)
+  - [tr-upload-consent-preferences](#tr-upload-consent-preferences)
     - [Authentication](#authentication-32)
     - [Arguments](#arguments-31)
     - [Usage](#usage-32)
-  - [tr-upload-data-flows-from-csv](#tr-upload-data-flows-from-csv)
+  - [tr-pull-consent-preferences](#tr-pull-consent-preferences)
     - [Authentication](#authentication-33)
     - [Arguments](#arguments-32)
     - [Usage](#usage-33)
-  - [tr-upload-cookies-from-csv](#tr-upload-cookies-from-csv)
+  - [tr-upload-data-flows-from-csv](#tr-upload-data-flows-from-csv)
     - [Authentication](#authentication-34)
     - [Arguments](#arguments-33)
     - [Usage](#usage-34)
-  - [tr-generate-api-keys](#tr-generate-api-keys)
+  - [tr-upload-cookies-from-csv](#tr-upload-cookies-from-csv)
     - [Authentication](#authentication-35)
     - [Arguments](#arguments-34)
     - [Usage](#usage-35)
-  - [tr-build-xdi-sync-endpoint](#tr-build-xdi-sync-endpoint)
+  - [tr-generate-api-keys](#tr-generate-api-keys)
     - [Authentication](#authentication-36)
     - [Arguments](#arguments-35)
     - [Usage](#usage-36)
+  - [tr-build-xdi-sync-endpoint](#tr-build-xdi-sync-endpoint)
+    - [Authentication](#authentication-37)
+    - [Arguments](#arguments-36)
+    - [Usage](#usage-37)
 - [Prompt Manager](#prompt-manager)
 - [Proxy usage](#proxy-usage)
 
@@ -1995,6 +1999,39 @@ Set to status "RESOLVED" instead of status "SKIPPED"
 yarn tr-skip-request-data-silos --auth=$TRANSCEND_API_KEY --dataSiloId=70810f2e-cf90-43f6-9776-901a5950599f --status=RESOLVED
 ```
 
+### tr-skip-preflight-jobs
+
+This command allows for bulk skipping preflight checks.
+
+#### 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 must have the following scopes:
+
+- "Manage Request Compilation"
+
+#### Arguments
+
+| Argument     | Description                                                                   | Type            | Default                  | Required |
+| ------------ | ----------------------------------------------------------------------------- | --------------- | ------------------------ | -------- |
+| auth         | The Transcend API key with the scopes necessary for the command.              | string          | N/A                      | true     |
+| enricherIds  | The ID of the enrichers to skip privacy request jobs for.                     | string[] - UUID | N/A                      | true     |
+| transcendUrl | URL of the Transcend backend. Use https://api.us.transcend.io for US hosting. | string - URL    | https://api.transcend.io | false    |
+
+#### Usage
+
+```sh
+yarn tr-skip-preflight-jobs --auth=$TRANSCEND_API_KEY --enricherIds=70810f2e-cf90-43f6-9776-901a5950599f
+```
+
+Specifying the backend URL, needed for US hosted backend infrastructure.
+
+```sh
+yarn tr-skip-preflight-jobs --auth=$TRANSCEND_API_KEY --enricherIds=70810f2e-cf90-43f6-9776-901a5950599f,db1e64ba-cea6-43ff-ad27-5dc8122e5224 \
+ --transcendUrl=https://api.us.transcend.io
+```
+
 ### tr-retry-request-data-silos
 
 This command allows for bulk restarting a set of data silos jobs for open privacy requests. This is equivalent to clicking the "Wipe and Retry" button for a particular data silo across a set of privacy requests.

package/build/cli-skip-preflight-jobs.d.ts

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

package/build/cli-skip-preflight-jobs.d.ts.map

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

package/build/cli-skip-preflight-jobs.js

@@ -0,0 +1,53 @@
+#!/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 requests_1 = require("./requests");
+const constants_1 = require("./constants");
+/**
+ * Given an enricher ID, skip all active enrichment jobs that are open for that enricher
+ *
+ * Requires an API key with scope:
+ * - "Manage Request Compilation"
+ *
+ * Dev Usage:
+ * yarn ts-node ./src/cli-skip-preflight-jobs.ts --auth=$TRANSCEND_API_KEY \
+ *   --enricherIds=92636cda-b7c6-48c6-b1b1-2df574596cbc
+ *
+ * Standard usage:
+ * yarn tr-skip-request-data-silos --auth=$TRANSCEND_API_KEY  \
+ *   --enricherIds=92636cda-b7c6-48c6-b1b1-2df574596cbc
+ */
+async function main() {
+    // Parse command line arguments
+    const { 
+    /** Transcend Backend URL */
+    transcendUrl = constants_1.DEFAULT_TRANSCEND_API, 
+    /** API key */
+    auth, 
+    /** Enricher ID to mark requests fpr */
+    enricherIds, } = (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=$TRANSCEND_API_KEY'));
+        process.exit(1);
+    }
+    // Ensure enricherIds is provided
+    if (!enricherIds) {
+        logger_1.logger.error(colors_1.default.red('An enricher ID must be provided. You can specify using --enricherIds=2560bb81-b837-4c6f-a57e-dcef87069d43'));
+        process.exit(1);
+    }
+    // Upload privacy requests
+    await (0, requests_1.skipPreflightJobs)({
+        transcendUrl,
+        auth,
+        enricherIds: (0, requests_1.splitCsvToList)(enricherIds),
+    });
+}
+main();
+//# sourceMappingURL=cli-skip-preflight-jobs.js.map

package/build/cli-skip-preflight-jobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-skip-preflight-jobs.js","sourceRoot":"","sources":["../src/cli-skip-preflight-jobs.ts"],"names":[],"mappings":";;;;;;AAEA,gEAAiC;AACjC,oDAA4B;AAE5B,qCAAkC;AAClC,yCAA+D;AAC/D,2CAAoD;AAEpD;;;;;;;;;;;;;GAaG;AACH,KAAK,UAAU,IAAI;IACjB,+BAA+B;IAC/B,MAAM;IACJ,4BAA4B;IAC5B,YAAY,GAAG,iCAAqB;IACpC,cAAc;IACd,IAAI;IACJ,uCAAuC;IACvC,WAAW,GACZ,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,uFAAuF,CACxF,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,iCAAiC;IACjC,IAAI,CAAC,WAAW,EAAE;QAChB,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,2GAA2G,CAC5G,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,0BAA0B;IAC1B,MAAM,IAAA,4BAAiB,EAAC;QACtB,YAAY;QACZ,IAAI;QACJ,WAAW,EAAE,IAAA,yBAAc,EAAC,WAAW,CAAC;KACzC,CAAC,CAAC;AACL,CAAC;AACD,IAAI,EAAE,CAAC"}

package/build/codecs.d.ts

@@ -46973,6 +46973,10 @@ export declare const DataSiloInput: t.IntersectionC<[t.TypeC<{
         /** Attribute values */
         values: t.ArrayC<t.StringC>;
     }>>;
+    /**
+     * The business entities associated with this data silo
+     */
+    businessEntityTitles: t.ArrayC<t.StringC>;
 }>]>;
 /** Type override */
 export type DataSiloInput = t.TypeOf<typeof DataSiloInput>;
@@ -81703,6 +81707,10 @@ export declare const TranscendInput: t.PartialC<{
             /** Attribute values */
             values: t.ArrayC<t.StringC>;
         }>>;
+        /**
+         * The business entities associated with this data silo
+         */
+        businessEntityTitles: t.ArrayC<t.StringC>;
     }>]>>;
     /**
      * Data flow definitions