mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
4f8a3d571b
* Add Google APIs typings * [gapi.cliebt.* ] Add version as part of typings name and fix gapi.client tslint errors * versions should not get their own folders fixing a few typos using /** syntax so comments show up in editors export only actual (last) version for now * export only actual (last) version for now * merge namespaces and remove unnecessary namespace qualifiers * remove namespace qualifier for gapi.client.Request from nested namespaces and change Request base interface to Promise * disable await-promise rule * fix collision between gapi.client.Request and Request from nested namespace disable no-irregular-whitespace rule * sort properties and namespace resources * remove empty comments sort resources amd methods in tests and readme.md * update 'this is autogenerated file' banner to remove this text from gapi.client namespace hint use multiline comments when comment has several lines * implement no-trailing-whitespace, no-padding, max-line-length, await-promise, no-irregular-whitespace rules * add strictFunctionTypes to tsconfig * fix "Whitespace within parentheses is not allowed" rule * fix ts-lint rules * fixes * remove deprecated replicapool and replicapoolupdater api * fix no-irregular-whitespace * fix no-irregular-whitespace
2.8 KiB
2.8 KiB
TypeScript typings for Google Vault API v1
Archiving and eDiscovery for G Suite. For detailed description please check documentation.
Installing
Install typings for Google Vault API:
npm install @types/gapi.client.vault@v1 --save-dev
Usage
You need to initialize Google API client in your code:
gapi.load("client", () => {
// now we can use gapi.client
// ...
});
Then load api client wrapper:
gapi.client.load('vault', 'v1', () => {
// now we can use gapi.client.vault
// ...
});
Don't forget to authenticate your client before sending any request to resources:
// declare client_id registered in Google Developers Console
var client_id = '',
scope = [
// Manage your eDiscovery data
'https://www.googleapis.com/auth/ediscovery',
// View your eDiscovery data
'https://www.googleapis.com/auth/ediscovery.readonly',
],
immediate = true;
// ...
gapi.auth.authorize({ client_id: client_id, scope: scope, immediate: immediate }, authResult => {
if (authResult && !authResult.error) {
/* handle succesfull authorization */
} else {
/* handle authorization error */
}
});
After that you can use Google Vault API resources:
/*
Adds an account as a matter collaborator.
*/
await gapi.client.matters.addPermissions({ matterId: "matterId", });
/*
Closes the specified matter. Returns matter with updated state.
*/
await gapi.client.matters.close({ matterId: "matterId", });
/*
Creates a new matter with the given name and description. The initial state
is open, and the owner is the method caller. Returns the created matter
with default view.
*/
await gapi.client.matters.create({ });
/*
Deletes the specified matter. Returns matter with updated state.
*/
await gapi.client.matters.delete({ matterId: "matterId", });
/*
Gets the specified matter.
*/
await gapi.client.matters.get({ matterId: "matterId", });
/*
Lists matters the user has access to.
*/
await gapi.client.matters.list({ });
/*
Removes an account as a matter collaborator.
*/
await gapi.client.matters.removePermissions({ matterId: "matterId", });
/*
Reopens the specified matter. Returns matter with updated state.
*/
await gapi.client.matters.reopen({ matterId: "matterId", });
/*
Undeletes the specified matter. Returns matter with updated state.
*/
await gapi.client.matters.undelete({ matterId: "matterId", });
/*
Updates the specified matter.
This updates only the name and description of the matter, identified by
matter id. Changes to any other fields are ignored.
Returns the default view of the matter.
*/
await gapi.client.matters.update({ matterId: "matterId", });