TypeScript typings for Google Chat API v1

The Google Chat API lets you build Chat apps to integrate your services with Google Chat and manage Chat resources such as spaces, members, and messages.
For detailed description please check documentation.

Installing

Install typings for Google Chat API:

``npm install @types/gapi.client.chat-v1 --save-dev`

`Usage`

You need to initialize Google API client in your code:

`typescript gapi.load('client', () => { // now we can use gapi.client // ... });`

Then load api client wrapper:

`typescript gapi.client.load( 'https://chat.googleapis.com/$discovery/rest?version=v1', () => { // now we can use: // gapi.client.chat }, );`

`typescript // Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback-- gapi.client.load('chat', 'v1', () => { // now we can use: // gapi.client.chat });`

Don't forget to authenticate your client before sending any request to resources:

`typescript // declare client_id registered in Google Developers Console var client_id = '', scope = [ // Delete conversations and spaces owned by your organization and remove access to associated files in Google Chat 'https://www.googleapis.com/auth/chat.admin.delete',

// View, add, update and remove members and managers in conversations owned by your organization 'https://www.googleapis.com/auth/chat.admin.memberships',

// View members and managers in conversations owned by your organization 'https://www.googleapis.com/auth/chat.admin.memberships.readonly',

// View or edit display name, description, and other metadata for all Google Chat conversations owned by your organization 'https://www.googleapis.com/auth/chat.admin.spaces',

// View display name, description, and other metadata for all Google Chat conversations owned by your organization 'https://www.googleapis.com/auth/chat.admin.spaces.readonly',

// On their own behalf, apps in Google Chat can delete conversations and spaces and remove access to associated files 'https://www.googleapis.com/auth/chat.app.delete',

// On their own behalf, apps in Google Chat can see, add, update, and remove members from conversations and spaces 'https://www.googleapis.com/auth/chat.app.memberships',

// On their own behalf, apps in Google Chat can see all messages and their associated reactions and message content 'https://www.googleapis.com/auth/chat.app.messages.readonly',

// On their own behalf, apps in Google Chat can create conversations and spaces and see or update their metadata (including history settings and access settings) 'https://www.googleapis.com/auth/chat.app.spaces',

// On their own behalf, apps in Google Chat can create conversations and spaces 'https://www.googleapis.com/auth/chat.app.spaces.create',

// Private Service: https://www.googleapis.com/auth/chat.bot 'https://www.googleapis.com/auth/chat.bot',

// View, create, and delete custom emoji in Google Chat 'https://www.googleapis.com/auth/chat.customemojis',

// View custom emoji in Google Chat 'https://www.googleapis.com/auth/chat.customemojis.readonly',

// Delete conversations and spaces and remove access to associated files in Google Chat 'https://www.googleapis.com/auth/chat.delete',

// Import spaces, messages, and memberships into Google Chat. 'https://www.googleapis.com/auth/chat.import',

// See, add, update, and remove members from conversations and spaces in Google Chat 'https://www.googleapis.com/auth/chat.memberships',

// Add and remove itself from conversations and spaces in Google Chat 'https://www.googleapis.com/auth/chat.memberships.app',

// View members in Google Chat conversations. 'https://www.googleapis.com/auth/chat.memberships.readonly',

// See, compose, send, update, and delete messages as well as their message content; add, see, and delete reactions to messages. 'https://www.googleapis.com/auth/chat.messages',

// Compose and send messages in Google Chat 'https://www.googleapis.com/auth/chat.messages.create',

// See, add, and delete reactions as well as their reaction content to messages in Google Chat 'https://www.googleapis.com/auth/chat.messages.reactions',

// Add reactions to messages in Google Chat 'https://www.googleapis.com/auth/chat.messages.reactions.create',

// View reactions as well as their reaction content to messages in Google Chat 'https://www.googleapis.com/auth/chat.messages.reactions.readonly',

// See messages as well as their reactions and message content in Google Chat 'https://www.googleapis.com/auth/chat.messages.readonly',

// Create conversations and spaces and see or update metadata (including history settings and access settings) in Google Chat 'https://www.googleapis.com/auth/chat.spaces',

// Create new conversations and spaces in Google Chat 'https://www.googleapis.com/auth/chat.spaces.create',

// View chat and spaces in Google Chat 'https://www.googleapis.com/auth/chat.spaces.readonly',

// View and modify last read time for Google Chat conversations 'https://www.googleapis.com/auth/chat.users.readstate',

// View last read time for Google Chat conversations 'https://www.googleapis.com/auth/chat.users.readstate.readonly',

// Read and update your space settings 'https://www.googleapis.com/auth/chat.users.spacesettings', ], immediate = true; // ...

gapi.auth.authorize( {client_id: client_id, scope: scope, immediate: immediate}, authResult => { if (authResult && !authResult.error) { / handle successful authorization / } else { / handle authorization error / } }, );`

After that you can use Google Chat API resources:

`typescript /* Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions. Requires user authentication with the authorization scope: -https://www.googleapis.com/auth/chat.customemojis*/ await gapi.client.chat.customEmojis.create({});

/* Deletes a custom emoji. By default, users can only delete custom emoji they created. Emoji managers assigned by the administrator can delete any custom emoji in the organization. See Learn about custom emojis in Google Chat. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions. Requires user authentication with the authorization scope: -https://www.googleapis.com/auth/chat.customemojis*/ await gapi.client.chat.customEmojis.delete({name: 'name'});

/* Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions. Requires user authentication with one of the following authorization scopes: -https://www.googleapis.com/auth/chat.customemojis.readonly - https://www.googleapis.com/auth/chat.customemojis*/ await gapi.client.chat.customEmojis.get({name: 'name'});

/* Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions. Requires user authentication with one of the following authorization scopes: -https://www.googleapis.com/auth/chat.customemojis.readonly - https://www.googleapis.com/auth/chat.customemojis*/ await gapi.client.chat.customEmojis.list({});

/* Downloads media. Download is supported on the URI/v1/media/{+name}?alt=media. */ await gapi.client.chat.media.download({resourceName: 'resourceName'});

/* Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication with one of the following authorization scopes: -https://www.googleapis.com/auth/chat.messages.create - https://www.googleapis.com/auth/chat.messages - https://www.googleapis.com/auth/chat.import(import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat. */ await gapi.client.chat.media.upload({parent: 'parent'});

/* Completes the import process for the specified space and makes it visible to users. Requires user authentication and domain-wide delegation with the authorization scope: -https://www.googleapis.com/auth/chat.importFor more information, see Authorize Google Chat apps to import data. */ await gapi.client.chat.spaces.completeImport({name: 'name'});

/* Creates a space. Can be used to create a named space, or a group chat inImport mode. For an example, see Create a space. Supports the following types of authentication: - App authentication with administrator approval and one of the following authorization scopes: - https://www.googleapis.com/auth/chat.app.spaces.create - https://www.googleapis.com/auth/chat.app.spaces - User authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.spaces.create - https://www.googleapis.com/auth/chat.spaces - https://www.googleapis.com/auth/chat.import (import mode spaces only) When authenticating as an app, the space.customer field must be set in the request. When authenticating as an app, the Chat app is added as a member of the space. However, unlike human authentication, the Chat app is not added as a space manager. By default, the Chat app can be removed from the space by all space members. To allow only space managers to remove the app from a space, set space.permission_settings.manage_apps to managers_allowed. Space membership upon creation depends on whether the space is created in Import mode: Import mode: No members are created. All other modes: The calling user is added as a member. This is: The app itself when using app authentication. The human user when using user authentication. If you receive the error message ALREADY_EXISTS when creating a space, try a different displayName. An existing space within the Google Workspace organization might already use this display name. */ await gapi.client.chat.spaces.create({});

/* Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space. Supports the following types of authentication: - App authentication with administrator approval and the authorization scope: -https://www.googleapis.com/auth/chat.app.delete (only in spaces the app created) - User authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.delete - https://www.googleapis.com/auth/chat.import (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and the following authorization scope is used: - https://www.googleapis.com/auth/chat.admin.delete*/ await gapi.client.chat.spaces.delete({name: 'name'});

/* Returns the existing direct message with the specified user. If no direct message space is found, returns a404 NOT_FOUND error. For an example, see Find a direct message. With app authentication, returns the direct message space between the specified user and the calling Chat app. With user authentication, returns the direct message space between the specified user and the authenticated user. Supports the following types of authentication: - App authentication with the authorization scope: - https://www.googleapis.com/auth/chat.bot - User authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.spaces.readonly - https://www.googleapis.com/auth/chat.spaces*/ await gapi.client.chat.spaces.findDirectMessage({});

/* Returns details about a space. For an example, see Get details about a space. Supports the following types of authentication: - App authentication with one of the following authorization scopes: -https://www.googleapis.com/auth/chat.bot - https://www.googleapis.com/auth/chat.app.spaces with administrator approval - User authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.spaces.readonly - https://www.googleapis.com/auth/chat.spaces - User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and one of the following authorization scopes is used: - https://www.googleapis.com/auth/chat.admin.spaces.readonly - https://www.googleapis.com/auth/chat.admin.spaces App authentication has the following limitations: - space.access_settings is only populated when using the chat.app.spaces scope. - space.predefind_permission_settings and space.permission_settings are only populated when using the chat.app.spacesscope, and only for spaces the app created. */ await gapi.client.chat.spaces.get({name: 'name'});

/* Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces. Supports the following types of authentication: - App authentication with the authorization scope: -https://www.googleapis.com/auth/chat.bot - User authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.spaces.readonly - https://www.googleapis.com/auth/chat.spaces To list all named spaces by Google Workspace organization, use the spaces.search()method using Workspace administrator privileges instead. */ await gapi.client.chat.spaces.list({});

/* Updates a space. For an example, see Update a space. If you're updating thedisplayName field and receive the error message ALREADY_EXISTS, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of authentication: - App authentication with administrator approval and one of the following authorization scopes: - https://www.googleapis.com/auth/chat.app.spaces - User authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.spaces - https://www.googleapis.com/auth/chat.import (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and the following authorization scopes is used: - https://www.googleapis.com/auth/chat.admin.spaces App authentication has the following limitations: - To update either space.predefined_permission_settings or space.permission_settings, the app must be the space creator. - Updating the space.access_settings.audienceis not supported for app authentication. */ await gapi.client.chat.spaces.patch({name: 'name'});

/* Returns a list of spaces in a Google Workspace organization based on an administrator's search. In the request, setuse_admin_access to true. For an example, see Search for and manage spaces. Requires user authentication with administrator privileges and one of the following authorization scopes: - https://www.googleapis.com/auth/chat.admin.spaces.readonly - https://www.googleapis.com/auth/chat.admin.spaces*/ await gapi.client.chat.spaces.search({});

/* Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members. To specify the human members to add, add memberships with the appropriatemembership.member.name. To add a human user, use users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id for the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789, you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789. To specify the Google groups to add, add memberships with the appropriate membership.group_member.name. To add or invite a Google group, use groups/{group}, where {group} is the id for the group from the Cloud Identity Groups API. For example, you can use Cloud Identity Groups lookup API to retrieve the ID 123456789 for group email group@example.com, then you can add the group to the space by setting the membership.group_member.name to groups/123456789. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set Space.singleUserBotDm to true and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see Invite or add a user or app to a space. If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message ALREADY_EXISTS when setting up a space, try a different displayName. An existing space within the Google Workspace organization might already use this display name. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.spaces.create - https://www.googleapis.com/auth/chat.spaces*/ await gapi.client.chat.spaces.setup({});``

For provenance information see Provenance section on NPM