@transcend-io/cli 4.132.6 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +70 -0
- package/README.md +82 -53
- package/build/cli-manual-enrichment-pull-identifiers.js +6 -5
- package/build/cli-manual-enrichment-pull-identifiers.js.map +1 -1
- package/build/cli-request-export.js +3 -0
- package/build/cli-request-export.js.map +1 -1
- package/build/codecs.d.ts +241 -0
- package/build/codecs.d.ts.map +1 -1
- package/build/codecs.js +64 -1
- package/build/codecs.js.map +1 -1
- package/build/constants.d.ts.map +1 -1
- package/build/constants.js +6 -0
- package/build/constants.js.map +1 -1
- package/build/enums.d.ts +2 -0
- package/build/enums.d.ts.map +1 -1
- package/build/enums.js +2 -0
- package/build/enums.js.map +1 -1
- package/build/graphql/fetchAllActionItemCollections.d.ts +26 -0
- package/build/graphql/fetchAllActionItemCollections.d.ts.map +1 -0
- package/build/graphql/fetchAllActionItemCollections.js +22 -0
- package/build/graphql/fetchAllActionItemCollections.js.map +1 -0
- package/build/graphql/fetchAllActionItems.d.ts +98 -0
- package/build/graphql/fetchAllActionItems.d.ts.map +1 -0
- package/build/graphql/fetchAllActionItems.js +49 -0
- package/build/graphql/fetchAllActionItems.js.map +1 -0
- package/build/graphql/fetchAllRequestIdentifiers.d.ts +81 -15
- package/build/graphql/fetchAllRequestIdentifiers.d.ts.map +1 -1
- package/build/graphql/fetchAllRequestIdentifiers.js +67 -10
- package/build/graphql/fetchAllRequestIdentifiers.js.map +1 -1
- package/build/graphql/gqls/actionItem.d.ts +4 -0
- package/build/graphql/gqls/actionItem.d.ts.map +1 -0
- package/build/graphql/gqls/actionItem.js +69 -0
- package/build/graphql/gqls/actionItem.js.map +1 -0
- package/build/graphql/gqls/actionItemCollection.d.ts +4 -0
- package/build/graphql/gqls/actionItemCollection.d.ts.map +1 -0
- package/build/graphql/gqls/actionItemCollection.js +48 -0
- package/build/graphql/gqls/actionItemCollection.js.map +1 -0
- package/build/graphql/gqls/index.d.ts +3 -1
- package/build/graphql/gqls/index.d.ts.map +1 -1
- package/build/graphql/gqls/index.js +3 -1
- package/build/graphql/gqls/index.js.map +1 -1
- package/build/graphql/gqls/sombraVersion.d.ts +2 -0
- package/build/graphql/gqls/sombraVersion.d.ts.map +1 -0
- package/build/graphql/gqls/sombraVersion.js +14 -0
- package/build/graphql/gqls/sombraVersion.js.map +1 -0
- package/build/graphql/index.d.ts +3 -0
- package/build/graphql/index.d.ts.map +1 -1
- package/build/graphql/index.js +3 -0
- package/build/graphql/index.js.map +1 -1
- package/build/graphql/pullTranscendConfiguration.d.ts.map +1 -1
- package/build/graphql/pullTranscendConfiguration.js +38 -1
- package/build/graphql/pullTranscendConfiguration.js.map +1 -1
- package/build/graphql/syncActionItemCollections.d.ts +27 -0
- package/build/graphql/syncActionItemCollections.d.ts.map +1 -0
- package/build/graphql/syncActionItemCollections.js +97 -0
- package/build/graphql/syncActionItemCollections.js.map +1 -0
- package/build/graphql/syncActionItems.d.ts +30 -0
- package/build/graphql/syncActionItems.d.ts.map +1 -0
- package/build/graphql/syncActionItems.js +137 -0
- package/build/graphql/syncActionItems.js.map +1 -0
- package/build/graphql/syncConfigurationToTranscend.d.ts.map +1 -1
- package/build/graphql/syncConfigurationToTranscend.js +13 -1
- package/build/graphql/syncConfigurationToTranscend.js.map +1 -1
- package/build/manual-enrichment/pullManualEnrichmentIdentifiersToCsv.d.ts +4 -2
- package/build/manual-enrichment/pullManualEnrichmentIdentifiersToCsv.d.ts.map +1 -1
- package/build/manual-enrichment/pullManualEnrichmentIdentifiersToCsv.js +7 -6
- package/build/manual-enrichment/pullManualEnrichmentIdentifiersToCsv.js.map +1 -1
- package/build/requests/bulkRestartRequests.d.ts.map +1 -1
- package/build/requests/bulkRestartRequests.js +11 -11
- package/build/requests/bulkRestartRequests.js.map +1 -1
- package/build/requests/pullPrivacyRequests.d.ts +4 -2
- package/build/requests/pullPrivacyRequests.d.ts.map +1 -1
- package/build/requests/pullPrivacyRequests.js +6 -5
- package/build/requests/pullPrivacyRequests.js.map +1 -1
- package/build/tsbuildinfo +1 -1
- package/package.json +5 -3
- package/build/graphql/gqls/RequestIdentifier.d.ts +0 -2
- package/build/graphql/gqls/RequestIdentifier.d.ts.map +0 -1
- package/build/graphql/gqls/RequestIdentifier.js +0 -37
- package/build/graphql/gqls/RequestIdentifier.js.map +0 -1
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
2
|
+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
3
|
+
|
|
4
|
+
## Table of Contents
|
|
5
|
+
|
|
6
|
+
- [Changelog](#changelog)
|
|
7
|
+
- [[5.0.0] - 2024-04-23](#500---2024-04-23)
|
|
8
|
+
- [Changed](#changed)
|
|
9
|
+
|
|
10
|
+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
11
|
+
|
|
12
|
+
# Changelog
|
|
13
|
+
|
|
14
|
+
All notable changes to the Transcend CLI tools will be documented in this file.
|
|
15
|
+
|
|
16
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
17
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
18
|
+
|
|
19
|
+
## [5.0.0] - 2024-04-23
|
|
20
|
+
|
|
21
|
+
### Changed
|
|
22
|
+
|
|
23
|
+
- Added support for encrypted identifiers to `tr-manual-enricher-pull-identifiers` command.
|
|
24
|
+
|
|
25
|
+
- Now that this command is using Sombra to decrypt request identifiers, you may need to provide the `--sombraAuth` argument. It's required when using self-hosted Sombra, but not for multi-tenant.
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
Before:
|
|
29
|
+
yarn tr-manual-enricher-pull-identifiers --auth=$TRANSCEND_API_KEY \
|
|
30
|
+
--actions=ERASURE \
|
|
31
|
+
--file=/Users/michaelfarrell/Desktop/test.csv
|
|
32
|
+
|
|
33
|
+
Now:
|
|
34
|
+
yarn tr-manual-enricher-pull-identifiers --auth=$TRANSCEND_API_KEY \
|
|
35
|
+
--sombraAuth=$SOMBRA_INTERNAL_KEY \
|
|
36
|
+
--actions=ERASURE \
|
|
37
|
+
--file=/Users/michaelfarrell/Desktop/test.csv
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
- Added support for encrypted identifiers to `tr-request-export` command.
|
|
41
|
+
|
|
42
|
+
- Now that this command is using Sombra to decrypt request identifiers, you may need to provide the `--sombraAuth` argument. It's required when using self-hosted Sombra, but not for multi-tenant.
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
Before:
|
|
46
|
+
yarn tr-request-export --auth=$TRANSCEND_API_KEY \
|
|
47
|
+
--actions=ERASURE \
|
|
48
|
+
--file=/Users/michaelfarrell/Desktop/test.csv
|
|
49
|
+
|
|
50
|
+
Now:
|
|
51
|
+
yarn tr-request-export --auth=$TRANSCEND_API_KEY \
|
|
52
|
+
--sombraAuth=$SOMBRA_INTERNAL_KEY \
|
|
53
|
+
--actions=ERASURE \
|
|
54
|
+
--file=/Users/michaelfarrell/Desktop/test.csv
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
- Added support for encrypted identifiers to `tr-request-restart` command, used only when `--copyIdentifiers` argument is specified.
|
|
58
|
+
|
|
59
|
+
- Now that this command is using Sombra to decrypt request identifiers, you may need to provide the `--sombraAuth` argument. It's required only when using `--copyIdentifiers` AND self-hosted Sombra, but is otherwise not required.
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
Before:
|
|
63
|
+
yarn tr-request-restart --auth=$TRANSCEND_API_KEY \
|
|
64
|
+
--statuses=COMPILING,APPROVING --actions=ERASURE --copyIdentifiers=true
|
|
65
|
+
|
|
66
|
+
Now:
|
|
67
|
+
yarn tr-request-restart --auth=$TRANSCEND_API_KEY \
|
|
68
|
+
--sombraAuth=$SOMBRA_INTERNAL_KEY \
|
|
69
|
+
--statuses=COMPILING,APPROVING --actions=ERASURE --copyIdentifiers=true
|
|
70
|
+
```
|
package/README.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
## Table of Contents
|
|
5
5
|
|
|
6
|
+
- [Changelog](#changelog)
|
|
6
7
|
- [Overview](#overview)
|
|
7
8
|
- [Installation](#installation)
|
|
8
9
|
- [transcend.yml](#transcendyml)
|
|
@@ -138,6 +139,10 @@
|
|
|
138
139
|
|
|
139
140
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
140
141
|
|
|
142
|
+
## Changelog
|
|
143
|
+
|
|
144
|
+
To stay up to date on breaking changes to the cli between major version updates, please refer to [CHANGELOG.md](CHANGELOG.md).
|
|
145
|
+
|
|
141
146
|
## Overview
|
|
142
147
|
|
|
143
148
|
A command line interface that allows you to define your Data Map in code and sync that configuration back to https://app.transcend.io.
|
|
@@ -349,32 +354,34 @@ In order to use this cli, you will first need to generate an API key on the Tran
|
|
|
349
354
|
|
|
350
355
|
The API key permissions for this command vary based on the value to the `resources` argument. See the table below to understand the necessary permissions for the resources you are attempting to pull.
|
|
351
356
|
|
|
352
|
-
| Key
|
|
353
|
-
|
|
|
354
|
-
| apiKeys
|
|
355
|
-
|
|
|
356
|
-
|
|
|
357
|
-
|
|
|
358
|
-
|
|
|
359
|
-
|
|
|
360
|
-
|
|
|
361
|
-
|
|
|
362
|
-
|
|
|
363
|
-
|
|
|
364
|
-
|
|
|
365
|
-
|
|
|
366
|
-
|
|
|
367
|
-
|
|
|
368
|
-
|
|
|
369
|
-
|
|
|
370
|
-
|
|
|
371
|
-
|
|
|
372
|
-
|
|
|
373
|
-
|
|
|
374
|
-
|
|
|
375
|
-
|
|
|
376
|
-
|
|
|
377
|
-
|
|
|
357
|
+
| Key | Description | Scope | Is Default | Link |
|
|
358
|
+
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
359
|
+
| apiKeys | API Key definitions assigned to Data Silos. API keys cannot be created through the cli, but you can map API key usage to Data Silos. | View API Keys | true | [Developer Tools -> API keys](https://app.transcend.io/infrastructure/api-keys) |
|
|
360
|
+
| actionItems | Onboarding related action items | Read only | false | [Action Items](https://app.transcend.io/action-items/all) |
|
|
361
|
+
| actionItemCollections | Onboarding related action item group names | Read only | false | [Action Items](https://app.transcend.io/action-items/all) |
|
|
362
|
+
| templates | Email templates. Only template titles can be created and mapped to other resources. | View Email Templates | true | [DSR Automation -> Email Templates](https://app.transcend.io/privacy-requests/email-templates) |
|
|
363
|
+
| dataSilos | The Data Silo/Integration definitions. | View Data Map,View Data Subject Request Settings | true | [Data Inventory -> Data Silos](https://app.transcend.io/data-map/data-inventory/) and [Infrastucture -> Integrations](https://app.transcend.io/infrastructure/integrationsdata-silos) |
|
|
364
|
+
| enrichers | The Privacy Request enricher configurations. | View Identity Verification Settings | true | [DSR Automation -> Identifiers](https://app.transcend.io/privacy-requests/identifiers) |
|
|
365
|
+
| teams | Team definitions of users and scope groupings | View Scopes | false | [Administration -> Teams](https://app.transcend.io/admin/teams) |
|
|
366
|
+
| businessEntities | The business entities in the data inventory. | View Data Inventory | false | [Data Inventory -> Business Entities](https://app.transcend.io/data-map/data-inventory/business-entities) |
|
|
367
|
+
| identifiers | The Privacy Request identifier configurations. | View Identity Verification Settings | false | [DSR Automation -> Identifiers](https://app.transcend.io/privacy-requests/identifiers) |
|
|
368
|
+
| actions | The Privacy Request action settings. | View Data Subject Request Settings | false | [DSR Automation -> Request Settings](https://app.transcend.io/privacy-requests/settings) |
|
|
369
|
+
| dataSubjects | The Privacy Request data subject settings. | View Data Subject Request Settings | false | [DSR Automation -> Request Settings](https://app.transcend.io/privacy-requests/settings) |
|
|
370
|
+
| vendors | The vendors in the data inventory. | View Data Inventory | false | [Data Inventory -> Vendors](https://app.transcend.io/data-map/data-inventory/vendors) |
|
|
371
|
+
| dataCategories | The data categories in the data inventory. | View Data Inventory | false | [Data Inventory -> Data Categories](https://app.transcend.io/data-map/data-inventory/data-categories) |
|
|
372
|
+
| processingPurposes | The processing purposes in the data inventory. | View Data Inventory | false | [Data Inventory -> Processing Purposes](https://app.transcend.io/data-map/data-inventory/purposes) |
|
|
373
|
+
| customFields | Custom field definitions that define extra metadata for each table in the Admin Dashboard. | View Global Attributes | false | [Custom Fields](https://app.transcend.io/infrastructure/attributes) |
|
|
374
|
+
| dataFlows | Consent Manager Data Flow definitions. | View Data Flows | false | [Consent Management -> Data Flows](https://app.transcend.io/consent-manager/data-flows/approved) |
|
|
375
|
+
| cookies | Consent Manager Cookie definitions. | View Data Flows | false | [Consent Management -> Cookies](https://app.transcend.io/consent-manager/cookies/approved) |
|
|
376
|
+
| consentManager | Consent Manager general settings, including domain list. | View Consent Manager | false | [Consent Management -> Developer Settings](https://app.transcend.io/consent-manager/developer-settings) |
|
|
377
|
+
| assessments | The Transcend assessments | View Assessments | false | [Assessments -> Browse](https://app.transcend.io/assessments/browse) |
|
|
378
|
+
| assessmentTemplates | The Transcend assessment templates | View Assessments | false | [Assessments -> Templates](https://app.transcend.io/assessments/templates) |
|
|
379
|
+
| prompts | The Transcend AI prompts | View Prompts | false | [Prompt Manager -> Browse](https://app.transcend.io/prompts/browse) |
|
|
380
|
+
| promptPartials | The Transcend AI prompt partials | View Prompts | false | [Prompt Manager -> Partials](https://app.transcend.io/prompts/partialss) |
|
|
381
|
+
| promptGroups | The Transcend AI prompt groups | View Prompts | false | [Prompt Manager -> Groups](https://app.transcend.io/prompts/groups) |
|
|
382
|
+
| agents | The agents in the prompt manager. | View Prompts | false | [Prompt Manager -> Agents](https://app.transcend.io/prompts/agents) |
|
|
383
|
+
| agentFunctions | The agent functions in the prompt manager. | View Prompts | false | [Prompt Manager -> Agent Functions](https://app.transcend.io/prompts/agent-functions) |
|
|
384
|
+
| agentFiles | The agent files in the prompt manager. | View Prompts | false | [Prompt Manager -> Agent Files](https://app.transcend.io/prompts/agent-files) |
|
|
378
385
|
|
|
379
386
|
_Note: The scopes for tr-push are comprehensive of the scopes for tr-pull_
|
|
380
387
|
|
|
@@ -469,6 +476,12 @@ Pull in enrichers and identifiers (see [this example](./examples/enrichers.yml))
|
|
|
469
476
|
tr-pull --auth=$TRANSCEND_API_KEY --resources=enrichers,identifiers
|
|
470
477
|
```
|
|
471
478
|
|
|
479
|
+
Pull in onboarding action items (see [this example](./examples/action-items.yml)):
|
|
480
|
+
|
|
481
|
+
```sh
|
|
482
|
+
tr-pull --auth=$TRANSCEND_API_KEY --resources=actionItems,actionItemCollections
|
|
483
|
+
```
|
|
484
|
+
|
|
472
485
|
Pull in consent manager domain list (see [this example](./examples/consent-manager-domains.yml)):
|
|
473
486
|
|
|
474
487
|
```sh
|
|
@@ -543,32 +556,34 @@ In order to use this cli, you will first need to generate an API key on the Tran
|
|
|
543
556
|
|
|
544
557
|
The API key needs the following scopes when pushing the various resource types:
|
|
545
558
|
|
|
546
|
-
| Key
|
|
547
|
-
|
|
|
548
|
-
| apiKeys
|
|
549
|
-
|
|
|
550
|
-
|
|
|
551
|
-
|
|
|
552
|
-
|
|
|
553
|
-
|
|
|
554
|
-
|
|
|
555
|
-
|
|
|
556
|
-
|
|
|
557
|
-
|
|
|
558
|
-
|
|
|
559
|
-
|
|
|
560
|
-
|
|
|
561
|
-
|
|
|
562
|
-
|
|
|
563
|
-
|
|
|
564
|
-
|
|
|
565
|
-
|
|
|
566
|
-
|
|
|
567
|
-
|
|
|
568
|
-
|
|
|
569
|
-
|
|
|
570
|
-
|
|
|
571
|
-
|
|
|
559
|
+
| Key | Description | Scope | Is Default | Link |
|
|
560
|
+
| --------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
561
|
+
| apiKeys | API Key definitions. API keys cannot be created through the cli, but you can map API key usage to Data Silos. | View API Keys | true | [Developer Tools -> API keys](https://app.transcend.io/infrastructure/api-keys) |
|
|
562
|
+
| actionItems | Onboarding related action items | Manage Action Item Collections | false | [Action Items](https://app.transcend.io/action-items/all) |
|
|
563
|
+
| actionItemCollections | Onboarding related action item group names | Manage All Action Items | false | [Action Items](https://app.transcend.io/action-items/all) |
|
|
564
|
+
| templates | Email templates. Only template titles can be created and mapped to other resources. | Manage Email Templates | true | [DSR Automation -> Email Templates](https://app.transcend.io/privacy-requests/email-templates) |
|
|
565
|
+
| dataSilos | The Data Silo/Integration definitions. | Manage Data Map,Connect Data Silos | true | [Data Inventory -> Data Silos](https://app.transcend.io/data-map/data-inventory/) and [Infrastucture -> Integrations](https://app.transcend.io/infrastructure/integrationsdata-silos) |
|
|
566
|
+
| enrichers | The Privacy Request enricher configurations. | Manage Request Identity Verification | true | [DSR Automation -> Identifiers](https://app.transcend.io/privacy-requests/identifiers) |
|
|
567
|
+
| teams | The team definitions containing scopes and users | Manage Access Control | false | [Administration -> Teams](https://app.transcend.io/admin/teams) |
|
|
568
|
+
| businessEntities | The business entities in the data inventory. | Manage Data Inventory | false | [Data Inventory -> Business Entities](https://app.transcend.io/data-map/data-inventory/business-entities) |
|
|
569
|
+
| identifiers | The Privacy Request identifier configurations. | Manage Request Identity Verification | false | [DSR Automation -> Identifiers](https://app.transcend.io/privacy-requests/identifiers) |
|
|
570
|
+
| actions | The Privacy Request action settings. | Manage Data Subject Request Settings | false | [DSR Automation -> Request Settings](https://app.transcend.io/privacy-requests/settings) |
|
|
571
|
+
| dataSubjects | The Privacy Request data subject settings. | Manage Data Subject Request Settings | false | [DSR Automation -> Request Settings](https://app.transcend.io/privacy-requests/settings) |
|
|
572
|
+
| vendors | The vendors in the data inventory. | Manage Data Inventory | false | [Data Inventory -> Vendors](https://app.transcend.io/data-map/data-inventory/vendors) |
|
|
573
|
+
| dataCategories | The data categories in the data inventory. | Manage Data Inventory | false | [Data Inventory -> Data Categories](https://app.transcend.io/data-map/data-inventory/data-categories) |
|
|
574
|
+
| processingPurposes | The processing purposes in the data inventory. | Manage Data Inventory | false | [Data Inventory -> Processing Purposes](https://app.transcend.io/data-map/data-inventory/purposes) |
|
|
575
|
+
| attributes | Attribute definitions that define extra metadata for each table in the Admin Dashboard. | Manage Global Attributes | false | [Infrastructure -> Attributes](https://app.transcend.io/infrastructure/attributes) |
|
|
576
|
+
| dataFlows | Consent Manager Data Flow definitions. | Manage Data Flows | false | [Consent Management -> Data Flows](https://app.transcend.io/consent-manager/data-flows/approved) |
|
|
577
|
+
| cookies | Consent Manager Cookie definitions. | Manage Data Flows | false | [Consent Management -> Cookies](https://app.transcend.io/consent-manager/cookies/approved) |
|
|
578
|
+
| consentManager | Consent Manager general settings, including domain list. | Manage Consent Manager Developer Settings | false | [Consent Management -> Developer Settings](https://app.transcend.io/consent-manager/developer-settings) |
|
|
579
|
+
| assessments | The Transcend assessments | Manage Assessments | false | [Assessments -> Browse](https://app.transcend.io/assessments/browse) |
|
|
580
|
+
| assessmentTemplates | The Transcend assessment templates | Manage Assessments | false | [Assessments -> Templates](https://app.transcend.io/assessments/templates) |
|
|
581
|
+
| prompts | The Transcend AI prompts | View Prompts | false | [Prompt Manager -> Browse](https://app.transcend.io/prompts/browse) |
|
|
582
|
+
| promptPartials | The Transcend AI prompt partials | Manage Prompts | false | [Prompt Manager -> Partials](https://app.transcend.io/prompts/partialss) |
|
|
583
|
+
| promptGroups | The Transcend AI prompt groups | Manage Prompts | false | [Prompt Manager -> Groups](https://app.transcend.io/prompts/groups) |
|
|
584
|
+
| agents | The agents in the prompt manager. | Manage Prompts | false | [Prompt Manager -> Agents](https://app.transcend.io/prompts/agents) |
|
|
585
|
+
| agentFunctions | The agent functions in the prompt manager. | Manage Prompts | false | [Prompt Manager -> Agent Functions](https://app.transcend.io/prompts/agent-functions) |
|
|
586
|
+
| agentFiles | The agent files in the prompt manager. | Manage Prompts | false | [Prompt Manager -> Agent Files](https://app.transcend.io/prompts/agent-files) |
|
|
572
587
|
|
|
573
588
|
#### Arguments
|
|
574
589
|
|
|
@@ -1262,7 +1277,7 @@ The API key needs the following scopes:
|
|
|
1262
1277
|
| statuses | The [request statuses](https://docs.transcend.io/docs/privacy-requests/overview#request-statuses) to restart. | RequestStatus[] | N/A | true |
|
|
1263
1278
|
| transcendUrl | URL of the Transcend backend. Use https://api.us.transcend.io for US hosting. | string - URL | https://api.transcend.io | false |
|
|
1264
1279
|
| requestReceiptFolder | The path to the folder where receipts of each upload are stored. This allows for debugging of errors. | string | ./privacy-request-upload-receipts | false |
|
|
1265
|
-
| sombraAuth | The sombra internal key, use for additional authentication when self-hosting sombra.
|
|
1280
|
+
| sombraAuth | The sombra internal key, use for additional authentication when self-hosting sombra. Only required when `copyIdentifiers` flag used. | string | N/A | false |
|
|
1266
1281
|
| concurrency | The concurrency to use when uploading requests in parallel. | number | 15 | false |
|
|
1267
1282
|
| requestIds | Specify the specific request IDs to restart | string[] | [] | false |
|
|
1268
1283
|
| emailIsVerified | Indicate whether the primary email address is verified. Set to false to send a verification email. | boolean | true | false |
|
|
@@ -1365,6 +1380,7 @@ The API key needs the following scopes:
|
|
|
1365
1380
|
| Argument | Description | Type | Default | Required |
|
|
1366
1381
|
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------------ | -------- |
|
|
1367
1382
|
| auth | The Transcend API key with the scopes necessary for the command. | string | N/A | true |
|
|
1383
|
+
| sombraAuth | The sombra internal key, use for additional authentication when self-hosting sombra. | string | N/A | false |
|
|
1368
1384
|
| actions | The [request action](https://docs.transcend.io/docs/privacy-requests/configuring-requests/data-subject-requests#data-actions) to restart. | RequestAction[] | N/A | false |
|
|
1369
1385
|
| statuses | The [request statuses](https://docs.transcend.io/docs/privacy-requests/overview#request-statuses) to restart. | RequestStatus[] | N/A | false |
|
|
1370
1386
|
| transcendUrl | URL of the Transcend backend. Use https://api.us.transcend.io for US hosting. | string - URL | https://api.transcend.io | false |
|
|
@@ -1394,6 +1410,12 @@ Specifying the backend URL, needed for US hosted backend infrastructure.
|
|
|
1394
1410
|
yarn tr-request-export --auth=$TRANSCEND_API_KEY --transcendUrl=https://api.us.transcend.io
|
|
1395
1411
|
```
|
|
1396
1412
|
|
|
1413
|
+
With Sombra authentication
|
|
1414
|
+
|
|
1415
|
+
```sh
|
|
1416
|
+
yarn tr-request-export --auth=$TRANSCEND_API_KEY --sombraAuth=$SOMBRA_INTERNAL_KEY
|
|
1417
|
+
```
|
|
1418
|
+
|
|
1397
1419
|
Increase the concurrency (defaults to 100)
|
|
1398
1420
|
|
|
1399
1421
|
```sh
|
|
@@ -1561,6 +1583,7 @@ The API key must have the following scopes:
|
|
|
1561
1583
|
| Argument | Description | Type | Default | Required |
|
|
1562
1584
|
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ----------------------------------- | -------- |
|
|
1563
1585
|
| auth | The Transcend API key with the scopes necessary for the command. | string | N/A | true |
|
|
1586
|
+
| sombraAuth | The sombra internal key, use for additional authentication when self-hosting sombra. | string | N/A | false |
|
|
1564
1587
|
| transcendUrl | URL of the Transcend backend. Use https://api.us.transcend.io for US hosting. | string - URL | https://api.transcend.io | false |
|
|
1565
1588
|
| file | Path to the CSV file where requests will be written to. | string - file-path | ./manual-enrichment-identifiers.csv | false |
|
|
1566
1589
|
| actions | The [request action](https://docs.transcend.io/docs/privacy-requests/configuring-requests/data-subject-requests#data-actions) to pull for. | RequestAction[] | N/A | false |
|
|
@@ -1591,6 +1614,12 @@ For US hosted infrastructure
|
|
|
1591
1614
|
yarn tr-manual-enrichment-pull-identifiers --auth=$TRANSCEND_API_KEY --transcendUrl=https://api.us.transcend.io
|
|
1592
1615
|
```
|
|
1593
1616
|
|
|
1617
|
+
With Sombra authentication
|
|
1618
|
+
|
|
1619
|
+
```sh
|
|
1620
|
+
yarn tr-manual-enrichment-pull-identifiers --auth=$TRANSCEND_API_KEY --sombraAuth=$SOMBRA_INTERNAL_KEY
|
|
1621
|
+
```
|
|
1622
|
+
|
|
1594
1623
|
With specific concurrency
|
|
1595
1624
|
|
|
1596
1625
|
```sh
|
|
@@ -4,12 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
4
4
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
5
5
|
};
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
const yargs_parser_1 = __importDefault(require("yargs-parser"));
|
|
8
7
|
const colors_1 = __importDefault(require("colors"));
|
|
9
|
-
const
|
|
10
|
-
const manual_enrichment_1 = require("./manual-enrichment");
|
|
8
|
+
const yargs_parser_1 = __importDefault(require("yargs-parser"));
|
|
11
9
|
const privacy_types_1 = require("@transcend-io/privacy-types");
|
|
12
10
|
const constants_1 = require("./constants");
|
|
11
|
+
const logger_1 = require("./logger");
|
|
12
|
+
const manual_enrichment_1 = require("./manual-enrichment");
|
|
13
13
|
/**
|
|
14
14
|
* Pull the the set of requests that actively require manual enrichment.
|
|
15
15
|
*
|
|
@@ -27,8 +27,8 @@ const constants_1 = require("./constants");
|
|
|
27
27
|
*/
|
|
28
28
|
async function main() {
|
|
29
29
|
// Parse command line arguments
|
|
30
|
-
const { file = './manual-enrichment-identifiers.csv', transcendUrl = constants_1.DEFAULT_TRANSCEND_API, auth, actions = '', concurrency = '100', } = (0, yargs_parser_1.default)(process.argv.slice(2));
|
|
31
|
-
// Ensure auth is
|
|
30
|
+
const { file = './manual-enrichment-identifiers.csv', transcendUrl = constants_1.DEFAULT_TRANSCEND_API, auth, sombraAuth, actions = '', concurrency = '100', } = (0, yargs_parser_1.default)(process.argv.slice(2));
|
|
31
|
+
// Ensure auth is provided
|
|
32
32
|
if (!auth) {
|
|
33
33
|
logger_1.logger.error(colors_1.default.red('A Transcend API key must be provided. You can specify using --auth=$TRANSCEND_API_KEY'));
|
|
34
34
|
process.exit(1);
|
|
@@ -49,6 +49,7 @@ async function main() {
|
|
|
49
49
|
concurrency: parseInt(concurrency, 10),
|
|
50
50
|
requestActions,
|
|
51
51
|
auth,
|
|
52
|
+
sombraAuth,
|
|
52
53
|
});
|
|
53
54
|
}
|
|
54
55
|
main();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli-manual-enrichment-pull-identifiers.js","sourceRoot":"","sources":["../src/cli-manual-enrichment-pull-identifiers.ts"],"names":[],"mappings":";;;;;;AAEA,gEAAiC;
|
|
1
|
+
{"version":3,"file":"cli-manual-enrichment-pull-identifiers.js","sourceRoot":"","sources":["../src/cli-manual-enrichment-pull-identifiers.ts"],"names":[],"mappings":";;;;;;AAEA,oDAA4B;AAC5B,gEAAiC;AAEjC,+DAA4D;AAC5D,2CAAoD;AACpD,qCAAkC;AAClC,2DAA2E;AAE3E;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,IAAI;IACjB,+BAA+B;IAC/B,MAAM,EACJ,IAAI,GAAG,qCAAqC,EAC5C,YAAY,GAAG,iCAAqB,EACpC,IAAI,EACJ,UAAU,EACV,OAAO,GAAG,EAAE,EACZ,WAAW,GAAG,KAAK,GACpB,GAAG,IAAA,sBAAK,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAA8B,CAAC;IAE9D,0BAA0B;IAC1B,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,mBAAmB;IACnB,MAAM,cAAc,GAAG,OAAO;SAC3B,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAoB,CAAC;IACzC,MAAM,cAAc,GAAG,cAAc,CAAC,MAAM,CAC1C,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAC3D,CAAC;IACF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;QAC7B,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,oCAAoC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAChE,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,qCAAqC;IACrC,MAAM,IAAA,wDAAoC,EAAC;QACzC,IAAI;QACJ,YAAY;QACZ,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;QACtC,cAAc;QACd,IAAI;QACJ,UAAU;KACX,CAAC,CAAC;AACL,CAAC;AAED,IAAI,EAAE,CAAC"}
|
|
@@ -36,6 +36,8 @@ async function main() {
|
|
|
36
36
|
transcendUrl = constants_1.DEFAULT_TRANSCEND_API,
|
|
37
37
|
/** API key */
|
|
38
38
|
auth,
|
|
39
|
+
/** Sombra API key */
|
|
40
|
+
sombraAuth,
|
|
39
41
|
/** Request actions to export */
|
|
40
42
|
actions = '',
|
|
41
43
|
/** Request statuses to export */
|
|
@@ -80,6 +82,7 @@ async function main() {
|
|
|
80
82
|
actions: parsedActions,
|
|
81
83
|
statuses: parsedStatuses,
|
|
82
84
|
auth,
|
|
85
|
+
sombraAuth,
|
|
83
86
|
createdAtBefore: createdAtBefore ? new Date(createdAtBefore) : undefined,
|
|
84
87
|
createdAtAfter: createdAtAfter ? new Date(createdAtAfter) : undefined,
|
|
85
88
|
isTest: showTests === 'true' ? true : showTests === 'false' ? false : undefined,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli-request-export.js","sourceRoot":"","sources":["../src/cli-request-export.ts"],"names":[],"mappings":";;;;;;AAEA,gEAAiC;AACjC,oDAA4B;AAE5B,qCAAkC;AAClC,uDAA+B;AAC/B,+DAA2E;AAC3E,yCAAiE;AACjE,2CAAoD;AACpD,iCAAkC;AAElC;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,IAAI;IACjB,+BAA+B;IAC/B,MAAM,EACJ,IAAI,GAAG,gCAAgC;IACvC,4BAA4B;IAC5B,YAAY,GAAG,iCAAqB;IACpC,cAAc;IACd,IAAI;IACJ,gCAAgC;IAChC,OAAO,GAAG,EAAE;IACZ,iCAAiC;IACjC,QAAQ,GAAG,EAAE;IACb,8CAA8C;IAC9C,SAAS;IACT,kDAAkD;IAClD,eAAe;IACf,iDAAiD;IACjD,cAAc;IACd,iCAAiC;IACjC,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,uFAAuF,CACxF,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;
|
|
1
|
+
{"version":3,"file":"cli-request-export.js","sourceRoot":"","sources":["../src/cli-request-export.ts"],"names":[],"mappings":";;;;;;AAEA,gEAAiC;AACjC,oDAA4B;AAE5B,qCAAkC;AAClC,uDAA+B;AAC/B,+DAA2E;AAC3E,yCAAiE;AACjE,2CAAoD;AACpD,iCAAkC;AAElC;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,IAAI;IACjB,+BAA+B;IAC/B,MAAM,EACJ,IAAI,GAAG,gCAAgC;IACvC,4BAA4B;IAC5B,YAAY,GAAG,iCAAqB;IACpC,cAAc;IACd,IAAI;IACJ,qBAAqB;IACrB,UAAU;IACV,gCAAgC;IAChC,OAAO,GAAG,EAAE;IACZ,iCAAiC;IACjC,QAAQ,GAAG,EAAE;IACb,8CAA8C;IAC9C,SAAS;IACT,kDAAkD;IAClD,eAAe;IACf,iDAAiD;IACjD,cAAc;IACd,iCAAiC;IACjC,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,uFAAuF,CACxF,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;YAC1D,sBAAsB,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAChE,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;YAC5D,sBAAsB,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAChE,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,wBAAwB;IACxB,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,IAAA,8BAAmB,EAAC;QAC5D,YAAY;QACZ,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC;QAClC,OAAO,EAAE,aAAa;QACtB,QAAQ,EAAE,cAAc;QACxB,IAAI;QACJ,UAAU;QACV,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,MAAM,EACJ,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;KAC1E,CAAC,CAAC;IAEH,eAAe;IACf,MAAM,OAAO,GAAG,IAAA,cAAI,EAClB,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAC1D,CAAC;IACF,IAAA,eAAQ,EAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACjD,eAAM,CAAC,IAAI,CACT,gBAAM,CAAC,KAAK,CACV,sBAAsB,uBAAuB,CAAC,MAAM,sBAAsB,IAAI,GAAG,CAClF,CACF,CAAC;AACJ,CAAC;AAED,IAAI,EAAE,CAAC"}
|