Skip to content

Commit a8d8109

Browse files
aadamgoughaadamgoughwaleedlatif1
authored
fix(google-vault): error handling improvement and more params (#2735)
* new error throw and improvement * fixed critical issues * restore error thorwing * restore * added handler for vault * updated docs * restored * removed google vault from executor * updated translations * updated docs * fixed inputs and outputs --------- Co-authored-by: aadamgough <adam@sim.ai> Co-authored-by: waleed <walif6@gmail.com>
1 parent 3768c63 commit a8d8109

File tree

12 files changed

+635
-155
lines changed

12 files changed

+635
-155
lines changed

‎apps/docs/content/docs/en/tools/google_vault.mdx‎

Lines changed: 58 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -36,43 +36,47 @@ Connect Google Vault to create exports, list exports, and manage holds within ma
3636

3737
### `google_vault_create_matters_export`
3838

39+
Create an export in a matter
40+
3941
#### Input
4042

4143
| Parameter | Type | Required | Description |
4244
| --------- | ---- | -------- | ----------- |
45+
| `matterId` | string | Yes | The matter ID |
46+
| `exportName` | string | Yes | Name for the export \(avoid special characters\) |
47+
| `corpus` | string | Yes | Data corpus to export \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) |
48+
| `accountEmails` | string | No | Comma-separated list of user emails to scope export |
49+
| `orgUnitId` | string | No | Organization unit ID to scope export \(alternative to emails\) |
50+
| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, e.g., 2024-01-01T00:00:00Z\) |
51+
| `endTime` | string | No | End time for date filtering \(ISO 8601 format, e.g., 2024-12-31T23:59:59Z\) |
52+
| `terms` | string | No | Search query terms to filter exported content |
4353

4454
#### Output
4555

4656
| Parameter | Type | Description |
4757
| --------- | ---- | ----------- |
48-
| `matters` | json | Array of matter objects \(for list_matters\) |
49-
| `exports` | json | Array of export objects \(for list_matters_export\) |
50-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
51-
| `matter` | json | Created matter object \(for create_matters\) |
52-
| `export` | json | Created export object \(for create_matters_export\) |
53-
| `hold` | json | Created hold object \(for create_matters_holds\) |
54-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
55-
| `nextPageToken` | string | Token for fetching next page of results \(for list operations\) |
58+
| `export` | json | Created export object |
5659

5760
### `google_vault_list_matters_export`
5861

62+
List exports for a matter
63+
5964
#### Input
6065

6166
| Parameter | Type | Required | Description |
6267
| --------- | ---- | -------- | ----------- |
68+
| `matterId` | string | Yes | The matter ID |
69+
| `pageSize` | number | No | Number of exports to return per page |
70+
| `pageToken` | string | No | Token for pagination |
71+
| `exportId` | string | No | Optional export ID to fetch a specific export |
6372

6473
#### Output
6574

6675
| Parameter | Type | Description |
6776
| --------- | ---- | ----------- |
68-
| `matters` | json | Array of matter objects \(for list_matters\) |
69-
| `exports` | json | Array of export objects \(for list_matters_export\) |
70-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
71-
| `matter` | json | Created matter object \(for create_matters\) |
72-
| `export` | json | Created export object \(for create_matters_export\) |
73-
| `hold` | json | Created hold object \(for create_matters_holds\) |
74-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
75-
| `nextPageToken` | string | Token for fetching next page of results \(for list operations\) |
77+
| `exports` | json | Array of export objects |
78+
| `export` | json | Single export object \(when exportId is provided\) |
79+
| `nextPageToken` | string | Token for fetching next page of results |
7680

7781
### `google_vault_download_export_file`
7882

@@ -82,10 +86,10 @@ Download a single file from a Google Vault export (GCS object)
8286

8387
| Parameter | Type | Required | Description |
8488
| --------- | ---- | -------- | ----------- |
85-
| `matterId` | string | Yes | No description |
86-
| `bucketName` | string | Yes | No description |
87-
| `objectName` | string | Yes | No description |
88-
| `fileName` | string | No | No description |
89+
| `matterId` | string | Yes | The matter ID |
90+
| `bucketName` | string | Yes | GCS bucket name from cloudStorageSink.files.bucketName |
91+
| `objectName` | string | Yes | GCS object name from cloudStorageSink.files.objectName |
92+
| `fileName` | string | No | Optional filename override for the downloaded file |
8993

9094
#### Output
9195

@@ -95,82 +99,84 @@ Download a single file from a Google Vault export (GCS object)
9599

96100
### `google_vault_create_matters_holds`
97101

102+
Create a hold in a matter
103+
98104
#### Input
99105

