DefinitelyTyped/types/gapi.client.groupssettings

TypeScript typings for Groups Settings API v1

Lets you manage permission levels and related settings of a group. For detailed description please check documentation.

Installing

Install typings for Groups Settings API:

npm install @types/gapi.client.groupssettings@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('groupssettings', 'v1', () => {
    // now we can use gapi.client.groupssettings
    // ... 
});

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 = [     
        // View and manage the settings of a G Suite group
        'https://www.googleapis.com/auth/apps.groups.settings',
    ],
    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 Groups Settings API resources:

    
/* 
Gets one resource by id.  
*/
await gapi.client.groups.get({ groupUniqueId: "groupUniqueId",  }); 
    
/* 
Updates an existing resource. This method supports patch semantics.  
*/
await gapi.client.groups.patch({ groupUniqueId: "groupUniqueId",  }); 
    
/* 
Updates an existing resource.  
*/
await gapi.client.groups.update({ groupUniqueId: "groupUniqueId",  });