Skip to content

Commit f40499f

Browse files
waleedlatif1waleedlatif1
committed
updated docs
1 parent ec75de3 commit f40499f

File tree

7 files changed

+43
-54
lines changed

7 files changed

+43
-54
lines changed

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

Lines changed: 37 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ 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 |
@@ -53,34 +55,28 @@ Connect Google Vault to create exports, list exports, and manage holds within ma
5355

5456
| Parameter | Type | Description |
5557
| --------- | ---- | ----------- |
56-
| `matters` | json | Array of matter objects \(for list_matters\) |
57-
| `exports` | json | Array of export objects \(for list_matters_export\) |
58-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
59-
| `matter` | json | Created matter object \(for create_matters\) |
60-
| `export` | json | Created export object \(for create_matters_export\) |
61-
| `hold` | json | Created hold object \(for create_matters_holds\) |
62-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
63-
| `nextPageToken` | string | Token for fetching next page of results \(for list operations\) |
58+
| `export` | json | Created export object |
6459

6560
### `google_vault_list_matters_export`
6661

62+
List exports for a matter
63+
6764
#### Input
6865

6966
| Parameter | Type | Required | Description |
7067
| --------- | ---- | -------- | ----------- |
68+
| `matterId` | string | Yes | No description |
69+
| `pageSize` | number | No | No description |
70+
| `pageToken` | string | No | No description |
71+
| `exportId` | string | No | No description |
7172

7273
#### Output
7374

7475
| Parameter | Type | Description |
7576
| --------- | ---- | ----------- |
76-
| `matters` | json | Array of matter objects \(for list_matters\) |
77-
| `exports` | json | Array of export objects \(for list_matters_export\) |
78-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
79-
| `matter` | json | Created matter object \(for create_matters\) |
80-
| `export` | json | Created export object \(for create_matters_export\) |
81-
| `hold` | json | Created hold object \(for create_matters_holds\) |
82-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
83-
| `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 |
8480

8581
### `google_vault_download_export_file`
8682

@@ -103,6 +99,8 @@ Download a single file from a Google Vault export (GCS object)
10399

104100
### `google_vault_create_matters_holds`
105101

102+
Create a hold in a matter
103+
106104
#### Input
107105

108106
| Parameter | Type | Required | Description |
@@ -121,73 +119,64 @@ Download a single file from a Google Vault export (GCS object)
121119

122120
| Parameter | Type | Description |
123121
| --------- | ---- | ----------- |
124-
| `matters` | json | Array of matter objects \(for list_matters\) |
125-
| `exports` | json | Array of export objects \(for list_matters_export\) |
126-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
127-
| `matter` | json | Created matter object \(for create_matters\) |
128-
| `export` | json | Created export object \(for create_matters_export\) |
129-
| `hold` | json | Created hold object \(for create_matters_holds\) |
130-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
131-
| `nextPageToken` | string | Token for fetching next page of results \(for list operations\) |
122+
| `hold` | json | Created hold object |
132123

133124
### `google_vault_list_matters_holds`
134125

126+
List holds for a matter
127+
135128
#### Input
136129

137130
| Parameter | Type | Required | Description |
138131
| --------- | ---- | -------- | ----------- |
132+
| `matterId` | string | Yes | No description |
133+
| `pageSize` | number | No | No description |
134+
| `pageToken` | string | No | No description |
135+
| `holdId` | string | No | No description |
139136

140137
#### Output
141138

142139
| Parameter | Type | Description |
143140
| --------- | ---- | ----------- |
144-
| `matters` | json | Array of matter objects \(for list_matters\) |
145-
| `exports` | json | Array of export objects \(for list_matters_export\) |
146-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
147-
| `matter` | json | Created matter object \(for create_matters\) |
148-
| `export` | json | Created export object \(for create_matters_export\) |
149-
| `hold` | json | Created hold object \(for create_matters_holds\) |
150-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
151-
| `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 |
152144

153145
### `google_vault_create_matters`
154146

147+
Create a new matter in Google Vault
148+
155149
#### Input
156150

157151
| Parameter | Type | Required | Description |
158152
| --------- | ---- | -------- | ----------- |
153+
| `name` | string | Yes | No description |
154+
| `description` | string | No | No description |
159155

160156
#### Output
161157