100106
| Parameter | Type | Required | Description |
101107
| --------- | ---- | -------- | ----------- |
108+
| `matterId` | string | Yes | The matter ID |
109+
| `holdName` | string | Yes | Name for the hold |
110+
| `corpus` | string | Yes | Data corpus to hold \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) |
111+
| `accountEmails` | string | No | Comma-separated list of user emails to put on hold |
112+
| `orgUnitId` | string | No | Organization unit ID to put on hold \(alternative to accounts\) |
113+
| `terms` | string | No | Search terms to filter held content \(for MAIL and GROUPS corpus\) |
114+
| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, for MAIL and GROUPS corpus\) |
115+
| `endTime` | string | No | End time for date filtering \(ISO 8601 format, for MAIL and GROUPS corpus\) |
116+
| `includeSharedDrives` | boolean | No | Include files in shared drives \(for DRIVE corpus\) |
102117

103118
#### Output
104119

105120
| Parameter | Type | Description |
106121
| --------- | ---- | ----------- |
107-
| `matters` | json | Array of matter objects \(for list_matters\) |
108-
| `exports` | json | Array of export objects \(for list_matters_export\) |
109-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
110-
| `matter` | json | Created matter object \(for create_matters\) |
111-
| `export` | json | Created export object \(for create_matters_export\) |
112-
| `hold` | json | Created hold object \(for create_matters_holds\) |
113-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
114-
| `nextPageToken` | string | Token for fetching next page of results \(for list operations\) |
122+
| `hold` | json | Created hold object |
115123

116124
### `google_vault_list_matters_holds`
117125

126+
List holds for a matter
127+
118128
#### Input
119129

120130
| Parameter | Type | Required | Description |
121131
| --------- | ---- | -------- | ----------- |
132+
| `matterId` | string | Yes | The matter ID |
133+
| `pageSize` | number | No | Number of holds to return per page |
134+
| `pageToken` | string | No | Token for pagination |
135+
| `holdId` | string | No | Optional hold ID to fetch a specific hold |
122136

123137
#### Output
124138

125139
| Parameter | Type | Description |
126140
| --------- | ---- | ----------- |
127-
| `matters` | json | Array of matter objects \(for list_matters\) |
128-
| `exports` | json | Array of export objects \(for list_matters_export\) |
129-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
130-
| `matter` | json | Created matter object \(for create_matters\) |
131-
| `export` | json | Created export object \(for create_matters_export\) |
132-
| `hold` | json | Created hold object \(for create_matters_holds\) |
133-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
134-
| `nextPageToken` | string | Token for fetching next page of results \(for list operations\) |
141+
| `holds` | json | Array of hold objects |
142+
| `hold` | json | Single hold object \(when holdId is provided\) |
143+
| `nextPageToken` | string | Token for fetching next page of results |
135144

136145
### `google_vault_create_matters`
137146

147+
Create a new matter in Google Vault
148+
138149
#### Input
139150

140151
| Parameter | Type | Required | Description |
141152
| --------- | ---- | -------- | ----------- |
153+
| `name` | string | Yes | Name for the new matter |
154+
| `description` | string | No | Optional description for the matter |
142155

143156
#### Output
144157

145158
| Parameter | Type | Description |
146159
| --------- | ---- | ----------- |
147-
| `matters` | json | Array of matter objects \(for list_matters\) |
148-
| `exports` | json | Array of export objects \(for list_matters_export\) |
149-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
150-
| `matter` | json | Created matter object \(for create_matters\) |
151-
| `export` | json | Created export object \(for create_matters_export\) |
152-
| `hold` | json | Created hold object \(for create_matters_holds\) |
153-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
154-
| `nextPageToken` | string | Token for fetching next page of results \(for list operations\) |
160+
| `matter` | json | Created matter object |
155161

156162
### `google_vault_list_matters`
157163

164+
List matters, or get a specific matter if matterId is provided
165+
158166
#### Input
159167

160168
| Parameter | Type | Required | Description |
161169
| --------- | ---- | -------- | ----------- |
170+
| `pageSize` | number | No | Number of matters to return per page |
171+
| `pageToken` | string | No | Token for pagination |
172+
| `matterId` | string | No | Optional matter ID to fetch a specific matter |
162173

163174
#### Output
164175

165176
| Parameter | Type | Description |
166177
| --------- | ---- | ----------- |
167-
| `matters` | json | Array of matter objects \(for list_matters\) |
168-
| `exports` | json | Array of export objects \(for list_matters_export\) |
169-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
170-
| `matter` | json | Created matter object \(for create_matters\) |
171-
| `export` | json | Created export object \(for create_matters_export\) |
172-
| `hold` | json | Created hold object \(for create_matters_holds\) |
173-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
174-
| `nextPageToken` | string | Token for fetching next page of results \(for list operations\) |
178+
| `matters` | json | Array of matter objects |
179+
| `matter` | json | Single matter object \(when matterId is provided\) |
180+
| `nextPageToken` | string | Token for fetching next page of results |
175181

176182

0 commit comments

Comments
 (0)