DefinitelyTyped/types/gapi.client.vault

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",  });