162158
| Parameter | Type | Description |
163159
| --------- | ---- | ----------- |
164-
| `matters` | json | Array of matter objects \(for list_matters\) |
165-
| `exports` | json | Array of export objects \(for list_matters_export\) |
166-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
167-
| `matter` | json | Created matter object \(for create_matters\) |
168-
| `export` | json | Created export object \(for create_matters_export\) |
169-
| `hold` | json | Created hold object \(for create_matters_holds\) |
170-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
171-
| `nextPageToken` | string | Token for fetching next page of results \(for list operations\) |
160+
| `matter` | json | Created matter object |
172161

173162
### `google_vault_list_matters`
174163

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

177168
| Parameter | Type | Required | Description |
178169
| --------- | ---- | -------- | ----------- |
170+
| `pageSize` | number | No | No description |
171+
| `pageToken` | string | No | No description |
172+
| `matterId` | string | No | No description |
179173

180174
#### Output
181175

182176
| Parameter | Type | Description |
183177
| --------- | ---- | ----------- |
184-
| `matters` | json | Array of matter objects \(for list_matters\) |
185-
| `exports` | json | Array of export objects \(for list_matters_export\) |
186-
| `holds` | json | Array of hold objects \(for list_matters_holds\) |
187-
| `matter` | json | Created matter object \(for create_matters\) |
188-
| `export` | json | Created export object \(for create_matters_export\) |
189-
| `hold` | json | Created hold object \(for create_matters_holds\) |
190-
| `file` | json | Downloaded export file \(UserFile\) from execution files |
191-
| `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 |
192181

193182

‎apps/sim/tools/google_vault/create_matters.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { enhanceGoogleVaultError } from '@/tools/google_vault/utils'
33
import type { ToolConfig } from '@/tools/types'
44

55
export const createMattersTool: ToolConfig<GoogleVaultCreateMattersParams> = {
6-
id: 'create_matters',
6+
id: 'google_vault_create_matters',
77
name: 'Vault Create Matter',
88
description: 'Create a new matter in Google Vault',
99
version: '1.0',

‎apps/sim/tools/google_vault/create_matters_export.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { enhanceGoogleVaultError } from '@/tools/google_vault/utils'
33
import type { ToolConfig } from '@/tools/types'
44

55
export const createMattersExportTool: ToolConfig<GoogleVaultCreateMattersExportParams> = {
6-
id: 'create_matters_export',
6+
id: 'google_vault_create_matters_export',
77
name: 'Vault Create Export (by Matter)',
88
description: 'Create an export in a matter',
99
version: '1.0',

‎apps/sim/tools/google_vault/create_matters_holds.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { enhanceGoogleVaultError } from '@/tools/google_vault/utils'
33
import type { ToolConfig } from '@/tools/types'
44

55
export const createMattersHoldsTool: ToolConfig<GoogleVaultCreateMattersHoldsParams> = {
6-
id: 'create_matters_holds',
6+
id: 'google_vault_create_matters_holds',
77
name: 'Vault Create Hold (by Matter)',
88
description: 'Create a hold in a matter',
99
version: '1.0',

‎apps/sim/tools/google_vault/list_matters.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { enhanceGoogleVaultError } from '@/tools/google_vault/utils'
33
import type { ToolConfig } from '@/tools/types'
44

55
export const listMattersTool: ToolConfig<GoogleVaultListMattersParams> = {
6-
id: 'list_matters',
6+
id: 'google_vault_list_matters',
77
name: 'Vault List Matters',
88
description: 'List matters, or get a specific matter if matterId is provided',
99
version: '1.0',

‎apps/sim/tools/google_vault/list_matters_export.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { enhanceGoogleVaultError } from '@/tools/google_vault/utils'
33
import type { ToolConfig } from '@/tools/types'
44

55
export const listMattersExportTool: ToolConfig<GoogleVaultListMattersExportParams> = {
6-
id: 'list_matters_export',
6+
id: 'google_vault_list_matters_export',
77
name: 'Vault List Exports (by Matter)',
88
description: 'List exports for a matter',
99
version: '1.0',

‎apps/sim/tools/google_vault/list_matters_holds.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { enhanceGoogleVaultError } from '@/tools/google_vault/utils'
33
import type { ToolConfig } from '@/tools/types'
44

55
export const listMattersHoldsTool: ToolConfig<GoogleVaultListMattersHoldsParams> = {
6-
id: 'list_matters_holds',
6+
id: 'google_vault_list_matters_holds',
77
name: 'Vault List Holds (by Matter)',
88
description: 'List holds for a matter',
99
version: '1.0',

0 commit comments

Comments
 (0)