@maxim_mazurok/gapi.client.vault-v1
Advanced tools
Comparing version 0.0.20231116 to 0.0.20231121
{ | ||
"name": "@maxim_mazurok/gapi.client.vault-v1", | ||
"version": "0.0.20231116", | ||
"version": "0.0.20231121", | ||
"description": "TypeScript typings for Google Vault API v1", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git" | ||
}, | ||
"license": "MIT", | ||
"author": { | ||
"name": "Maxim Mazurok", | ||
"email": "maxim@mazurok.com", | ||
"name": "Maxim Mazurok", | ||
"url": "https://maxim.mazurok.com" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git" | ||
}, | ||
"types": "index.d.ts", | ||
@@ -16,0 +16,0 @@ "dependencies": { |
# TypeScript typings for Google Vault API v1 | ||
Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them. | ||
Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them. | ||
For detailed description please check [documentation](https://developers.google.com/vault). | ||
@@ -28,6 +28,9 @@ | ||
```typescript | ||
gapi.client.load('https://vault.googleapis.com/$discovery/rest?version=v1', () => { | ||
// now we can use: | ||
// gapi.client.vault | ||
}); | ||
gapi.client.load( | ||
'https://vault.googleapis.com/$discovery/rest?version=v1', | ||
() => { | ||
// now we can use: | ||
// gapi.client.vault | ||
} | ||
); | ||
``` | ||
@@ -49,20 +52,21 @@ | ||
scope = [ | ||
// Manage your eDiscovery data | ||
'https://www.googleapis.com/auth/ediscovery', | ||
// Manage your eDiscovery data | ||
'https://www.googleapis.com/auth/ediscovery', | ||
// View your eDiscovery data | ||
'https://www.googleapis.com/auth/ediscovery.readonly', | ||
], | ||
immediate = true; | ||
// View your eDiscovery data | ||
'https://www.googleapis.com/auth/ediscovery.readonly', | ||
], | ||
immediate = true; | ||
// ... | ||
gapi.auth.authorize( | ||
{ client_id: client_id, scope: scope, immediate: immediate }, | ||
{client_id: client_id, scope: scope, immediate: immediate}, | ||
authResult => { | ||
if (authResult && !authResult.error) { | ||
/* handle successful authorization */ | ||
/* handle successful authorization */ | ||
} else { | ||
/* handle authorization error */ | ||
/* handle authorization error */ | ||
} | ||
}); | ||
} | ||
); | ||
``` | ||
@@ -73,7 +77,6 @@ | ||
```typescript | ||
/* | ||
Adds an account as a matter collaborator. | ||
*/ | ||
await gapi.client.vault.matters.addPermissions({ matterId: "matterId", }); | ||
await gapi.client.vault.matters.addPermissions({matterId: 'matterId'}); | ||
@@ -83,3 +86,3 @@ /* | ||
*/ | ||
await gapi.client.vault.matters.close({ matterId: "matterId", }); | ||
await gapi.client.vault.matters.close({matterId: 'matterId'}); | ||
@@ -89,3 +92,3 @@ /* | ||
*/ | ||
await gapi.client.vault.matters.count({ matterId: "matterId", }); | ||
await gapi.client.vault.matters.count({matterId: 'matterId'}); | ||
@@ -95,3 +98,3 @@ /* | ||
*/ | ||
await gapi.client.vault.matters.create({ }); | ||
await gapi.client.vault.matters.create({}); | ||
@@ -101,3 +104,3 @@ /* | ||
*/ | ||
await gapi.client.vault.matters.delete({ matterId: "matterId", }); | ||
await gapi.client.vault.matters.delete({matterId: 'matterId'}); | ||
@@ -107,3 +110,3 @@ /* | ||
*/ | ||
await gapi.client.vault.matters.get({ matterId: "matterId", }); | ||
await gapi.client.vault.matters.get({matterId: 'matterId'}); | ||
@@ -113,3 +116,3 @@ /* | ||
*/ | ||
await gapi.client.vault.matters.list({ }); | ||
await gapi.client.vault.matters.list({}); | ||
@@ -119,3 +122,3 @@ /* | ||
*/ | ||
await gapi.client.vault.matters.removePermissions({ matterId: "matterId", }); | ||
await gapi.client.vault.matters.removePermissions({matterId: 'matterId'}); | ||
@@ -125,3 +128,3 @@ /* | ||
*/ | ||
await gapi.client.vault.matters.reopen({ matterId: "matterId", }); | ||
await gapi.client.vault.matters.reopen({matterId: 'matterId'}); | ||
@@ -131,3 +134,3 @@ /* | ||
*/ | ||
await gapi.client.vault.matters.undelete({ matterId: "matterId", }); | ||
await gapi.client.vault.matters.undelete({matterId: 'matterId'}); | ||
@@ -137,3 +140,3 @@ /* | ||
*/ | ||
await gapi.client.vault.matters.update({ matterId: "matterId", }); | ||
await gapi.client.vault.matters.update({matterId: 'matterId'}); | ||
@@ -143,3 +146,3 @@ /* | ||
*/ | ||
await gapi.client.vault.operations.cancel({ name: "name", }); | ||
await gapi.client.vault.operations.cancel({name: 'name'}); | ||
@@ -149,3 +152,3 @@ /* | ||
*/ | ||
await gapi.client.vault.operations.delete({ name: "name", }); | ||
await gapi.client.vault.operations.delete({name: 'name'}); | ||
@@ -155,3 +158,3 @@ /* | ||
*/ | ||
await gapi.client.vault.operations.get({ name: "name", }); | ||
await gapi.client.vault.operations.get({name: 'name'}); | ||
@@ -161,3 +164,3 @@ /* | ||
*/ | ||
await gapi.client.vault.operations.list({ name: "name", }); | ||
await gapi.client.vault.operations.list({name: 'name'}); | ||
``` |
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
150
98439
3
1937