@transcend-io/cli 4.116.0 → 4.117.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/README.md +44 -46
- package/build/codecs.d.ts +0 -24
- package/build/codecs.d.ts.map +1 -1
- package/build/codecs.js +1 -14
- package/build/codecs.js.map +1 -1
- package/build/constants.d.ts.map +1 -1
- package/build/constants.js +0 -2
- package/build/constants.js.map +1 -1
- package/build/enums.d.ts +0 -1
- package/build/enums.d.ts.map +1 -1
- package/build/enums.js +0 -1
- package/build/enums.js.map +1 -1
- package/build/graphql/gqls/prompt.d.ts +0 -3
- package/build/graphql/gqls/prompt.d.ts.map +1 -1
- package/build/graphql/gqls/prompt.js +1 -38
- package/build/graphql/gqls/prompt.js.map +1 -1
- package/build/graphql/pullTranscendConfiguration.d.ts.map +1 -1
- package/build/graphql/pullTranscendConfiguration.js +1 -13
- package/build/graphql/pullTranscendConfiguration.js.map +1 -1
- package/build/graphql/syncAttribute.js +1 -1
- package/build/graphql/syncAttribute.js.map +1 -1
- package/build/graphql/syncConfigurationToTranscend.d.ts.map +1 -1
- package/build/graphql/syncConfigurationToTranscend.js +1 -6
- package/build/graphql/syncConfigurationToTranscend.js.map +1 -1
- package/build/tsbuildinfo +1 -1
- package/package.json +2 -2
- package/build/graphql/fetchPromptTemplates.d.ts +0 -17
- package/build/graphql/fetchPromptTemplates.d.ts.map +0 -1
- package/build/graphql/fetchPromptTemplates.js +0 -32
- package/build/graphql/fetchPromptTemplates.js.map +0 -1
- package/build/graphql/syncPromptTemplates.d.ts +0 -32
- package/build/graphql/syncPromptTemplates.d.ts.map +0 -1
- package/build/graphql/syncPromptTemplates.js +0 -102
- package/build/graphql/syncPromptTemplates.js.map +0 -1
package/README.md
CHANGED
|
@@ -337,26 +337,25 @@ In order to use this cli, you will first need to generate an API key on the Tran
|
|
|
337
337
|
|
|
338
338
|
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.
|
|
339
339
|
|
|
340
|
-
| Key | Description | Scope | Is Default | Link
|
|
341
|
-
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | ---------- |
|
|
342
|
-
| 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 | [
|
|
343
|
-
| templates | Email templates. Only template titles can be created and mapped to other resources. | View Email Templates | true | [
|
|
344
|
-
| dataSilos | The Data Silo/Integration definitions. | View Data Map,View Data Subject Request Settings | true | [Data
|
|
345
|
-
| enrichers | The Privacy Request enricher configurations. | View Identity Verification Settings | true | [
|
|
346
|
-
| businessEntities | The business entities in the data inventory. | View Data Inventory | false | [Data
|
|
347
|
-
| identifiers | The Privacy Request identifier configurations. | View Identity Verification Settings | false | [
|
|
348
|
-
| actions | The Privacy Request action settings. | View Data Subject Request Settings | false | [
|
|
349
|
-
| dataSubjects | The Privacy Request data subject settings. | View Data Subject Request Settings | false | [
|
|
350
|
-
|
|
|
351
|
-
| dataFlows | Consent Manager Data Flow definitions. | View Data Flows | false | [Consent
|
|
352
|
-
| cookies | Consent Manager Cookie definitions. | View Data Flows | false | [Consent
|
|
353
|
-
| consentManager | Consent Manager general settings, including domain list. | View Consent Manager | false | [Consent
|
|
354
|
-
| assessments | The Transcend assessments | View Assessments | false | [Assessments -> Browse](https://app.transcend.io/assessments/browse)
|
|
355
|
-
| assessmentTemplates | The Transcend assessment templates | View Assessments | false | [Assessments -> Templates](https://app.transcend.io/assessments/templates)
|
|
356
|
-
| prompts | The Transcend AI prompts | View Prompts | false | [Prompt Manager -> Browse](https://app.transcend.io/prompts/browse)
|
|
357
|
-
|
|
|
358
|
-
|
|
|
359
|
-
| promptGroups | The Transcend AI prompt groups | View Prompts | false | [Prompt Manager -> Groups](https://app.transcend.io/prompts/groups) |
|
|
340
|
+
| Key | Description | Scope | Is Default | Link |
|
|
341
|
+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
342
|
+
| 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) |
|
|
343
|
+
| 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) |
|
|
344
|
+
| 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) |
|
|
345
|
+
| enrichers | The Privacy Request enricher configurations. | View Identity Verification Settings | true | [DSR Automation -> Identifiers](https://app.transcend.io/privacy-requests/identifiers) |
|
|
346
|
+
| 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) |
|
|
347
|
+
| identifiers | The Privacy Request identifier configurations. | View Identity Verification Settings | false | [DSR Automation -> Identifiers](https://app.transcend.io/privacy-requests/identifiers) |
|
|
348
|
+
| actions | The Privacy Request action settings. | View Data Subject Request Settings | false | [DSR Automation -> Request Settings](https://app.transcend.io/privacy-requests/settings) |
|
|
349
|
+
| dataSubjects | The Privacy Request data subject settings. | View Data Subject Request Settings | false | [DSR Automation -> Request Settings](https://app.transcend.io/privacy-requests/settings) |
|
|
350
|
+
| 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) |
|
|
351
|
+
| dataFlows | Consent Manager Data Flow definitions. | View Data Flows | false | [Consent Management -> Data Flows](https://app.transcend.io/consent-manager/data-flows/approved) |
|
|
352
|
+
| cookies | Consent Manager Cookie definitions. | View Data Flows | false | [Consent Management -> Cookies](https://app.transcend.io/consent-manager/cookies/approved) |
|
|
353
|
+
| consentManager | Consent Manager general settings, including domain list. | View Consent Manager | false | [Consent Management -> Developer Settings](https://app.transcend.io/consent-manager/developer-settings) |
|
|
354
|
+
| assessments | The Transcend assessments | View Assessments | false | [Assessments -> Browse](https://app.transcend.io/assessments/browse) |
|
|
355
|
+
| assessmentTemplates | The Transcend assessment templates | View Assessments | false | [Assessments -> Templates](https://app.transcend.io/assessments/templates) |
|
|
356
|
+
| prompts | The Transcend AI prompts | View Prompts | false | [Prompt Manager -> Browse](https://app.transcend.io/prompts/browse) |
|
|
357
|
+
| promptPartials | The Transcend AI prompt partials | View Prompts | false | [Prompt Manager -> Partials](https://app.transcend.io/prompts/partialss) |
|
|
358
|
+
| promptGroups | The Transcend AI prompt groups | View Prompts | false | [Prompt Manager -> Groups](https://app.transcend.io/prompts/groups) |
|
|
360
359
|
|
|
361
360
|
_Note: The scopes for tr-push are comprehensive of the scopes for tr-pull_
|
|
362
361
|
|
|
@@ -484,7 +483,7 @@ tr-pull --auth=$TRANSCEND_API_KEY --resources=assessment,assessmentTemplate
|
|
|
484
483
|
Pull in prompts, prompt templates, prompt partials and prompt groups (see [this example](./examples/prompts.yml)):
|
|
485
484
|
|
|
486
485
|
```sh
|
|
487
|
-
tr-pull --auth=$TRANSCEND_API_KEY --resources=prompts,
|
|
486
|
+
tr-pull --auth=$TRANSCEND_API_KEY --resources=prompts,promptPartials,promptGroups
|
|
488
487
|
```
|
|
489
488
|
|
|
490
489
|
Pull everything:
|
|
@@ -525,26 +524,25 @@ In order to use this cli, you will first need to generate an API key on the Tran
|
|
|
525
524
|
|
|
526
525
|
The API key needs the following scopes when pushing the various resource types:
|
|
527
526
|
|
|
528
|
-
| Key | Description | Scope | Is Default | Link
|
|
529
|
-
| ------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ---------- |
|
|
530
|
-
| 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 | [
|
|
531
|
-
| templates | Email templates. Only template titles can be created and mapped to other resources. | Manage Email Templates | true | [
|
|
532
|
-
| dataSilos | The Data Silo/Integration definitions. | Manage Data Map,Connect Data Silos | true | [Data
|
|
533
|
-
| enrichers | The Privacy Request enricher configurations. | Manage Request Identity Verification | true | [
|
|
534
|
-
| businessEntities | The business entities in the data inventory. | Manage Data Inventory | false | [Data
|
|
535
|
-
| identifiers | The Privacy Request identifier configurations. | Manage Request Identity Verification | false | [
|
|
536
|
-
| actions | The Privacy Request action settings. | Manage Data Subject Request Settings | false | [
|
|
537
|
-
| dataSubjects | The Privacy Request data subject settings. | Manage Data Subject Request Settings | false | [
|
|
538
|
-
| 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)
|
|
539
|
-
| dataFlows | Consent Manager Data Flow definitions. | Manage Data Flows | false | [Consent
|
|
540
|
-
| cookies | Consent Manager Cookie definitions. | Manage Data Flows | false | [Consent
|
|
541
|
-
| consentManager | Consent Manager general settings, including domain list. | Manage Consent Manager Developer Settings | false | [Consent
|
|
542
|
-
| assessments | The Transcend assessments | Manage Assessments | false | [Assessments -> Browse](https://app.transcend.io/assessments/browse)
|
|
543
|
-
| assessmentTemplates | The Transcend assessment templates | Manage Assessments | false | [Assessments -> Templates](https://app.transcend.io/assessments/templates)
|
|
544
|
-
| prompts | The Transcend AI prompts | View Prompts | false | [Prompt Manager -> Browse](https://app.transcend.io/prompts/browse)
|
|
545
|
-
|
|
|
546
|
-
|
|
|
547
|
-
| promptGroups | The Transcend AI prompt groups | Manage Prompts | false | [Prompt Manager -> Groups](https://app.transcend.io/prompts/groups) |
|
|
527
|
+
| Key | Description | Scope | Is Default | Link |
|
|
528
|
+
| ------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
529
|
+
| 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) |
|
|
530
|
+
| 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) |
|
|
531
|
+
| 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) |
|
|
532
|
+
| enrichers | The Privacy Request enricher configurations. | Manage Request Identity Verification | true | [DSR Automation -> Identifiers](https://app.transcend.io/privacy-requests/identifiers) |
|
|
533
|
+
| 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) |
|
|
534
|
+
| identifiers | The Privacy Request identifier configurations. | Manage Request Identity Verification | false | [DSR Automation -> Identifiers](https://app.transcend.io/privacy-requests/identifiers) |
|
|
535
|
+
| actions | The Privacy Request action settings. | Manage Data Subject Request Settings | false | [DSR Automation -> Request Settings](https://app.transcend.io/privacy-requests/settings) |
|
|
536
|
+
| dataSubjects | The Privacy Request data subject settings. | Manage Data Subject Request Settings | false | [DSR Automation -> Request Settings](https://app.transcend.io/privacy-requests/settings) |
|
|
537
|
+
| 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) |
|
|
538
|
+
| dataFlows | Consent Manager Data Flow definitions. | Manage Data Flows | false | [Consent Management -> Data Flows](https://app.transcend.io/consent-manager/data-flows/approved) |
|
|
539
|
+
| cookies | Consent Manager Cookie definitions. | Manage Data Flows | false | [Consent Management -> Cookies](https://app.transcend.io/consent-manager/cookies/approved) |
|
|
540
|
+
| 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) |
|
|
541
|
+
| assessments | The Transcend assessments | Manage Assessments | false | [Assessments -> Browse](https://app.transcend.io/assessments/browse) |
|
|
542
|
+
| assessmentTemplates | The Transcend assessment templates | Manage Assessments | false | [Assessments -> Templates](https://app.transcend.io/assessments/templates) |
|
|
543
|
+
| prompts | The Transcend AI prompts | View Prompts | false | [Prompt Manager -> Browse](https://app.transcend.io/prompts/browse) |
|
|
544
|
+
| promptPartials | The Transcend AI prompt partials | Manage Prompts | false | [Prompt Manager -> Partials](https://app.transcend.io/prompts/partialss) |
|
|
545
|
+
| promptGroups | The Transcend AI prompt groups | Manage Prompts | false | [Prompt Manager -> Groups](https://app.transcend.io/prompts/groups) |
|
|
548
546
|
|
|
549
547
|
#### Arguments
|
|
550
548
|
|
|
@@ -742,7 +740,7 @@ You can include additional arguments as well:
|
|
|
742
740
|
|
|
743
741
|
### tr-request-approve
|
|
744
742
|
|
|
745
|
-
Bulk approve a set of privacy requests from the [
|
|
743
|
+
Bulk approve a set of privacy requests from the [DSR Automation -> Incoming Requests](https://app.transcend.io/privacy-requests/incoming-requests) tab.
|
|
746
744
|
|
|
747
745
|
#### Authentication
|
|
748
746
|
|
|
@@ -800,7 +798,7 @@ yarn tr-request-approve --auth=$TRANSCEND_API_KEY --actions=SALE_OPT_OUT --creat
|
|
|
800
798
|
|
|
801
799
|
### tr-request-cancel
|
|
802
800
|
|
|
803
|
-
Bulk cancel a set of privacy requests from the [
|
|
801
|
+
Bulk cancel a set of privacy requests from the [DSR Automation -> Incoming Requests](https://app.transcend.io/privacy-requests/incoming-requests) tab.
|
|
804
802
|
|
|
805
803
|
#### Authentication
|
|
806
804
|
|
|
@@ -879,7 +877,7 @@ yarn tr-request-cancel --auth=$TRANSCEND_API_KEY --actions=ERASURE --concurrency
|
|
|
879
877
|
|
|
880
878
|
### tr-request-mark-silent
|
|
881
879
|
|
|
882
|
-
Bulk update a set of privacy requests from the [
|
|
880
|
+
Bulk update a set of privacy requests from the [DSR Automation -> Incoming Requests](https://app.transcend.io/privacy-requests/incoming-requests) tab to be in silent mode.
|
|
883
881
|
|
|
884
882
|
#### Authentication
|
|
885
883
|
|
|
@@ -2021,7 +2019,7 @@ yarn tr-pull-consent-preferences --auth=$TRANSCEND_API_KEY --partition=4d1c5daa-
|
|
|
2021
2019
|
|
|
2022
2020
|
This command allows for uploading of data flows from CSV.
|
|
2023
2021
|
|
|
2024
|
-
Step 1) Download the CSV of data flows that you want to edit from the Admin Dashboard under [Consent
|
|
2022
|
+
Step 1) Download the CSV of data flows that you want to edit from the Admin Dashboard under [Consent Management -> Data Flows](https://app.transcend.io/consent-manager/data-flows). You can download data flows from both the "Triage" and "Approved" tabs.
|
|
2025
2023
|
|
|
2026
2024
|
<img width="1464" alt="Screenshot 2023-06-22 at 6 05 36 PM" src="https://github.com/transcend-io/cli/assets/10264973/c4b65b31-2cf3-49c9-b543-041567c7aff8">
|
|
2027
2025
|
|
|
@@ -2085,7 +2083,7 @@ yarn tr-upload-data-flows-from-csv --auth=$TRANSCEND_API_KEY --transcendUrl=http
|
|
|
2085
2083
|
|
|
2086
2084
|
This command allows for uploading cookies from CSV
|
|
2087
2085
|
|
|
2088
|
-
Step 1) Download the CSV of cookies that you want to edit from the Admin Dashboard under [Consent
|
|
2086
|
+
Step 1) Download the CSV of cookies that you want to edit from the Admin Dashboard under [Consent Management -> Cookies](https://app.transcend.io/consent-manager/cookies). You can download cookies from both the "Triage" and "Approved" tabs.
|
|
2089
2087
|
|
|
2090
2088
|
Step 2) You can edit the contents of the CSV file as needed. You may adjust the "Purpose" column, adjust the "Notes" column, add "Owners" and "Teams" or even add custom columns with additional metadata.
|
|
2091
2089
|
|
package/build/codecs.d.ts
CHANGED
|
@@ -5679,7 +5679,6 @@ export declare const AttributeInput: t.IntersectionC<[t.TypeC<{
|
|
|
5679
5679
|
prompt: unknown;
|
|
5680
5680
|
promptGroup: unknown;
|
|
5681
5681
|
promptRun: unknown;
|
|
5682
|
-
promptTemplate: unknown;
|
|
5683
5682
|
}>>;
|
|
5684
5683
|
/** Values of attribute */
|
|
5685
5684
|
values: t.ArrayC<t.IntersectionC<[t.TypeC<{
|
|
@@ -5746,19 +5745,6 @@ export declare const PromptInput: t.TypeC<{
|
|
|
5746
5745
|
* Type override
|
|
5747
5746
|
*/
|
|
5748
5747
|
export type PromptInput = t.TypeOf<typeof PromptInput>;
|
|
5749
|
-
/**
|
|
5750
|
-
* Prompt template definition inputs
|
|
5751
|
-
*/
|
|
5752
|
-
export declare const PromptTemplateInput: t.TypeC<{
|
|
5753
|
-
/** The title of the prompt template. */
|
|
5754
|
-
title: t.StringC;
|
|
5755
|
-
/** The content of the prompt template. */
|
|
5756
|
-
content: t.StringC;
|
|
5757
|
-
}>;
|
|
5758
|
-
/**
|
|
5759
|
-
* Type override
|
|
5760
|
-
*/
|
|
5761
|
-
export type PromptTemplateInput = t.TypeOf<typeof PromptTemplateInput>;
|
|
5762
5748
|
/**
|
|
5763
5749
|
* Prompt partial definition inputs
|
|
5764
5750
|
*/
|
|
@@ -46191,7 +46177,6 @@ export declare const TranscendInput: t.PartialC<{
|
|
|
46191
46177
|
prompt: unknown;
|
|
46192
46178
|
promptGroup: unknown;
|
|
46193
46179
|
promptRun: unknown;
|
|
46194
|
-
promptTemplate: unknown;
|
|
46195
46180
|
}>>;
|
|
46196
46181
|
/** Values of attribute */
|
|
46197
46182
|
values: t.ArrayC<t.IntersectionC<[t.TypeC<{
|
|
@@ -74556,15 +74541,6 @@ export declare const TranscendInput: t.PartialC<{
|
|
|
74556
74541
|
/** The content of the prompt. */
|
|
74557
74542
|
content: t.StringC;
|
|
74558
74543
|
}>>;
|
|
74559
|
-
/**
|
|
74560
|
-
* Prompt template definitions
|
|
74561
|
-
*/
|
|
74562
|
-
'prompt-templates': t.ArrayC<t.TypeC<{
|
|
74563
|
-
/** The title of the prompt template. */
|
|
74564
|
-
title: t.StringC;
|
|
74565
|
-
/** The content of the prompt template. */
|
|
74566
|
-
content: t.StringC;
|
|
74567
|
-
}>>;
|
|
74568
74544
|
/**
|
|
74569
74545
|
* Prompt partial definitions
|
|
74570
74546
|
*/
|