// Copyright 2022 Luca Casonato. All rights reserved. MIT license.
/**
 * Google Chat API Client for Deno
 * ===============================
 * 
 * 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.
 * 
 * Docs: https://developers.google.com/hangouts/chat
 * Source: https://googleapis.deno.dev/v1/chat:v1.ts
 */

import { auth, CredentialsClient, GoogleAuth, request } from "/_/base@v1/mod.ts";
export { auth, GoogleAuth };
export type { CredentialsClient };

/**
 * 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.
 */
export class Chat {
  #client: CredentialsClient | undefined;
  #baseUrl: string;

  constructor(client?: CredentialsClient, baseUrl: string = "https://chat.googleapis.com/") {
    this.#client = client;
    this.#baseUrl = baseUrl;
  }

  /**
   * Downloads media. Download is supported on the URI
   * `/v1/media/{+name}?alt=media`.
   *
   * @param resourceName Name of the media that is being downloaded. See ReadRequest.resource_name.
   */
  async mediaDownload(resourceName: string): Promise<Media> {
    const url = new URL(`${this.#baseUrl}v1/media/${ resourceName }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as Media;
  }

  /**
   * Uploads an attachment. For an example, see [Upload media as a file
   * attachment](https://developers.google.com/workspace/chat/upload-media-attachments).
   * Requires user
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   * You can upload attachments up to 200 MB. Certain file types aren't
   * supported. For details, see [File types blocked by Google
   * Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).
   *
   * @param parent Required. Resource name of the Chat space in which the attachment is uploaded. Format "spaces/{space}".
   */
  async mediaUpload(parent: string, req: UploadAttachmentRequest): Promise<UploadAttachmentResponse> {
    const url = new URL(`${this.#baseUrl}v1/${ parent }/attachments:upload`);
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "POST",
      body,
    });
    return data as UploadAttachmentResponse;
  }

  /**
   * Completes the [import
   * process](https://developers.google.com/workspace/chat/import-data) for the
   * specified space and makes it visible to users. Requires [app
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * and domain-wide delegation. For more information, see [Authorize Google
   * Chat apps to import
   * data](https://developers.google.com/workspace/chat/authorize-import).
   *
   * @param name Required. Resource name of the import mode space. Format: `spaces/{space}`
   */
  async spacesCompleteImport(name: string, req: CompleteImportSpaceRequest): Promise<CompleteImportSpaceResponse> {
    const url = new URL(`${this.#baseUrl}v1/${ name }:completeImport`);
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "POST",
      body,
    });
    return deserializeCompleteImportSpaceResponse(data);
  }

  /**
   * Creates a space. Can be used to create a named space, or a group chat in
   * `Import mode`. For an example, see [Create a
   * space](https://developers.google.com/workspace/chat/create-spaces).
   * Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
   * in [Developer Preview](https://developers.google.com/workspace/preview) -
   * [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * When authenticating as an app, the `space.customer` field must be set in
   * the request. 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.
   *
   */
  async spacesCreate(req: Space, opts: SpacesCreateOptions = {}): Promise<Space> {
    req = serializeSpace(req);
    const url = new URL(`${this.#baseUrl}v1/spaces`);
    if (opts.requestId !== undefined) {
      url.searchParams.append("requestId", String(opts.requestId));
    }
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "POST",
      body,
    });
    return deserializeSpace(data);
  }

  /**
   * 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](https://developers.google.com/workspace/chat/delete-spaces).
   * Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
   * in [Developer Preview](https://developers.google.com/workspace/preview) -
   * [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * You can authenticate and authorize this method with administrator
   * privileges by setting the `use_admin_access` field in the request.
   *
   * @param name Required. Resource name of the space to delete. Format: `spaces/{space}`
   */
  async spacesDelete(name: string, opts: SpacesDeleteOptions = {}): Promise<Empty> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.useAdminAccess !== undefined) {
      url.searchParams.append("useAdminAccess", String(opts.useAdminAccess));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "DELETE",
    });
    return data as Empty;
  }

  /**
   * Returns the existing direct message with the specified user. If no direct
   * message space is found, returns a `404 NOT_FOUND` error. For an example,
   * see [Find a direct
   * message](/chat/api/guides/v1/spaces/find-direct-message). With [app
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app),
   * returns the direct message space between the specified user and the calling
   * Chat app. With [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
   * returns the direct message space between the specified user and the
   * authenticated user. // Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * - [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   *
   */
  async spacesFindDirectMessage(opts: SpacesFindDirectMessageOptions = {}): Promise<Space> {
    const url = new URL(`${this.#baseUrl}v1/spaces:findDirectMessage`);
    if (opts.name !== undefined) {
      url.searchParams.append("name", String(opts.name));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeSpace(data);
  }

  /**
   * Returns details about a space. For an example, see [Get details about a
   * space](https://developers.google.com/workspace/chat/get-spaces). Supports
   * the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * - [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * You can authenticate and authorize this method with administrator
   * privileges by setting the `use_admin_access` field in the request.
   *
   * @param name Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}`
   */
  async spacesGet(name: string, opts: SpacesGetOptions = {}): Promise<Space> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.useAdminAccess !== undefined) {
      url.searchParams.append("useAdminAccess", String(opts.useAdminAccess));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeSpace(data);
  }

  /**
   * 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](https://developers.google.com/workspace/chat/list-spaces). Supports
   * the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * - [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * To list all named spaces by Google Workspace organization, use the
   * [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
   * method using Workspace administrator privileges instead.
   *
   */
  async spacesList(opts: SpacesListOptions = {}): Promise<ListSpacesResponse> {
    const url = new URL(`${this.#baseUrl}v1/spaces`);
    if (opts.filter !== undefined) {
      url.searchParams.append("filter", String(opts.filter));
    }
    if (opts.pageSize !== undefined) {
      url.searchParams.append("pageSize", String(opts.pageSize));
    }
    if (opts.pageToken !== undefined) {
      url.searchParams.append("pageToken", String(opts.pageToken));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeListSpacesResponse(data);
  }

  /**
   * Creates a membership for the calling Chat app, a user, or a Google Group.
   * Creating memberships for other Chat apps isn't supported. When creating a
   * membership, if the specified member has their auto-accept policy turned
   * off, then they're invited, and must accept the space invitation before
   * joining. Otherwise, creating a membership adds the member directly to the
   * specified space. Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
   * in [Developer Preview](https://developers.google.com/workspace/preview) -
   * [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * You can authenticate and authorize this method with administrator
   * privileges by setting the `use_admin_access` field in the request. For
   * example usage, see: - [Invite or add a user to a
   * space](https://developers.google.com/workspace/chat/create-members#create-user-membership).
   * - [Invite or add a Google Group to a
   * space](https://developers.google.com/workspace/chat/create-members#create-group-membership).
   * - [Add the Chat app to a
   * space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).
   *
   * @param parent Required. The resource name of the space for which to create the membership. Format: spaces/{space}
   */
  async spacesMembersCreate(parent: string, req: Membership, opts: SpacesMembersCreateOptions = {}): Promise<Membership> {
    req = serializeMembership(req);
    const url = new URL(`${this.#baseUrl}v1/${ parent }/members`);
    if (opts.useAdminAccess !== undefined) {
      url.searchParams.append("useAdminAccess", String(opts.useAdminAccess));
    }
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "POST",
      body,
    });
    return deserializeMembership(data);
  }

  /**
   * Deletes a membership. For an example, see [Remove a user or a Google Chat
   * app from a
   * space](https://developers.google.com/workspace/chat/delete-members).
   * Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
   * in [Developer Preview](https://developers.google.com/workspace/preview) -
   * [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * You can authenticate and authorize this method with administrator
   * privileges by setting the `use_admin_access` field in the request.
   *
   * @param name Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope and `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.
   */
  async spacesMembersDelete(name: string, opts: SpacesMembersDeleteOptions = {}): Promise<Membership> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.useAdminAccess !== undefined) {
      url.searchParams.append("useAdminAccess", String(opts.useAdminAccess));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "DELETE",
    });
    return deserializeMembership(data);
  }

  /**
   * Returns details about a membership. For an example, see [Get details about
   * a user's or Google Chat app's
   * membership](https://developers.google.com/workspace/chat/get-members).
   * Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * - [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * You can authenticate and authorize this method with administrator
   * privileges by setting the `use_admin_access` field in the request.
   *
   * @param name Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.
   */
  async spacesMembersGet(name: string, opts: SpacesMembersGetOptions = {}): Promise<Membership> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.useAdminAccess !== undefined) {
      url.searchParams.append("useAdminAccess", String(opts.useAdminAccess));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeMembership(data);
  }

  /**
   * Lists memberships in a space. For an example, see [List users and Google
   * Chat apps in a
   * space](https://developers.google.com/workspace/chat/list-members). Listing
   * memberships with [app
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * lists memberships in spaces that the Chat app has access to, but excludes
   * Chat app memberships, including its own. Listing memberships with [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * lists memberships in spaces that the authenticated user has access to.
   * Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * - [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * You can authenticate and authorize this method with administrator
   * privileges by setting the `use_admin_access` field in the request.
   *
   * @param parent Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}
   */
  async spacesMembersList(parent: string, opts: SpacesMembersListOptions = {}): Promise<ListMembershipsResponse> {
    const url = new URL(`${this.#baseUrl}v1/${ parent }/members`);
    if (opts.filter !== undefined) {
      url.searchParams.append("filter", String(opts.filter));
    }
    if (opts.pageSize !== undefined) {
      url.searchParams.append("pageSize", String(opts.pageSize));
    }
    if (opts.pageToken !== undefined) {
      url.searchParams.append("pageToken", String(opts.pageToken));
    }
    if (opts.showGroups !== undefined) {
      url.searchParams.append("showGroups", String(opts.showGroups));
    }
    if (opts.showInvited !== undefined) {
      url.searchParams.append("showInvited", String(opts.showInvited));
    }
    if (opts.useAdminAccess !== undefined) {
      url.searchParams.append("useAdminAccess", String(opts.useAdminAccess));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeListMembershipsResponse(data);
  }

  /**
   * Updates a membership. For an example, see [Update a user's membership in a
   * space](https://developers.google.com/workspace/chat/update-members).
   * Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
   * in [Developer Preview](https://developers.google.com/workspace/preview) -
   * [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * You can authenticate and authorize this method with administrator
   * privileges by setting the `use_admin_access` field in the request.
   *
   * @param name Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`
   */
  async spacesMembersPatch(name: string, req: Membership, opts: SpacesMembersPatchOptions = {}): Promise<Membership> {
    req = serializeMembership(req);
    opts = serializeSpacesMembersPatchOptions(opts);
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.updateMask !== undefined) {
      url.searchParams.append("updateMask", String(opts.updateMask));
    }
    if (opts.useAdminAccess !== undefined) {
      url.searchParams.append("useAdminAccess", String(opts.useAdminAccess));
    }
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "PATCH",
      body,
    });
    return deserializeMembership(data);
  }

  /**
   * Gets the metadata of a message attachment. The attachment data is fetched
   * using the [media
   * API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download).
   * For an example, see [Get metadata about a message
   * attachment](https://developers.google.com/workspace/chat/get-media-attachments).
   * Requires [app
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
   *
   * @param name Required. Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.
   */
  async spacesMessagesAttachmentsGet(name: string): Promise<Attachment> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as Attachment;
  }

  /**
   * Creates a message in a Google Chat space. For an example, see [Send a
   * message](https://developers.google.com/workspace/chat/create-messages). The
   * `create()` method requires either [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * or [app
   * authentication](https://developers.google.com/workspace/chat/authorize-import).
   * Chat attributes the message sender differently depending on the type of
   * authentication that you use in your request. The following image shows how
   * Chat attributes a message when you use app authentication. Chat displays
   * the Chat app as the message sender. The content of the message can contain
   * text (`text`), cards (`cardsV2`), and accessory widgets
   * (`accessoryWidgets`). ![Message sent with app
   * authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg)
   * The following image shows how Chat attributes a message when you use user
   * authentication. Chat displays the user as the message sender and attributes
   * the Chat app to the message by displaying its name. The content of message
   * can only contain text (`text`). ![Message sent with user
   * authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg)
   * The maximum message size, including the message contents, is 32,000 bytes.
   * For
   * [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks)
   * requests, the response doesn't contain the full message. The response only
   * populates the `name` and `thread.name` fields in addition to the
   * information that was in the request.
   *
   * @param parent Required. The resource name of the space in which to create a message. Format: `spaces/{space}`
   */
  async spacesMessagesCreate(parent: string, req: Message, opts: SpacesMessagesCreateOptions = {}): Promise<Message> {
    req = serializeMessage(req);
    const url = new URL(`${this.#baseUrl}v1/${ parent }/messages`);
    if (opts.messageId !== undefined) {
      url.searchParams.append("messageId", String(opts.messageId));
    }
    if (opts.messageReplyOption !== undefined) {
      url.searchParams.append("messageReplyOption", String(opts.messageReplyOption));
    }
    if (opts.requestId !== undefined) {
      url.searchParams.append("requestId", String(opts.requestId));
    }
    if (opts.threadKey !== undefined) {
      url.searchParams.append("threadKey", String(opts.threadKey));
    }
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "POST",
      body,
    });
    return deserializeMessage(data);
  }

  /**
   * Deletes a message. For an example, see [Delete a
   * message](https://developers.google.com/workspace/chat/delete-messages).
   * Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * - [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * When using app authentication, requests can only delete messages created by
   * the calling Chat app.
   *
   * @param name Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
   */
  async spacesMessagesDelete(name: string, opts: SpacesMessagesDeleteOptions = {}): Promise<Empty> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.force !== undefined) {
      url.searchParams.append("force", String(opts.force));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "DELETE",
    });
    return data as Empty;
  }

  /**
   * Returns details about a message. For an example, see [Get details about a
   * message](https://developers.google.com/workspace/chat/get-messages).
   * Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * - [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * Note: Might return a message from a blocked member or space.
   *
   * @param name Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
   */
  async spacesMessagesGet(name: string): Promise<Message> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeMessage(data);
  }

  /**
   * Lists messages in a space that the caller is a member of, including
   * messages from blocked members and spaces. If you list messages from a space
   * with no messages, the response is an empty object. When using a REST/HTTP
   * interface, the response contains an empty JSON object, `{}`. For an
   * example, see [List
   * messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list).
   * Requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   *
   * @param parent Required. The resource name of the space to list messages from. Format: `spaces/{space}`
   */
  async spacesMessagesList(parent: string, opts: SpacesMessagesListOptions = {}): Promise<ListMessagesResponse> {
    const url = new URL(`${this.#baseUrl}v1/${ parent }/messages`);
    if (opts.filter !== undefined) {
      url.searchParams.append("filter", String(opts.filter));
    }
    if (opts.orderBy !== undefined) {
      url.searchParams.append("orderBy", String(opts.orderBy));
    }
    if (opts.pageSize !== undefined) {
      url.searchParams.append("pageSize", String(opts.pageSize));
    }
    if (opts.pageToken !== undefined) {
      url.searchParams.append("pageToken", String(opts.pageToken));
    }
    if (opts.showDeleted !== undefined) {
      url.searchParams.append("showDeleted", String(opts.showDeleted));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeListMessagesResponse(data);
  }

  /**
   * Updates a message. There's a difference between the `patch` and `update`
   * methods. The `patch` method uses a `patch` request while the `update`
   * method uses a `put` request. We recommend using the `patch` method. For an
   * example, see [Update a
   * message](https://developers.google.com/workspace/chat/update-messages).
   * Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * - [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * When using app authentication, requests can only update messages created by
   * the calling Chat app.
   *
   * @param name Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
   */
  async spacesMessagesPatch(name: string, req: Message, opts: SpacesMessagesPatchOptions = {}): Promise<Message> {
    req = serializeMessage(req);
    opts = serializeSpacesMessagesPatchOptions(opts);
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.allowMissing !== undefined) {
      url.searchParams.append("allowMissing", String(opts.allowMissing));
    }
    if (opts.updateMask !== undefined) {
      url.searchParams.append("updateMask", String(opts.updateMask));
    }
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "PATCH",
      body,
    });
    return deserializeMessage(data);
  }

  /**
   * Creates a reaction and adds it to a message. Only unicode emojis are
   * supported. For an example, see [Add a reaction to a
   * message](https://developers.google.com/workspace/chat/create-reactions).
   * Requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   *
   * @param parent Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}`
   */
  async spacesMessagesReactionsCreate(parent: string, req: Reaction): Promise<Reaction> {
    const url = new URL(`${this.#baseUrl}v1/${ parent }/reactions`);
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "POST",
      body,
    });
    return data as Reaction;
  }

  /**
   * Deletes a reaction to a message. Only unicode emojis are supported. For an
   * example, see [Delete a
   * reaction](https://developers.google.com/workspace/chat/delete-reactions).
   * Requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   *
   * @param name Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`
   */
  async spacesMessagesReactionsDelete(name: string): Promise<Empty> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "DELETE",
    });
    return data as Empty;
  }

  /**
   * Lists reactions to a message. For an example, see [List reactions for a
   * message](https://developers.google.com/workspace/chat/list-reactions).
   * Requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   *
   * @param parent Required. The message users reacted to. Format: `spaces/{space}/messages/{message}`
   */
  async spacesMessagesReactionsList(parent: string, opts: SpacesMessagesReactionsListOptions = {}): Promise<ListReactionsResponse> {
    const url = new URL(`${this.#baseUrl}v1/${ parent }/reactions`);
    if (opts.filter !== undefined) {
      url.searchParams.append("filter", String(opts.filter));
    }
    if (opts.pageSize !== undefined) {
      url.searchParams.append("pageSize", String(opts.pageSize));
    }
    if (opts.pageToken !== undefined) {
      url.searchParams.append("pageToken", String(opts.pageToken));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as ListReactionsResponse;
  }

  /**
   * Updates a message. There's a difference between the `patch` and `update`
   * methods. The `patch` method uses a `patch` request while the `update`
   * method uses a `put` request. We recommend using the `patch` method. For an
   * example, see [Update a
   * message](https://developers.google.com/workspace/chat/update-messages).
   * Supports the following types of
   * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * - [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * When using app authentication, requests can only update messages created by
   * the calling Chat app.
   *
   * @param name Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
   */
  async spacesMessagesUpdate(name: string, req: Message, opts: SpacesMessagesUpdateOptions = {}): Promise<Message> {
    req = serializeMessage(req);
    opts = serializeSpacesMessagesUpdateOptions(opts);
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.allowMissing !== undefined) {
      url.searchParams.append("allowMissing", String(opts.allowMissing));
    }
    if (opts.updateMask !== undefined) {
      url.searchParams.append("updateMask", String(opts.updateMask));
    }
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "PUT",
      body,
    });
    return deserializeMessage(data);
  }

  /**
   * Updates a space. For an example, see [Update a
   * space](https://developers.google.com/workspace/chat/update-spaces). If
   * you're updating the `displayName` 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](https://developers.google.com/workspace/chat/authenticate-authorize):
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
   * in [Developer Preview](https://developers.google.com/workspace/preview) -
   * [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * You can authenticate and authorize this method with administrator
   * privileges by setting the `use_admin_access` field in the request.
   *
   * @param name Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.
   */
  async spacesPatch(name: string, req: Space, opts: SpacesPatchOptions = {}): Promise<Space> {
    req = serializeSpace(req);
    opts = serializeSpacesPatchOptions(opts);
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.updateMask !== undefined) {
      url.searchParams.append("updateMask", String(opts.updateMask));
    }
    if (opts.useAdminAccess !== undefined) {
      url.searchParams.append("useAdminAccess", String(opts.useAdminAccess));
    }
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "PATCH",
      body,
    });
    return deserializeSpace(data);
  }

  /**
   * Returns a list of spaces in a Google Workspace organization based on an
   * administrator's search. Requires [user authentication with administrator
   * privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges).
   * In the request, set `use_admin_access` to `true`.
   *
   */
  async spacesSearch(opts: SpacesSearchOptions = {}): Promise<SearchSpacesResponse> {
    const url = new URL(`${this.#baseUrl}v1/spaces:search`);
    if (opts.orderBy !== undefined) {
      url.searchParams.append("orderBy", String(opts.orderBy));
    }
    if (opts.pageSize !== undefined) {
      url.searchParams.append("pageSize", String(opts.pageSize));
    }
    if (opts.pageToken !== undefined) {
      url.searchParams.append("pageToken", String(opts.pageToken));
    }
    if (opts.query !== undefined) {
      url.searchParams.append("query", String(opts.query));
    }
    if (opts.useAdminAccess !== undefined) {
      url.searchParams.append("useAdminAccess", String(opts.useAdminAccess));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeSearchSpacesResponse(data);
  }

  /**
   * 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](https://developers.google.com/workspace/chat/set-up-spaces). To
   * specify the human members to add, add memberships with the appropriate
   * `membership.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](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
   * 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](https://developers.google.com/workspace/chat/create-members). 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](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   *
   */
  async spacesSetup(req: SetUpSpaceRequest): Promise<Space> {
    req = serializeSetUpSpaceRequest(req);
    const url = new URL(`${this.#baseUrl}v1/spaces:setup`);
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "POST",
      body,
    });
    return deserializeSpace(data);
  }

  /**
   * Returns an event from a Google Chat space. The [event
   * payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload)
   * contains the most recent version of the resource that changed. For example,
   * if you request an event about a new message but the message was later
   * updated, the server returns the updated `Message` resource in the event
   * payload. Note: The `permissionSettings` field is not returned in the Space
   * object of the Space event data for this request. Requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   * To get an event, the authenticated user must be a member of the space. For
   * an example, see [Get details about an event from a Google Chat
   * space](https://developers.google.com/workspace/chat/get-space-event).
   *
   * @param name Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`
   */
  async spacesSpaceEventsGet(name: string): Promise<SpaceEvent> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeSpaceEvent(data);
  }

  /**
   * Lists events from a Google Chat space. For each event, the
   * [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload)
   * contains the most recent version of the Chat resource. For example, if you
   * list events about new space members, the server returns `Membership`
   * resources that contain the latest membership details. If new members were
   * removed during the requested period, the event payload contains an empty
   * `Membership` resource. Requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   * To list events, the authenticated user must be a member of the space. For
   * an example, see [List events from a Google Chat
   * space](https://developers.google.com/workspace/chat/list-space-events).
   *
   * @param parent Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`.
   */
  async spacesSpaceEventsList(parent: string, opts: SpacesSpaceEventsListOptions = {}): Promise<ListSpaceEventsResponse> {
    const url = new URL(`${this.#baseUrl}v1/${ parent }/spaceEvents`);
    if (opts.filter !== undefined) {
      url.searchParams.append("filter", String(opts.filter));
    }
    if (opts.pageSize !== undefined) {
      url.searchParams.append("pageSize", String(opts.pageSize));
    }
    if (opts.pageToken !== undefined) {
      url.searchParams.append("pageToken", String(opts.pageToken));
    }
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeListSpaceEventsResponse(data);
  }

  /**
   * Returns details about a user's read state within a space, used to identify
   * read and unread messages. For an example, see [Get details about a user's
   * space read
   * state](https://developers.google.com/workspace/chat/get-space-read-state).
   * Requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   *
   * @param name Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState
   */
  async usersSpacesGetSpaceReadState(name: string): Promise<SpaceReadState> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeSpaceReadState(data);
  }

  /**
   * Returns details about a user's read state within a thread, used to
   * identify read and unread messages. For an example, see [Get details about a
   * user's thread read
   * state](https://developers.google.com/workspace/chat/get-thread-read-state).
   * Requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   *
   * @param name Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState
   */
  async usersSpacesThreadsGetThreadReadState(name: string): Promise<ThreadReadState> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return deserializeThreadReadState(data);
  }

  /**
   * Updates a user's read state within a space, used to identify read and
   * unread messages. For an example, see [Update a user's space read
   * state](https://developers.google.com/workspace/chat/update-space-read-state).
   * Requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   *
   * @param name Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`
   */
  async usersSpacesUpdateSpaceReadState(name: string, req: SpaceReadState, opts: UsersSpacesUpdateSpaceReadStateOptions = {}): Promise<SpaceReadState> {
    req = serializeSpaceReadState(req);
    opts = serializeUsersSpacesUpdateSpaceReadStateOptions(opts);
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    if (opts.updateMask !== undefined) {
      url.searchParams.append("updateMask", String(opts.updateMask));
    }
    const body = JSON.stringify(req);
    const data = await request(url.href, {
      client: this.#client,
      method: "PATCH",
      body,
    });
    return deserializeSpaceReadState(data);
  }
}

/**
 * One or more interactive widgets that appear at the bottom of a message. For
 * details, see [Add interactive widgets at the bottom of a
 * message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).
 */
export interface AccessoryWidget {
  /**
   * A list of buttons.
   */
  buttonList?: GoogleAppsCardV1ButtonList;
}

function serializeAccessoryWidget(data: any): AccessoryWidget {
  return {
    ...data,
    buttonList: data["buttonList"] !== undefined ? serializeGoogleAppsCardV1ButtonList(data["buttonList"]) : undefined,
  };
}

function deserializeAccessoryWidget(data: any): AccessoryWidget {
  return {
    ...data,
    buttonList: data["buttonList"] !== undefined ? deserializeGoogleAppsCardV1ButtonList(data["buttonList"]) : undefined,
  };
}

/**
 * Represents the [access
 * setting](https://support.google.com/chat/answer/11971020) of the space.
 */
export interface AccessSettings {
  /**
   * Output only. Indicates the access state of the space.
   */
  readonly accessState?:  | "ACCESS_STATE_UNSPECIFIED" | "PRIVATE" | "DISCOVERABLE";
  /**
   * Optional. The resource name of the [target
   * audience](https://support.google.com/a/answer/9934697) who can discover the
   * space, join the space, and preview the messages in the space. If unset,
   * only users or Google Groups who have been individually invited or added to
   * the space can access it. For details, see [Make a space discoverable to a
   * target
   * audience](https://developers.google.com/workspace/chat/space-target-audience).
   * Format: `audiences/{audience}` To use the default target audience for the
   * Google Workspace organization, set to `audiences/default`. Reading the
   * target audience supports: - [User
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
   * - [App
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * with [administrator approval](https://support.google.com/a?p=chat-app-auth)
   * with the `chat.app.spaces` scope in [Developer
   * Preview](https://developers.google.com/workspace/preview). This field is
   * not populated when using the `chat.bot` scope with [app
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
   * Setting the target audience requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   */
  audience?: string;
}

/**
 * List of string parameters to supply when the action method is invoked. For
 * example, consider three snooze buttons: snooze now, snooze one day, snooze
 * next week. You might use `action method = snooze()`, passing the snooze type
 * and snooze time in the list of string parameters.
 */
export interface ActionParameter {
  /**
   * The name of the parameter for the action script.
   */
  key?: string;
  /**
   * The value of the parameter.
   */
  value?: string;
}

/**
 * Parameters that a Chat app can use to configure how its response is posted.
 */
export interface ActionResponse {
  /**
   * Input only. A response to an interaction event related to a
   * [dialog](https://developers.google.com/workspace/chat/dialogs). Must be
   * accompanied by `ResponseType.Dialog`.
   */
  dialogAction?: DialogAction;
  /**
   * Input only. The type of Chat app response.
   */
  type?:  | "TYPE_UNSPECIFIED" | "NEW_MESSAGE" | "UPDATE_MESSAGE" | "UPDATE_USER_MESSAGE_CARDS" | "REQUEST_CONFIG" | "DIALOG" | "UPDATE_WIDGET";
  /**
   * Input only. The response of the updated widget.
   */
  updatedWidget?: UpdatedWidget;
  /**
   * Input only. URL for users to authenticate or configure. (Only for
   * `REQUEST_CONFIG` response types.)
   */
  url?: string;
}

function serializeActionResponse(data: any): ActionResponse {
  return {
    ...data,
    dialogAction: data["dialogAction"] !== undefined ? serializeDialogAction(data["dialogAction"]) : undefined,
  };
}

function deserializeActionResponse(data: any): ActionResponse {
  return {
    ...data,
    dialogAction: data["dialogAction"] !== undefined ? deserializeDialogAction(data["dialogAction"]) : undefined,
  };
}

/**
 * Represents the status for a request to either invoke or submit a
 * [dialog](https://developers.google.com/workspace/chat/dialogs).
 */
export interface ActionStatus {
  /**
   * The status code.
   */
  statusCode?:  | "OK" | "CANCELLED" | "UNKNOWN" | "INVALID_ARGUMENT" | "DEADLINE_EXCEEDED" | "NOT_FOUND" | "ALREADY_EXISTS" | "PERMISSION_DENIED" | "UNAUTHENTICATED" | "RESOURCE_EXHAUSTED" | "FAILED_PRECONDITION" | "ABORTED" | "OUT_OF_RANGE" | "UNIMPLEMENTED" | "INTERNAL" | "UNAVAILABLE" | "DATA_LOSS";
  /**
   * The message to send users about the status of their request. If unset, a
   * generic message based on the `status_code` is sent.
   */
  userFacingMessage?: string;
}

/**
 * Output only. Annotations associated with the plain-text body of the message.
 * To add basic formatting to a text message, see [Format text
 * messages](https://developers.google.com/workspace/chat/format-messages).
 * Example plain-text message body: ``` Hello @FooBot how are you!" ``` The
 * corresponding annotations metadata: ``` "annotations":[{
 * "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": {
 * "name":"users/{user}", "displayName":"FooBot",
 * "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }]
 * ```
 */
export interface Annotation {
  /**
   * Length of the substring in the plain-text message body this annotation
   * corresponds to.
   */
  length?: number;
  /**
   * The metadata for a rich link.
   */
  richLinkMetadata?: RichLinkMetadata;
  /**
   * The metadata for a slash command.
   */
  slashCommand?: SlashCommandMetadata;
  /**
   * Start index (0-based, inclusive) in the plain-text message body this
   * annotation corresponds to.
   */
  startIndex?: number;
  /**
   * The type of this annotation.
   */
  type?:  | "ANNOTATION_TYPE_UNSPECIFIED" | "USER_MENTION" | "SLASH_COMMAND" | "RICH_LINK";
  /**
   * The metadata of user mention.
   */
  userMention?: UserMentionMetadata;
}

function serializeAnnotation(data: any): Annotation {
  return {
    ...data,
    slashCommand: data["slashCommand"] !== undefined ? serializeSlashCommandMetadata(data["slashCommand"]) : undefined,
  };
}

function deserializeAnnotation(data: any): Annotation {
  return {
    ...data,
    slashCommand: data["slashCommand"] !== undefined ? deserializeSlashCommandMetadata(data["slashCommand"]) : undefined,
  };
}

/**
 * A GIF image that's specified by a URL.
 */
export interface AttachedGif {
  /**
   * Output only. The URL that hosts the GIF image.
   */
  readonly uri?: string;
}

/**
 * An attachment in Google Chat.
 */
export interface Attachment {
  /**
   * Optional. A reference to the attachment data. This field is used to create
   * or update messages with attachments, or with the media API to download the
   * attachment data.
   */
  attachmentDataRef?: AttachmentDataRef;
  /**
   * Output only. The original file name for the content, not the full path.
   */
  readonly contentName?: string;
  /**
   * Output only. The content type (MIME type) of the file.
   */
  readonly contentType?: string;
  /**
   * Output only. The download URL which should be used to allow a human user
   * to download the attachment. Chat apps shouldn't use this URL to download
   * attachment content.
   */
  readonly downloadUri?: string;
  /**
   * Output only. A reference to the Google Drive attachment. This field is
   * used with the Google Drive API.
   */
  readonly driveDataRef?: DriveDataRef;
  /**
   * Optional. Resource name of the attachment, in the form
   * `spaces/{space}/messages/{message}/attachments/{attachment}`.
   */
  name?: string;
  /**
   * Output only. The source of the attachment.
   */
  readonly source?:  | "SOURCE_UNSPECIFIED" | "DRIVE_FILE" | "UPLOADED_CONTENT";
  /**
   * Output only. The thumbnail URL which should be used to preview the
   * attachment to a human user. Chat apps shouldn't use this URL to download
   * attachment content.
   */
  readonly thumbnailUri?: string;
}

/**
 * A reference to the attachment data.
 */
export interface AttachmentDataRef {
  /**
   * Optional. Opaque token containing a reference to an uploaded attachment.
   * Treated by clients as an opaque string and used to create or update Chat
   * messages with attachments.
   */
  attachmentUploadToken?: string;
  /**
   * Optional. The resource name of the attachment data. This field is used
   * with the media API to download the attachment data.
   */
  resourceName?: string;
}

/**
 * A button. Can be a text button or an image button.
 */
export interface Button {
  /**
   * A button with image and `onclick` action.
   */
  imageButton?: ImageButton;
  /**
   * A button with text and `onclick` action.
   */
  textButton?: TextButton;
}

/**
 * A card is a UI element that can contain UI widgets such as text and images.
 */
export interface Card {
  /**
   * The actions of this card.
   */
  cardActions?: CardAction[];
  /**
   * The header of the card. A header usually contains a title and an image.
   */
  header?: CardHeader;
  /**
   * Name of the card.
   */
  name?: string;
  /**
   * Sections are separated by a line divider.
   */
  sections?: Section[];
}

/**
 * A card action is the action associated with the card. For an invoice card, a
 * typical action would be: delete invoice, email invoice or open the invoice in
 * browser. Not supported by Google Chat apps.
 */
export interface CardAction {
  /**
   * The label used to be displayed in the action menu item.
   */
  actionLabel?: string;
  /**
   * The onclick action for this action item.
   */
  onClick?: OnClick;
}

export interface CardHeader {
  /**
   * The image's type (for example, square border or circular border).
   */
  imageStyle?:  | "IMAGE_STYLE_UNSPECIFIED" | "IMAGE" | "AVATAR";
  /**
   * The URL of the image in the card header.
   */
  imageUrl?: string;
  /**
   * The subtitle of the card header.
   */
  subtitle?: string;
  /**
   * The title must be specified. The header has a fixed height: if both a
   * title and subtitle is specified, each takes up one line. If only the title
   * is specified, it takes up both lines.
   */
  title?: string;
}

/**
 * A
 * [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards)
 * in a Google Chat message. Only Chat apps can create cards. If your Chat app
 * [authenticates as a
 * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
 * the message can't contain cards. [Card
 * builder](https://addons.gsuite.google.com/uikit/builder)
 */
export interface CardWithId {
  /**
   * A card. Maximum size is 32 KB.
   */
  card?: GoogleAppsCardV1Card;
  /**
   * Required if the message contains multiple cards. A unique identifier for a
   * card in a message.
   */
  cardId?: string;
}

function serializeCardWithId(data: any): CardWithId {
  return {
    ...data,
    card: data["card"] !== undefined ? serializeGoogleAppsCardV1Card(data["card"]) : undefined,
  };
}

function deserializeCardWithId(data: any): CardWithId {
  return {
    ...data,
    card: data["card"] !== undefined ? deserializeGoogleAppsCardV1Card(data["card"]) : undefined,
  };
}

/**
 * JSON payload of error messages. If the Cloud Logging API is enabled, these
 * error messages are logged to [Google Cloud
 * Logging](https://cloud.google.com/logging/docs).
 */
export interface ChatAppLogEntry {
  /**
   * The deployment that caused the error. For Chat apps built in Apps Script,
   * this is the deployment ID defined by Apps Script.
   */
  deployment?: string;
  /**
   * The unencrypted `callback_method` name that was running when the error was
   * encountered.
   */
  deploymentFunction?: string;
  /**
   * The error code and message.
   */
  error?: Status;
}

/**
 * For a `SelectionInput` widget that uses a multiselect menu, a data source
 * from Google Chat. The data source populates selection items for the
 * multiselect menu. For example, a user can select Google Chat spaces that
 * they're a member of. [Google Chat
 * apps](https://developers.google.com/workspace/chat):
 */
export interface ChatClientDataSourceMarkup {
  /**
   * Google Chat spaces that the user is a member of.
   */
  spaceDataSource?: SpaceDataSource;
}

/**
 * Data for Chat space links.
 */
export interface ChatSpaceLinkData {
  /**
   * The message of the linked Chat space resource. Format:
   * `spaces/{space}/messages/{message}`
   */
  message?: string;
  /**
   * The space of the linked Chat space resource. Format: `spaces/{space}`
   */
  space?: string;
  /**
   * The thread of the linked Chat space resource. Format:
   * `spaces/{space}/threads/{thread}`
   */
  thread?: string;
}

/**
 * Represents a color in the RGBA color space. This representation is designed
 * for simplicity of conversion to and from color representations in various
 * languages over compactness. For example, the fields of this representation
 * can be trivially provided to the constructor of `java.awt.Color` in Java; it
 * can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
 * method in iOS; and, with just a little work, it can be easily formatted into
 * a CSS `rgba()` string in JavaScript. This reference page doesn't have
 * information about the absolute color space that should be used to interpret
 * the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default,
 * applications should assume the sRGB color space. When color equality needs to
 * be decided, implementations, unless documented otherwise, treat two colors as
 * equal if all their red, green, blue, and alpha values each differ by at most
 * `1e-5`. Example (Java): import com.google.type.Color; // ... public static
 * java.awt.Color fromProto(Color protocolor) { float alpha =
 * protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new
 * java.awt.Color( protocolor.getRed(), protocolor.getGreen(),
 * protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color
 * color) { float red = (float) color.getRed(); float green = (float)
 * color.getGreen(); float blue = (float) color.getBlue(); float denominator =
 * 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red /
 * denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int
 * alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue
 * .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return
 * resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor*
 * fromProto(Color* protocolor) { float red = [protocolor red]; float green =
 * [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper
 * = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha =
 * [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green
 * blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat
 * red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue
 * alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result
 * setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <=
 * 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result
 * autorelease]; return result; } // ... Example (JavaScript): // ... var
 * protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0;
 * var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0;
 * var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255);
 * var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return
 * rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value ||
 * 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(',
 * rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor =
 * function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green
 * << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 -
 * hexString.length; var resultBuilder = ['#']; for (var i = 0; i <
 * missingZeros; i++) { resultBuilder.push('0'); }
 * resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...
 */
export interface Color {
  /**
   * The fraction of this color that should be applied to the pixel. That is,
   * the final pixel color is defined by the equation: `pixel color = alpha *
   * (this color) + (1.0 - alpha) * (background color)` This means that a value
   * of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to
   * a completely transparent color. This uses a wrapper message rather than a
   * simple float scalar so that it is possible to distinguish between a default
   * value and the value being unset. If omitted, this color object is rendered
   * as a solid color (as if the alpha value had been explicitly given a value
   * of 1.0).
   */
  alpha?: number;
  /**
   * The amount of blue in the color as a value in the interval [0, 1].
   */
  blue?: number;
  /**
   * The amount of green in the color as a value in the interval [0, 1].
   */
  green?: number;
  /**
   * The amount of red in the color as a value in the interval [0, 1].
   */
  red?: number;
}

/**
 * Represents information about the user's client, such as locale, host app,
 * and platform. For Chat apps, `CommonEventObject` includes data submitted by
 * users interacting with cards, like data entered in
 * [dialogs](https://developers.google.com/chat/how-tos/dialogs).
 */
export interface CommonEventObject {
  /**
   * A map containing the values that a user inputs in a widget from a card or
   * dialog. The map keys are the string IDs assigned to each widget, and the
   * values represent inputs to the widget. For details, see [Process
   * information inputted by
   * users](https://developers.google.com/chat/ui/read-form-data).
   */
  formInputs?: {
    [key: string]: Inputs
  };
  /**
   * The hostApp enum which indicates the app the add-on is invoked from.
   * Always `CHAT` for Chat apps.
   */
  hostApp?:  | "UNSPECIFIED_HOST_APP" | "GMAIL" | "CALENDAR" | "DRIVE" | "DEMO" | "DOCS" | "MEET" | "SHEETS" | "SLIDES" | "DRAWINGS" | "CHAT";
  /**
   * Name of the invoked function associated with the widget. Only set for Chat
   * apps.
   */
  invokedFunction?: string;
  /**
   * Custom [parameters](/chat/api/reference/rest/v1/cards#ActionParameter)
   * passed to the invoked function. Both keys and values must be strings.
   */
  parameters?: {
    [key: string]: string
  };
  /**
   * The platform enum which indicates the platform where the event originates
   * (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps.
   */
  platform?:  | "UNKNOWN_PLATFORM" | "WEB" | "IOS" | "ANDROID";
  /**
   * The timezone ID and offset from Coordinated Universal Time (UTC). Only
   * supported for the event types
   * [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED)
   * and
   * [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).
   */
  timeZone?: TimeZone;
  /**
   * The full `locale.displayName` in the format of [ISO 639 language
   * code]-[ISO 3166 country/region code] such as "en-US".
   */
  userLocale?: string;
}

function serializeCommonEventObject(data: any): CommonEventObject {
  return {
    ...data,
    formInputs: data["formInputs"] !== undefined ? Object.fromEntries(Object.entries(data["formInputs"]).map(([k, v]: [string, any]) => ([k, serializeInputs(v)]))) : undefined,
  };
}

function deserializeCommonEventObject(data: any): CommonEventObject {
  return {
    ...data,
    formInputs: data["formInputs"] !== undefined ? Object.fromEntries(Object.entries(data["formInputs"]).map(([k, v]: [string, any]) => ([k, deserializeInputs(v)]))) : undefined,
  };
}

/**
 * Request message for completing the import process for a space.
 */
export interface CompleteImportSpaceRequest {
}

/**
 * Response message for completing the import process for a space.
 */
export interface CompleteImportSpaceResponse {
  /**
   * The import mode space.
   */
  space?: Space;
}

function serializeCompleteImportSpaceResponse(data: any): CompleteImportSpaceResponse {
  return {
    ...data,
    space: data["space"] !== undefined ? serializeSpace(data["space"]) : undefined,
  };
}

function deserializeCompleteImportSpaceResponse(data: any): CompleteImportSpaceResponse {
  return {
    ...data,
    space: data["space"] !== undefined ? deserializeSpace(data["space"]) : undefined,
  };
}

/**
 * Represents a custom emoji.
 */
export interface CustomEmoji {
  /**
   * Output only. Unique key for the custom emoji resource.
   */
  readonly uid?: string;
}

/**
 * Date input values.
 */
export interface DateInput {
  /**
   * Time since epoch time, in milliseconds.
   */
  msSinceEpoch?: bigint;
}

function serializeDateInput(data: any): DateInput {
  return {
    ...data,
    msSinceEpoch: data["msSinceEpoch"] !== undefined ? String(data["msSinceEpoch"]) : undefined,
  };
}

function deserializeDateInput(data: any): DateInput {
  return {
    ...data,
    msSinceEpoch: data["msSinceEpoch"] !== undefined ? BigInt(data["msSinceEpoch"]) : undefined,
  };
}

/**
 * Date and time input values.
 */
export interface DateTimeInput {
  /**
   * Whether the `datetime` input includes a calendar date.
   */
  hasDate?: boolean;
  /**
   * Whether the `datetime` input includes a timestamp.
   */
  hasTime?: boolean;
  /**
   * Time since epoch time, in milliseconds.
   */
  msSinceEpoch?: bigint;
}

function serializeDateTimeInput(data: any): DateTimeInput {
  return {
    ...data,
    msSinceEpoch: data["msSinceEpoch"] !== undefined ? String(data["msSinceEpoch"]) : undefined,
  };
}

function deserializeDateTimeInput(data: any): DateTimeInput {
  return {
    ...data,
    msSinceEpoch: data["msSinceEpoch"] !== undefined ? BigInt(data["msSinceEpoch"]) : undefined,
  };
}

/**
 * Information about a deleted message. A message is deleted when `delete_time`
 * is set.
 */
export interface DeletionMetadata {
  /**
   * Indicates who deleted the message.
   */
  deletionType?:  | "DELETION_TYPE_UNSPECIFIED" | "CREATOR" | "SPACE_OWNER" | "ADMIN" | "APP_MESSAGE_EXPIRY" | "CREATOR_VIA_APP" | "SPACE_OWNER_VIA_APP";
}

/**
 * A Google Chat app interaction event that represents and contains data about
 * a user's interaction with a Chat app. To configure your Chat app to receive
 * interaction events, see [Receive and respond to user
 * interactions](https://developers.google.com/workspace/chat/receive-respond-interactions).
 * In addition to receiving events from user interactions, Chat apps can receive
 * events about changes to spaces, such as when a new member is added to a
 * space. To learn about space events, see [Work with events from Google
 * Chat](https://developers.google.com/workspace/chat/events-overview).
 */
export interface DeprecatedEvent {
  /**
   * For `CARD_CLICKED` interaction events, the form action data associated
   * when a user clicks a card or dialog. To learn more, see [Read form data
   * input by users on
   * cards](https://developers.google.com/workspace/chat/read-form-data).
   */
  action?: FormAction;
  /**
   * Represents information about the user's client, such as locale, host app,
   * and platform. For Chat apps, `CommonEventObject` includes information
   * submitted by users interacting with
   * [dialogs](https://developers.google.com/workspace/chat/dialogs), like data
   * entered on a card.
   */
  common?: CommonEventObject;
  /**
   * For `MESSAGE` interaction events, the URL that users must be redirected to
   * after they complete an authorization or configuration flow outside of
   * Google Chat. For more information, see [Connect a Chat app with other
   * services and
   * tools](https://developers.google.com/workspace/chat/connect-web-services-tools).
   */
  configCompleteRedirectUrl?: string;
  /**
   * The type of [dialog](https://developers.google.com/workspace/chat/dialogs)
   * interaction event received.
   */
  dialogEventType?:  | "TYPE_UNSPECIFIED" | "REQUEST_DIALOG" | "SUBMIT_DIALOG" | "CANCEL_DIALOG";
  /**
   * The timestamp indicating when the interaction event occurred.
   */
  eventTime?: Date;
  /**
   * For `CARD_CLICKED` and `MESSAGE` interaction events, whether the user is
   * interacting with or about to interact with a
   * [dialog](https://developers.google.com/workspace/chat/dialogs).
   */
  isDialogEvent?: boolean;
  /**
   * For `ADDED_TO_SPACE`, `CARD_CLICKED`, and `MESSAGE` interaction events,
   * the message that triggered the interaction event, if applicable.
   */
  message?: Message;
  /**
   * The space in which the user interacted with the Chat app.
   */
  space?: Space;
  /**
   * The Chat app-defined key for the thread related to the interaction event.
   * See
   * [`spaces.messages.thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key)
   * for more information.
   */
  threadKey?: string;
  /**
   * A secret value that legacy Chat apps can use to verify if a request is
   * from Google. Google randomly generates the token, and its value remains
   * static. You can obtain, revoke, or regenerate the token from the [Chat API
   * configuration
   * page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat)
   * in the Google Cloud Console. Modern Chat apps don't use this field. It is
   * absent from API responses and the [Chat API configuration
   * page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat).
   */
  token?: string;
  /**
   * The [type](/workspace/chat/api/reference/rest/v1/EventType) of user
   * interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.
   */
  type?:  | "UNSPECIFIED" | "MESSAGE" | "ADDED_TO_SPACE" | "REMOVED_FROM_SPACE" | "CARD_CLICKED" | "WIDGET_UPDATED";
  /**
   * The user that interacted with the Chat app.
   */
  user?: User;
}

function serializeDeprecatedEvent(data: any): DeprecatedEvent {
  return {
    ...data,
    common: data["common"] !== undefined ? serializeCommonEventObject(data["common"]) : undefined,
    eventTime: data["eventTime"] !== undefined ? data["eventTime"].toISOString() : undefined,
    message: data["message"] !== undefined ? serializeMessage(data["message"]) : undefined,
    space: data["space"] !== undefined ? serializeSpace(data["space"]) : undefined,
  };
}

function deserializeDeprecatedEvent(data: any): DeprecatedEvent {
  return {
    ...data,
    common: data["common"] !== undefined ? deserializeCommonEventObject(data["common"]) : undefined,
    eventTime: data["eventTime"] !== undefined ? new Date(data["eventTime"]) : undefined,
    message: data["message"] !== undefined ? deserializeMessage(data["message"]) : undefined,
    space: data["space"] !== undefined ? deserializeSpace(data["space"]) : undefined,
  };
}

/**
 * Wrapper around the card body of the dialog.
 */
export interface Dialog {
  /**
   * Input only. Body of the dialog, which is rendered in a modal. Google Chat
   * apps don't support the following card entities: `DateTimePicker`,
   * `OnChangeAction`.
   */
  body?: GoogleAppsCardV1Card;
}

function serializeDialog(data: any): Dialog {
  return {
    ...data,
    body: data["body"] !== undefined ? serializeGoogleAppsCardV1Card(data["body"]) : undefined,
  };
}

function deserializeDialog(data: any): Dialog {
  return {
    ...data,
    body: data["body"] !== undefined ? deserializeGoogleAppsCardV1Card(data["body"]) : undefined,
  };
}

/**
 * Contains a [dialog](https://developers.google.com/workspace/chat/dialogs)
 * and request status code.
 */
export interface DialogAction {
  /**
   * Input only. Status for a request to either invoke or submit a
   * [dialog](https://developers.google.com/workspace/chat/dialogs). Displays a
   * status and message to users, if necessary. For example, in case of an error
   * or success.
   */
  actionStatus?: ActionStatus;
  /**
   * Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs)
   * for the request.
   */
  dialog?: Dialog;
}

function serializeDialogAction(data: any): DialogAction {
  return {
    ...data,
    dialog: data["dialog"] !== undefined ? serializeDialog(data["dialog"]) : undefined,
  };
}

function deserializeDialogAction(data: any): DialogAction {
  return {
    ...data,
    dialog: data["dialog"] !== undefined ? deserializeDialog(data["dialog"]) : undefined,
  };
}

/**
 * A reference to the data of a drive attachment.
 */
export interface DriveDataRef {
  /**
   * The ID for the drive file. Use with the Drive API.
   */
  driveFileId?: string;
}

/**
 * Data for Google Drive links.
 */
export interface DriveLinkData {
  /**
   * A
   * [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref)
   * which references a Google Drive file.
   */
  driveDataRef?: DriveDataRef;
  /**
   * The mime type of the linked Google Drive resource.
   */
  mimeType?: string;
}

/**
 * An emoji that is used as a reaction to a message.
 */
export interface Emoji {
  /**
   * Output only. A custom emoji.
   */
  readonly customEmoji?: CustomEmoji;
  /**
   * Optional. A basic emoji represented by a unicode string.
   */
  unicode?: string;
}

/**
 * The number of people who reacted to a message with a specific emoji.
 */
export interface EmojiReactionSummary {
  /**
   * Output only. Emoji associated with the reactions.
   */
  readonly emoji?: Emoji;
  /**
   * Output only. The total number of reactions using the associated emoji.
   */
  readonly reactionCount?: number;
}

/**
 * A generic empty message that you can re-use to avoid defining duplicated
 * empty messages in your APIs. A typical example is to use it as the request or
 * the response type of an API method. For instance: service Foo { rpc
 * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
 */
export interface Empty {
}

/**
 * A form action describes the behavior when the form is submitted. For
 * example, you can invoke Apps Script to handle the form.
 */
export interface FormAction {
  /**
   * The method name is used to identify which part of the form triggered the
   * form submission. This information is echoed back to the Chat app as part of
   * the card click event. You can use the same method name for several elements
   * that trigger a common behavior.
   */
  actionMethodName?: string;
  /**
   * List of action parameters.
   */
  parameters?: ActionParameter[];
}

/**
 * An action that describes the behavior when the form is submitted. For
 * example, you can invoke an Apps Script script to handle the form. If the
 * action is triggered, the form values are sent to the server. [Google
 * Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1Action {
  /**
   * A custom function to invoke when the containing element is clicked or
   * otherwise activated. For example usage, see [Read form
   * data](https://developers.google.com/workspace/chat/read-form-data).
   */
  function?: string;
  /**
   * Optional. Required when opening a
   * [dialog](https://developers.google.com/workspace/chat/dialogs). What to do
   * in response to an interaction with a user, such as a user clicking a button
   * in a card message. If unspecified, the app responds by executing an
   * `action`—like opening a link or running a function—as normal. By specifying
   * an `interaction`, the app can respond in special interactive ways. For
   * example, by setting `interaction` to `OPEN_DIALOG`, the app can open a
   * [dialog](https://developers.google.com/workspace/chat/dialogs). When
   * specified, a loading indicator isn't shown. If specified for an add-on, the
   * entire card is stripped and nothing is shown in the client. [Google Chat
   * apps](https://developers.google.com/workspace/chat):
   */
  interaction?:  | "INTERACTION_UNSPECIFIED" | "OPEN_DIALOG";
  /**
   * Specifies the loading indicator that the action displays while making the
   * call to the action.
   */
  loadIndicator?:  | "SPINNER" | "NONE";
  /**
   * List of action parameters.
   */
  parameters?: GoogleAppsCardV1ActionParameter[];
  /**
   * Indicates whether form values persist after the action. The default value
   * is `false`. If `true`, form values remain after the action is triggered. To
   * let the user make changes while the action is being processed, set
   * [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
   * to `NONE`. For [card
   * messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create)
   * in Chat apps, you must also set the action's
   * [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype)
   * to `UPDATE_MESSAGE` and use the same
   * [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId)
   * from the card that contained the action. If `false`, the form values are
   * cleared when the action is triggered. To prevent the user from making
   * changes while the action is being processed, set
   * [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
   * to `SPINNER`.
   */
  persistValues?: boolean;
}

/**
 * List of string parameters to supply when the action method is invoked. For
 * example, consider three snooze buttons: snooze now, snooze one day, or snooze
 * next week. You might use `action method = snooze()`, passing the snooze type
 * and snooze time in the list of string parameters. To learn more, see
 * [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1ActionParameter {
  /**
   * The name of the parameter for the action script.
   */
  key?: string;
  /**
   * The value of the parameter.
   */
  value?: string;
}

/**
 * The style options for the border of a card or widget, including the border
 * type and color. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1BorderStyle {
  /**
   * The corner radius for the border.
   */
  cornerRadius?: number;
  /**
   * The colors to use when the type is `BORDER_TYPE_STROKE`. To set the stroke
   * color, specify a value for the `red`, `green`, and `blue` fields. The value
   * must be a float number between 0 and 1 based on the RGB color value, where
   * `0` (0/255) represents the absence of color and `1` (255/255) represents
   * the maximum intensity of the color. For example, the following sets the
   * color to red at its maximum intensity: ``` "color": { "red": 1, "green": 0,
   * "blue": 0, } ``` The `alpha` field is unavailable for stroke color. If
   * specified, this field is ignored.
   */
  strokeColor?: Color;
  /**
   * The border type.
   */
  type?:  | "BORDER_TYPE_UNSPECIFIED" | "NO_BORDER" | "STROKE";
}

/**
 * A text, icon, or text and icon button that users can click. For an example
 * in Google Chat apps, see [Add a
 * button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button).
 * To make an image a clickable button, specify an `Image` (not an
 * `ImageComponent`) and set an `onClick` action. [Google Workspace Add-ons and
 * Chat apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1Button {
  /**
   * The alternative text that's used for accessibility. Set descriptive text
   * that lets users know what the button does. For example, if a button opens a
   * hyperlink, you might write: "Opens a new browser tab and navigates to the
   * Google Chat developer documentation at
   * https://developers.google.com/workspace/chat".
   */
  altText?: string;
  /**
   * Optional. The color of the button. If set, the button `type` is set to
   * `FILLED` and the color of `text` and `icon` fields are set to a contrasting
   * color for readability. For example, if the button color is set to blue, any
   * text or icons in the button are set to white. To set the button color,
   * specify a value for the `red`, `green`, and `blue` fields. The value must
   * be a float number between 0 and 1 based on the RGB color value, where `0`
   * (0/255) represents the absence of color and `1` (255/255) represents the
   * maximum intensity of the color. For example, the following sets the color
   * to red at its maximum intensity: ``` "color": { "red": 1, "green": 0,
   * "blue": 0, } ``` The `alpha` field is unavailable for button color. If
   * specified, this field is ignored.
   */
  color?: Color;
  /**
   * If `true`, the button is displayed in an inactive state and doesn't
   * respond to user actions.
   */
  disabled?: boolean;
  /**
   * An icon displayed inside the button. If both `icon` and `text` are set,
   * then the icon appears before the text.
   */
  icon?: GoogleAppsCardV1Icon;
  /**
   * Required. The action to perform when a user clicks the button, such as
   * opening a hyperlink or running a custom function.
   */
  onClick?: GoogleAppsCardV1OnClick;
  /**
   * The text displayed inside the button.
   */
  text?: string;
  /**
   * Optional. The type of a button. If unset, button type defaults to
   * `OUTLINED`. If the `color` field is set, the button type is forced to
   * `FILLED` and any value set for this field is ignored. [Google Chat
   * apps](https://developers.google.com/workspace/chat):
   */
  type?:  | "TYPE_UNSPECIFIED" | "OUTLINED" | "FILLED" | "FILLED_TONAL" | "BORDERLESS";
}

function serializeGoogleAppsCardV1Button(data: any): GoogleAppsCardV1Button {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? serializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1Button(data: any): GoogleAppsCardV1Button {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? deserializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

/**
 * A list of buttons layed out horizontally. For an example in Google Chat
 * apps, see [Add a
 * button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button).
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1ButtonList {
  /**
   * An array of buttons.
   */
  buttons?: GoogleAppsCardV1Button[];
}

function serializeGoogleAppsCardV1ButtonList(data: any): GoogleAppsCardV1ButtonList {
  return {
    ...data,
    buttons: data["buttons"] !== undefined ? data["buttons"].map((item: any) => (serializeGoogleAppsCardV1Button(item))) : undefined,
  };
}

function deserializeGoogleAppsCardV1ButtonList(data: any): GoogleAppsCardV1ButtonList {
  return {
    ...data,
    buttons: data["buttons"] !== undefined ? data["buttons"].map((item: any) => (deserializeGoogleAppsCardV1Button(item))) : undefined,
  };
}

/**
 * A card interface displayed in a Google Chat message or Google Workspace
 * Add-on. Cards support a defined layout, interactive UI elements like buttons,
 * and rich media like images. Use cards to present detailed information, gather
 * information from users, and guide users to take a next step. [Card
 * builder](https://addons.gsuite.google.com/uikit/builder) To learn how to
 * build cards, see the following documentation: * For Google Chat apps, see
 * [Design the components of a card or
 * dialog](https://developers.google.com/workspace/chat/design-components-card-dialog).
 * * For Google Workspace Add-ons, see [Card-based
 * interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards).
 * **Example: Card message for a Google Chat app** ![Example contact
 * card](https://developers.google.com/workspace/chat/images/card_api_reference.png)
 * To create the sample card message in Google Chat, use the following JSON: ```
 * { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title":
 * "Sasha", "subtitle": "Software Engineer", "imageUrl":
 * "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
 * "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ {
 * "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount":
 * 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" },
 * "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": {
 * "knownIcon": "PERSON" }, "text": "Online" } }, { "decoratedText": {
 * "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, {
 * "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": {
 * "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": {
 * "action": { "function": "goToView", "parameters": [ { "key": "viewType",
 * "value": "EDIT" } ] } } } ] } } ] } ] } } ] } ```
 */
export interface GoogleAppsCardV1Card {
  /**
   * The card's actions. Actions are added to the card's toolbar menu. [Google
   * Workspace Add-ons](https://developers.google.com/workspace/add-ons): For
   * example, the following JSON constructs a card action menu with `Settings`
   * and `Send Feedback` options: ``` "card_actions": [ { "actionLabel":
   * "Settings", "onClick": { "action": { "functionName": "goToView",
   * "parameters": [ { "key": "viewType", "value": "SETTING" } ],
   * "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send
   * Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback"
   * } } } ] ```
   */
  cardActions?: GoogleAppsCardV1CardAction[];
  /**
   * In Google Workspace Add-ons, sets the display properties of the
   * `peekCardHeader`. [Google Workspace
   * Add-ons](https://developers.google.com/workspace/add-ons):
   */
  displayStyle?:  | "DISPLAY_STYLE_UNSPECIFIED" | "PEEK" | "REPLACE";
  /**
   * The fixed footer shown at the bottom of this card. Setting `fixedFooter`
   * without specifying a `primaryButton` or a `secondaryButton` causes an
   * error. For Chat apps, you can use fixed footers in
   * [dialogs](https://developers.google.com/workspace/chat/dialogs), but not
   * [card
   * messages](https://developers.google.com/workspace/chat/create-messages#create).
   * [Google Workspace Add-ons and Chat
   * apps](https://developers.google.com/workspace/extend):
   */
  fixedFooter?: GoogleAppsCardV1CardFixedFooter;
  /**
   * The header of the card. A header usually contains a leading image and a
   * title. Headers always appear at the top of a card.
   */
  header?: GoogleAppsCardV1CardHeader;
  /**
   * Name of the card. Used as a card identifier in card navigation. [Google
   * Workspace Add-ons](https://developers.google.com/workspace/add-ons):
   */
  name?: string;
  /**
   * When displaying contextual content, the peek card header acts as a
   * placeholder so that the user can navigate forward between the homepage
   * cards and the contextual cards. [Google Workspace
   * Add-ons](https://developers.google.com/workspace/add-ons):
   */
  peekCardHeader?: GoogleAppsCardV1CardHeader;
  /**
   * The divider style between the header, sections and footer.
   */
  sectionDividerStyle?:  | "DIVIDER_STYLE_UNSPECIFIED" | "SOLID_DIVIDER" | "NO_DIVIDER";
  /**
   * Contains a collection of widgets. Each section has its own, optional
   * header. Sections are visually separated by a line divider. For an example
   * in Google Chat apps, see [Define a section of a
   * card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
   */
  sections?: GoogleAppsCardV1Section[];
}

function serializeGoogleAppsCardV1Card(data: any): GoogleAppsCardV1Card {
  return {
    ...data,
    cardActions: data["cardActions"] !== undefined ? data["cardActions"].map((item: any) => (serializeGoogleAppsCardV1CardAction(item))) : undefined,
    fixedFooter: data["fixedFooter"] !== undefined ? serializeGoogleAppsCardV1CardFixedFooter(data["fixedFooter"]) : undefined,
    sections: data["sections"] !== undefined ? data["sections"].map((item: any) => (serializeGoogleAppsCardV1Section(item))) : undefined,
  };
}

function deserializeGoogleAppsCardV1Card(data: any): GoogleAppsCardV1Card {
  return {
    ...data,
    cardActions: data["cardActions"] !== undefined ? data["cardActions"].map((item: any) => (deserializeGoogleAppsCardV1CardAction(item))) : undefined,
    fixedFooter: data["fixedFooter"] !== undefined ? deserializeGoogleAppsCardV1CardFixedFooter(data["fixedFooter"]) : undefined,
    sections: data["sections"] !== undefined ? data["sections"].map((item: any) => (deserializeGoogleAppsCardV1Section(item))) : undefined,
  };
}

/**
 * A card action is the action associated with the card. For example, an
 * invoice card might include actions such as delete invoice, email invoice, or
 * open the invoice in a browser. [Google Workspace
 * Add-ons](https://developers.google.com/workspace/add-ons):
 */
export interface GoogleAppsCardV1CardAction {
  /**
   * The label that displays as the action menu item.
   */
  actionLabel?: string;
  /**
   * The `onClick` action for this action item.
   */
  onClick?: GoogleAppsCardV1OnClick;
}

function serializeGoogleAppsCardV1CardAction(data: any): GoogleAppsCardV1CardAction {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? serializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1CardAction(data: any): GoogleAppsCardV1CardAction {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? deserializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

/**
 * A persistent (sticky) footer that that appears at the bottom of the card.
 * Setting `fixedFooter` without specifying a `primaryButton` or a
 * `secondaryButton` causes an error. For Chat apps, you can use fixed footers
 * in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not
 * [card
 * messages](https://developers.google.com/workspace/chat/create-messages#create).
 * For an example in Google Chat apps, see [Add a persistent
 * footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer).
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1CardFixedFooter {
  /**
   * The primary button of the fixed footer. The button must be a text button
   * with text and color set.
   */
  primaryButton?: GoogleAppsCardV1Button;
  /**
   * The secondary button of the fixed footer. The button must be a text button
   * with text and color set. If `secondaryButton` is set, you must also set
   * `primaryButton`.
   */
  secondaryButton?: GoogleAppsCardV1Button;
}

function serializeGoogleAppsCardV1CardFixedFooter(data: any): GoogleAppsCardV1CardFixedFooter {
  return {
    ...data,
    primaryButton: data["primaryButton"] !== undefined ? serializeGoogleAppsCardV1Button(data["primaryButton"]) : undefined,
    secondaryButton: data["secondaryButton"] !== undefined ? serializeGoogleAppsCardV1Button(data["secondaryButton"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1CardFixedFooter(data: any): GoogleAppsCardV1CardFixedFooter {
  return {
    ...data,
    primaryButton: data["primaryButton"] !== undefined ? deserializeGoogleAppsCardV1Button(data["primaryButton"]) : undefined,
    secondaryButton: data["secondaryButton"] !== undefined ? deserializeGoogleAppsCardV1Button(data["secondaryButton"]) : undefined,
  };
}

/**
 * Represents a card header. For an example in Google Chat apps, see [Add a
 * header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header).
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1CardHeader {
  /**
   * The alternative text of this image that's used for accessibility.
   */
  imageAltText?: string;
  /**
   * The shape used to crop the image. [Google Workspace Add-ons and Chat
   * apps](https://developers.google.com/workspace/extend):
   */
  imageType?:  | "SQUARE" | "CIRCLE";
  /**
   * The HTTPS URL of the image in the card header.
   */
  imageUrl?: string;
  /**
   * The subtitle of the card header. If specified, appears on its own line
   * below the `title`.
   */
  subtitle?: string;
  /**
   * Required. The title of the card header. The header has a fixed height: if
   * both a title and subtitle are specified, each takes up one line. If only
   * the title is specified, it takes up both lines.
   */
  title?: string;
}

/**
 * A text, icon, or text and icon chip that users can click. [Google Chat
 * apps](https://developers.google.com/workspace/chat):
 */
export interface GoogleAppsCardV1Chip {
  /**
   * The alternative text that's used for accessibility. Set descriptive text
   * that lets users know what the chip does. For example, if a chip opens a
   * hyperlink, write: "Opens a new browser tab and navigates to the Google Chat
   * developer documentation at https://developers.google.com/workspace/chat".
   */
  altText?: string;
  /**
   * Whether the chip is in an inactive state and ignores user actions.
   * Defaults to `false`.
   */
  disabled?: boolean;
  /**
   * Whether the chip is in an active state and responds to user actions.
   * Defaults to `true`. Deprecated. Use `disabled` instead.
   */
  enabled?: boolean;
  /**
   * The icon image. If both `icon` and `text` are set, then the icon appears
   * before the text.
   */
  icon?: GoogleAppsCardV1Icon;
  /**
   * The text displayed inside the chip.
   */
  label?: string;
  /**
   * Optional. The action to perform when a user clicks the chip, such as
   * opening a hyperlink or running a custom function.
   */
  onClick?: GoogleAppsCardV1OnClick;
}

function serializeGoogleAppsCardV1Chip(data: any): GoogleAppsCardV1Chip {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? serializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1Chip(data: any): GoogleAppsCardV1Chip {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? deserializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

/**
 * A list of chips layed out horizontally, which can either scroll horizontally
 * or wrap to the next line. [Google Chat
 * apps](https://developers.google.com/workspace/chat):
 */
export interface GoogleAppsCardV1ChipList {
  /**
   * An array of chips.
   */
  chips?: GoogleAppsCardV1Chip[];
  /**
   * Specified chip list layout.
   */
  layout?:  | "LAYOUT_UNSPECIFIED" | "WRAPPED" | "HORIZONTAL_SCROLLABLE";
}

function serializeGoogleAppsCardV1ChipList(data: any): GoogleAppsCardV1ChipList {
  return {
    ...data,
    chips: data["chips"] !== undefined ? data["chips"].map((item: any) => (serializeGoogleAppsCardV1Chip(item))) : undefined,
  };
}

function deserializeGoogleAppsCardV1ChipList(data: any): GoogleAppsCardV1ChipList {
  return {
    ...data,
    chips: data["chips"] !== undefined ? data["chips"].map((item: any) => (deserializeGoogleAppsCardV1Chip(item))) : undefined,
  };
}

/**
 * Represent an expand and collapse control. [Google Chat
 * apps](https://developers.google.com/workspace/chat):
 */
export interface GoogleAppsCardV1CollapseControl {
  /**
   * Optional. Define a customizable button to collapse the section. Both
   * expand_button and collapse_button field must be set. Only one field set
   * will not take into effect. If this field isn't set, the default button is
   * used.
   */
  collapseButton?: GoogleAppsCardV1Button;
  /**
   * Optional. Define a customizable button to expand the section. Both
   * expand_button and collapse_button field must be set. Only one field set
   * will not take into effect. If this field isn't set, the default button is
   * used.
   */
  expandButton?: GoogleAppsCardV1Button;
  /**
   * The horizontal alignment of the expand and collapse button.
   */
  horizontalAlignment?:  | "HORIZONTAL_ALIGNMENT_UNSPECIFIED" | "START" | "CENTER" | "END";
}

function serializeGoogleAppsCardV1CollapseControl(data: any): GoogleAppsCardV1CollapseControl {
  return {
    ...data,
    collapseButton: data["collapseButton"] !== undefined ? serializeGoogleAppsCardV1Button(data["collapseButton"]) : undefined,
    expandButton: data["expandButton"] !== undefined ? serializeGoogleAppsCardV1Button(data["expandButton"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1CollapseControl(data: any): GoogleAppsCardV1CollapseControl {
  return {
    ...data,
    collapseButton: data["collapseButton"] !== undefined ? deserializeGoogleAppsCardV1Button(data["collapseButton"]) : undefined,
    expandButton: data["expandButton"] !== undefined ? deserializeGoogleAppsCardV1Button(data["expandButton"]) : undefined,
  };
}

/**
 * A column. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend)
 */
export interface GoogleAppsCardV1Column {
  /**
   * Specifies whether widgets align to the left, right, or center of a column.
   */
  horizontalAlignment?:  | "HORIZONTAL_ALIGNMENT_UNSPECIFIED" | "START" | "CENTER" | "END";
  /**
   * Specifies how a column fills the width of the card.
   */
  horizontalSizeStyle?:  | "HORIZONTAL_SIZE_STYLE_UNSPECIFIED" | "FILL_AVAILABLE_SPACE" | "FILL_MINIMUM_SPACE";
  /**
   * Specifies whether widgets align to the top, bottom, or center of a column.
   */
  verticalAlignment?:  | "VERTICAL_ALIGNMENT_UNSPECIFIED" | "CENTER" | "TOP" | "BOTTOM";
  /**
   * An array of widgets included in a column. Widgets appear in the order that
   * they are specified.
   */
  widgets?: GoogleAppsCardV1Widgets[];
}

function serializeGoogleAppsCardV1Column(data: any): GoogleAppsCardV1Column {
  return {
    ...data,
    widgets: data["widgets"] !== undefined ? data["widgets"].map((item: any) => (serializeGoogleAppsCardV1Widgets(item))) : undefined,
  };
}

function deserializeGoogleAppsCardV1Column(data: any): GoogleAppsCardV1Column {
  return {
    ...data,
    widgets: data["widgets"] !== undefined ? data["widgets"].map((item: any) => (deserializeGoogleAppsCardV1Widgets(item))) : undefined,
  };
}

/**
 * The `Columns` widget displays up to 2 columns in a card or dialog. You can
 * add widgets to each column; the widgets appear in the order that they are
 * specified. For an example in Google Chat apps, see [Display cards and dialogs
 * in
 * columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns).
 * The height of each column is determined by the taller column. For example, if
 * the first column is taller than the second column, both columns have the
 * height of the first column. Because each column can contain a different
 * number of widgets, you can't define rows or align widgets between the
 * columns. Columns are displayed side-by-side. You can customize the width of
 * each column using the `HorizontalSizeStyle` field. If the user's screen width
 * is too narrow, the second column wraps below the first: * On web, the second
 * column wraps if the screen width is less than or equal to 480 pixels. * On
 * iOS devices, the second column wraps if the screen width is less than or
 * equal to 300 pt. * On Android devices, the second column wraps if the screen
 * width is less than or equal to 320 dp. To include more than two columns, or
 * to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend): The add-on UIs that
 * support columns include: * The dialog displayed when users open the add-on
 * from an email draft. * The dialog displayed when users open the add-on from
 * the **Add attachment** menu in a Google Calendar event.
 */
export interface GoogleAppsCardV1Columns {
  /**
   * An array of columns. You can include up to 2 columns in a card or dialog.
   */
  columnItems?: GoogleAppsCardV1Column[];
}

function serializeGoogleAppsCardV1Columns(data: any): GoogleAppsCardV1Columns {
  return {
    ...data,
    columnItems: data["columnItems"] !== undefined ? data["columnItems"].map((item: any) => (serializeGoogleAppsCardV1Column(item))) : undefined,
  };
}

function deserializeGoogleAppsCardV1Columns(data: any): GoogleAppsCardV1Columns {
  return {
    ...data,
    columnItems: data["columnItems"] !== undefined ? data["columnItems"].map((item: any) => (deserializeGoogleAppsCardV1Column(item))) : undefined,
  };
}

/**
 * Lets users input a date, a time, or both a date and a time. For an example
 * in Google Chat apps, see [Let a user pick a date and
 * time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time).
 * Users can input text or use the picker to select dates and times. If users
 * input an invalid date or time, the picker shows an error that prompts users
 * to input the information correctly. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1DateTimePicker {
  /**
   * The text that prompts users to input a date, a time, or a date and time.
   * For example, if users are scheduling an appointment, use a label such as
   * `Appointment date` or `Appointment date and time`.
   */
  label?: string;
  /**
   * The name by which the `DateTimePicker` is identified in a form input
   * event. For details about working with form inputs, see [Receive form
   * data](https://developers.google.com/workspace/chat/read-form-data).
   */
  name?: string;
  /**
   * Triggered when the user clicks **Save** or **Clear** from the
   * `DateTimePicker` interface.
   */
  onChangeAction?: GoogleAppsCardV1Action;
  /**
   * The number representing the time zone offset from UTC, in minutes. If set,
   * the `value_ms_epoch` is displayed in the specified time zone. If unset, the
   * value defaults to the user's time zone setting.
   */
  timezoneOffsetDate?: number;
  /**
   * Whether the widget supports inputting a date, a time, or the date and
   * time.
   */
  type?:  | "DATE_AND_TIME" | "DATE_ONLY" | "TIME_ONLY";
  /**
   * The default value displayed in the widget, in milliseconds since [Unix
   * epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value
   * based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a
   * calendar date and time in UTC. For example, to represent January 1, 2023 at
   * 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at
   * 00:00:00 UTC. For example, to represent January 1, 2023, use
   * `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent
   * 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).
   */
  valueMsEpoch?: bigint;
}

function serializeGoogleAppsCardV1DateTimePicker(data: any): GoogleAppsCardV1DateTimePicker {
  return {
    ...data,
    valueMsEpoch: data["valueMsEpoch"] !== undefined ? String(data["valueMsEpoch"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1DateTimePicker(data: any): GoogleAppsCardV1DateTimePicker {
  return {
    ...data,
    valueMsEpoch: data["valueMsEpoch"] !== undefined ? BigInt(data["valueMsEpoch"]) : undefined,
  };
}

/**
 * A widget that displays text with optional decorations such as a label above
 * or below the text, an icon in front of the text, a selection widget, or a
 * button after the text. For an example in Google Chat apps, see [Display text
 * with decorative
 * text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements).
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1DecoratedText {
  /**
   * The text that appears below `text`. Always wraps.
   */
  bottomLabel?: string;
  /**
   * A button that a user can click to trigger an action.
   */
  button?: GoogleAppsCardV1Button;
  /**
   * An icon displayed after the text. Supports
   * [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
   * and
   * [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
   * icons.
   */
  endIcon?: GoogleAppsCardV1Icon;
  /**
   * Deprecated in favor of `startIcon`.
   */
  icon?: GoogleAppsCardV1Icon;
  /**
   * This action is triggered when users click `topLabel` or `bottomLabel`.
   */
  onClick?: GoogleAppsCardV1OnClick;
  /**
   * The icon displayed in front of the text.
   */
  startIcon?: GoogleAppsCardV1Icon;
  /**
   * A switch widget that a user can click to change its state and trigger an
   * action.
   */
  switchControl?: GoogleAppsCardV1SwitchControl;
  /**
   * Required. The primary text. Supports simple formatting. For more
   * information about formatting text, see [Formatting text in Google Chat
   * apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
   * and [Formatting text in Google Workspace
   * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
   */
  text?: string;
  /**
   * The text that appears above `text`. Always truncates.
   */
  topLabel?: string;
  /**
   * The wrap text setting. If `true`, the text wraps and displays on multiple
   * lines. Otherwise, the text is truncated. Only applies to `text`, not
   * `topLabel` and `bottomLabel`.
   */
  wrapText?: boolean;
}

function serializeGoogleAppsCardV1DecoratedText(data: any): GoogleAppsCardV1DecoratedText {
  return {
    ...data,
    button: data["button"] !== undefined ? serializeGoogleAppsCardV1Button(data["button"]) : undefined,
    onClick: data["onClick"] !== undefined ? serializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1DecoratedText(data: any): GoogleAppsCardV1DecoratedText {
  return {
    ...data,
    button: data["button"] !== undefined ? deserializeGoogleAppsCardV1Button(data["button"]) : undefined,
    onClick: data["onClick"] !== undefined ? deserializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

/**
 * Displays a divider between widgets as a horizontal line. For an example in
 * Google Chat apps, see [Add a horizontal divider between
 * widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets).
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend): For example, the
 * following JSON creates a divider: ``` "divider": {} ```
 */
export interface GoogleAppsCardV1Divider {
}

/**
 * Displays a grid with a collection of items. Items can only include text or
 * images. For responsive columns, or to include more than text or images, use
 * `Columns`. For an example in Google Chat apps, see [Display a Grid with a
 * collection of
 * items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items).
 * A grid supports any number of columns and items. The number of rows is
 * determined by items divided by columns. A grid with 10 items and 2 columns
 * has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace
 * Add-ons and Chat apps](https://developers.google.com/workspace/extend): For
 * example, the following JSON creates a 2 column grid with a single item: ```
 * "grid": { "title": "A fine collection of items", "columnCount": 2,
 * "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image":
 * { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type":
 * "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item",
 * "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url":
 * "https://www.example.com" } } } ```
 */
export interface GoogleAppsCardV1Grid {
  /**
   * The border style to apply to each grid item.
   */
  borderStyle?: GoogleAppsCardV1BorderStyle;
  /**
   * The number of columns to display in the grid. A default value is used if
   * this field isn't specified, and that default value is different depending
   * on where the grid is shown (dialog versus companion).
   */
  columnCount?: number;
  /**
   * The items to display in the grid.
   */
  items?: GoogleAppsCardV1GridItem[];
  /**
   * This callback is reused by each individual grid item, but with the item's
   * identifier and index in the items list added to the callback's parameters.
   */
  onClick?: GoogleAppsCardV1OnClick;
  /**
   * The text that displays in the grid header.
   */
  title?: string;
}

function serializeGoogleAppsCardV1Grid(data: any): GoogleAppsCardV1Grid {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? serializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1Grid(data: any): GoogleAppsCardV1Grid {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? deserializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

/**
 * Represents an item in a grid layout. Items can contain text, an image, or
 * both text and an image. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1GridItem {
  /**
   * A user-specified identifier for this grid item. This identifier is
   * returned in the parent grid's `onClick` callback parameters.
   */
  id?: string;
  /**
   * The image that displays in the grid item.
   */
  image?: GoogleAppsCardV1ImageComponent;
  /**
   * The layout to use for the grid item.
   */
  layout?:  | "GRID_ITEM_LAYOUT_UNSPECIFIED" | "TEXT_BELOW" | "TEXT_ABOVE";
  /**
   * The grid item's subtitle.
   */
  subtitle?: string;
  /**
   * The grid item's title.
   */
  title?: string;
}

/**
 * An icon displayed in a widget on a card. For an example in Google Chat apps,
 * see [Add an
 * icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon).
 * Supports
 * [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
 * and
 * [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
 * icons. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1Icon {
  /**
   * Optional. A description of the icon used for accessibility. If
   * unspecified, the default value `Button` is provided. As a best practice,
   * you should set a helpful description for what the icon displays, and if
   * applicable, what it does. For example, `A user's account portrait`, or
   * `Opens a new browser tab and navigates to the Google Chat developer
   * documentation at https://developers.google.com/workspace/chat`. If the icon
   * is set in a `Button`, the `altText` appears as helper text when the user
   * hovers over the button. However, if the button also sets `text`, the icon's
   * `altText` is ignored.
   */
  altText?: string;
  /**
   * Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl":
   * "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"
   * ``` Supported file types include `.png` and `.jpg`.
   */
  iconUrl?: string;
  /**
   * The crop style applied to the image. In some cases, applying a `CIRCLE`
   * crop causes the image to be drawn larger than a built-in icon.
   */
  imageType?:  | "SQUARE" | "CIRCLE";
  /**
   * Display one of the built-in icons provided by Google Workspace. For
   * example, to display an airplane icon, specify `AIRPLANE`. For a bus,
   * specify `BUS`. For a full list of supported icons, see [built-in
   * icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
   */
  knownIcon?: string;
  /**
   * Display one of the [Google Material
   * Icons](https://fonts.google.com/icons). For example, to display a [checkbox
   * icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048),
   * use ``` "material_icon": { "name": "check_box" } ``` [Google Chat
   * apps](https://developers.google.com/workspace/chat):
   */
  materialIcon?: GoogleAppsCardV1MaterialIcon;
}

/**
 * An image that is specified by a URL and can have an `onClick` action. For an
 * example, see [Add an
 * image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image).
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1Image {
  /**
   * The alternative text of this image that's used for accessibility.
   */
  altText?: string;
  /**
   * The HTTPS URL that hosts the image. For example: ```
   * https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
   * ```
   */
  imageUrl?: string;
  /**
   * When a user clicks the image, the click triggers this action.
   */
  onClick?: GoogleAppsCardV1OnClick;
}

function serializeGoogleAppsCardV1Image(data: any): GoogleAppsCardV1Image {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? serializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1Image(data: any): GoogleAppsCardV1Image {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? deserializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

/**
 * Represents an image. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1ImageComponent {
  /**
   * The accessibility label for the image.
   */
  altText?: string;
  /**
   * The border style to apply to the image.
   */
  borderStyle?: GoogleAppsCardV1BorderStyle;
  /**
   * The crop style to apply to the image.
   */
  cropStyle?: GoogleAppsCardV1ImageCropStyle;
  /**
   * The image URL.
   */
  imageUri?: string;
}

/**
 * Represents the crop style applied to an image. [Google Workspace Add-ons and
 * Chat apps](https://developers.google.com/workspace/extend): For example,
 * here's how to apply a 16:9 aspect ratio: ``` cropStyle { "type":
 * "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ```
 */
export interface GoogleAppsCardV1ImageCropStyle {
  /**
   * The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For
   * example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { "type":
   * "RECTANGLE_CUSTOM", "aspectRatio": 16/9 } ```
   */
  aspectRatio?: number;
  /**
   * The crop type.
   */
  type?:  | "IMAGE_CROP_TYPE_UNSPECIFIED" | "SQUARE" | "CIRCLE" | "RECTANGLE_CUSTOM" | "RECTANGLE_4_3";
}

/**
 * A [Google Material Icon](https://fonts.google.com/icons), which includes
 * over 2500+ options. For example, to display a [checkbox
 * icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048)
 * with customized weight and grade, write the following: ``` { "name":
 * "check_box", "fill": true, "weight": 300, "grade": -25 } ``` [Google Chat
 * apps](https://developers.google.com/workspace/chat):
 */
export interface GoogleAppsCardV1MaterialIcon {
  /**
   * Whether the icon renders as filled. Default value is false. To preview
   * different icon settings, go to [Google Font
   * Icons](https://fonts.google.com/icons) and adjust the settings under
   * **Customize**.
   */
  fill?: boolean;
  /**
   * Weight and grade affect a symbol’s thickness. Adjustments to grade are
   * more granular than adjustments to weight and have a small impact on the
   * size of the symbol. Choose from {-25, 0, 200}. If absent, default value is
   * 0. If any other value is specified, the default value is used. To preview
   * different icon settings, go to [Google Font
   * Icons](https://fonts.google.com/icons) and adjust the settings under
   * **Customize**.
   */
  grade?: number;
  /**
   * The icon name defined in the [Google Material
   * Icon](https://fonts.google.com/icons), for example, `check_box`. Any
   * invalid names are abandoned and replaced with empty string and results in
   * the icon failing to render.
   */
  name?: string;
  /**
   * The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600,
   * 700}. If absent, default value is 400. If any other value is specified, the
   * default value is used. To preview different icon settings, go to [Google
   * Font Icons](https://fonts.google.com/icons) and adjust the settings under
   * **Customize**.
   */
  weight?: number;
}

/**
 * Represents how to respond when users click an interactive element on a card,
 * such as a button. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1OnClick {
  /**
   * If specified, an action is triggered by this `onClick`.
   */
  action?: GoogleAppsCardV1Action;
  /**
   * A new card is pushed to the card stack after clicking if specified.
   * [Google Workspace
   * Add-ons](https://developers.google.com/workspace/add-ons):
   */
  card?: GoogleAppsCardV1Card;
  /**
   * An add-on triggers this action when the action needs to open a link. This
   * differs from the `open_link` above in that this needs to talk to server to
   * get the link. Thus some preparation work is required for web client to do
   * before the open link action response comes back. [Google Workspace
   * Add-ons](https://developers.google.com/workspace/add-ons):
   */
  openDynamicLinkAction?: GoogleAppsCardV1Action;
  /**
   * If specified, this `onClick` triggers an open link action.
   */
  openLink?: GoogleAppsCardV1OpenLink;
  /**
   * If specified, this `onClick` opens an overflow menu. [Google Chat
   * apps](https://developers.google.com/workspace/chat):
   */
  overflowMenu?: GoogleAppsCardV1OverflowMenu;
}

function serializeGoogleAppsCardV1OnClick(data: any): GoogleAppsCardV1OnClick {
  return {
    ...data,
    card: data["card"] !== undefined ? serializeGoogleAppsCardV1Card(data["card"]) : undefined,
    overflowMenu: data["overflowMenu"] !== undefined ? serializeGoogleAppsCardV1OverflowMenu(data["overflowMenu"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1OnClick(data: any): GoogleAppsCardV1OnClick {
  return {
    ...data,
    card: data["card"] !== undefined ? deserializeGoogleAppsCardV1Card(data["card"]) : undefined,
    overflowMenu: data["overflowMenu"] !== undefined ? deserializeGoogleAppsCardV1OverflowMenu(data["overflowMenu"]) : undefined,
  };
}

/**
 * Represents an `onClick` event that opens a hyperlink. [Google Workspace
 * Add-ons and Chat apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1OpenLink {
  /**
   * Whether the client forgets about a link after opening it, or observes it
   * until the window closes. [Google Workspace
   * Add-ons](https://developers.google.com/workspace/add-ons):
   */
  onClose?:  | "NOTHING" | "RELOAD";
  /**
   * How to open a link. [Google Workspace
   * Add-ons](https://developers.google.com/workspace/add-ons):
   */
  openAs?:  | "FULL_SIZE" | "OVERLAY";
  /**
   * The URL to open.
   */
  url?: string;
}

/**
 * A widget that presents a pop-up menu with one or more actions that users can
 * invoke. For example, showing non-primary actions in a card. You can use this
 * widget when actions don't fit in the available space. To use, specify this
 * widget in the `OnClick` action of widgets that support it. For example, in a
 * `Button`. [Google Chat apps](https://developers.google.com/workspace/chat):
 */
export interface GoogleAppsCardV1OverflowMenu {
  /**
   * Required. The list of menu options.
   */
  items?: GoogleAppsCardV1OverflowMenuItem[];
}

function serializeGoogleAppsCardV1OverflowMenu(data: any): GoogleAppsCardV1OverflowMenu {
  return {
    ...data,
    items: data["items"] !== undefined ? data["items"].map((item: any) => (serializeGoogleAppsCardV1OverflowMenuItem(item))) : undefined,
  };
}

function deserializeGoogleAppsCardV1OverflowMenu(data: any): GoogleAppsCardV1OverflowMenu {
  return {
    ...data,
    items: data["items"] !== undefined ? data["items"].map((item: any) => (deserializeGoogleAppsCardV1OverflowMenuItem(item))) : undefined,
  };
}

/**
 * An option that users can invoke in an overflow menu. [Google Chat
 * apps](https://developers.google.com/workspace/chat):
 */
export interface GoogleAppsCardV1OverflowMenuItem {
  /**
   * Whether the menu option is disabled. Defaults to false.
   */
  disabled?: boolean;
  /**
   * Required. The action invoked when a menu option is selected. This
   * `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is
   * dropped and the menu item disabled.
   */
  onClick?: GoogleAppsCardV1OnClick;
  /**
   * The icon displayed in front of the text.
   */
  startIcon?: GoogleAppsCardV1Icon;
  /**
   * Required. The text that identifies or describes the item to users.
   */
  text?: string;
}

function serializeGoogleAppsCardV1OverflowMenuItem(data: any): GoogleAppsCardV1OverflowMenuItem {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? serializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1OverflowMenuItem(data: any): GoogleAppsCardV1OverflowMenuItem {
  return {
    ...data,
    onClick: data["onClick"] !== undefined ? deserializeGoogleAppsCardV1OnClick(data["onClick"]) : undefined,
  };
}

/**
 * For a `SelectionInput` widget that uses a multiselect menu, a data source
 * from Google Workspace. Used to populate items in a multiselect menu. [Google
 * Chat apps](https://developers.google.com/workspace/chat):
 */
export interface GoogleAppsCardV1PlatformDataSource {
  /**
   * A data source shared by all Google Workspace applications, such as users
   * in a Google Workspace organization.
   */
  commonDataSource?:  | "UNKNOWN" | "USER";
  /**
   * A data source that's unique to a Google Workspace host application, such
   * spaces in Google Chat. This field supports the Google API Client Libraries
   * but isn't available in the Cloud Client Libraries. To learn more, see
   * [Install the client
   * libraries](https://developers.google.com/workspace/chat/libraries).
   */
  hostAppDataSource?: HostAppDataSourceMarkup;
}

/**
 * A section contains a collection of widgets that are rendered vertically in
 * the order that they're specified. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1Section {
  /**
   * Optional. Define the expand and collapse button of the section. This
   * button will be shown only if the section is collapsible. If this field
   * isn't set, the default button is used. [Google Chat
   * apps](https://developers.google.com/workspace/chat):
   */
  collapseControl?: GoogleAppsCardV1CollapseControl;
  /**
   * Indicates whether this section is collapsible. Collapsible sections hide
   * some or all widgets, but users can expand the section to reveal the hidden
   * widgets by clicking **Show more**. Users can hide the widgets again by
   * clicking **Show less**. To determine which widgets are hidden, specify
   * `uncollapsibleWidgetsCount`.
   */
  collapsible?: boolean;
  /**
   * Text that appears at the top of a section. Supports simple HTML formatted
   * text. For more information about formatting text, see [Formatting text in
   * Google Chat
   * apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
   * and [Formatting text in Google Workspace
   * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
   */
  header?: string;
  /**
   * The number of uncollapsible widgets which remain visible even when a
   * section is collapsed. For example, when a section contains five widgets and
   * the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are
   * always shown and the last three are collapsed by default. The
   * `uncollapsibleWidgetsCount` is taken into account only when `collapsible`
   * is `true`.
   */
  uncollapsibleWidgetsCount?: number;
  /**
   * All the widgets in the section. Must contain at least one widget.
   */
  widgets?: GoogleAppsCardV1Widget[];
}

function serializeGoogleAppsCardV1Section(data: any): GoogleAppsCardV1Section {
  return {
    ...data,
    collapseControl: data["collapseControl"] !== undefined ? serializeGoogleAppsCardV1CollapseControl(data["collapseControl"]) : undefined,
    widgets: data["widgets"] !== undefined ? data["widgets"].map((item: any) => (serializeGoogleAppsCardV1Widget(item))) : undefined,
  };
}

function deserializeGoogleAppsCardV1Section(data: any): GoogleAppsCardV1Section {
  return {
    ...data,
    collapseControl: data["collapseControl"] !== undefined ? deserializeGoogleAppsCardV1CollapseControl(data["collapseControl"]) : undefined,
    widgets: data["widgets"] !== undefined ? data["widgets"].map((item: any) => (deserializeGoogleAppsCardV1Widget(item))) : undefined,
  };
}

/**
 * A widget that creates one or more UI items that users can select. For
 * example, a dropdown menu or checkboxes. You can use this widget to collect
 * data that can be predicted or enumerated. For an example in Google Chat apps,
 * see [Add selectable UI
 * elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements).
 * Chat apps can process the value of items that users select or input. For
 * details about working with form inputs, see [Receive form
 * data](https://developers.google.com/workspace/chat/read-form-data). To
 * collect undefined or abstract data from users, use the TextInput widget.
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1SelectionInput {
  /**
   * An external data source, such as a relational database.
   */
  externalDataSource?: GoogleAppsCardV1Action;
  /**
   * An array of selectable items. For example, an array of radio buttons or
   * checkboxes. Supports up to 100 items.
   */
  items?: GoogleAppsCardV1SelectionItem[];
  /**
   * The text that appears above the selection input field in the user
   * interface. Specify text that helps the user enter the information your app
   * needs. For example, if users are selecting the urgency of a work ticket
   * from a drop-down menu, the label might be "Urgency" or "Select urgency".
   */
  label?: string;
  /**
   * For multiselect menus, the maximum number of items that a user can select.
   * Minimum value is 1 item. If unspecified, defaults to 3 items.
   */
  multiSelectMaxSelectedItems?: number;
  /**
   * For multiselect menus, the number of text characters that a user inputs
   * before the menu returns suggested selection items. If unset, the
   * multiselect menu uses the following default values: * If the menu uses a
   * static array of `SelectionInput` items, defaults to 0 characters and
   * immediately populates items from the array. * If the menu uses a dynamic
   * data source (`multi_select_data_source`), defaults to 3 characters before
   * querying the data source to return suggested items.
   */
  multiSelectMinQueryLength?: number;
  /**
   * Required. The name that identifies the selection input in a form input
   * event. For details about working with form inputs, see [Receive form
   * data](https://developers.google.com/workspace/chat/read-form-data).
   */
  name?: string;
  /**
   * If specified, the form is submitted when the selection changes. If not
   * specified, you must specify a separate button that submits the form. For
   * details about working with form inputs, see [Receive form
   * data](https://developers.google.com/workspace/chat/read-form-data).
   */
  onChangeAction?: GoogleAppsCardV1Action;
  /**
   * A data source from Google Workspace.
   */
  platformDataSource?: GoogleAppsCardV1PlatformDataSource;
  /**
   * The type of items that are displayed to users in a `SelectionInput`
   * widget. Selection types support different types of interactions. For
   * example, users can select one or more checkboxes, but they can only select
   * one value from a dropdown menu.
   */
  type?:  | "CHECK_BOX" | "RADIO_BUTTON" | "SWITCH" | "DROPDOWN" | "MULTI_SELECT";
}

/**
 * An item that users can select in a selection input, such as a checkbox or
 * switch. Supports up to 100 items. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1SelectionItem {
  /**
   * For multiselect menus, a text description or label that's displayed below
   * the item's `text` field.
   */
  bottomText?: string;
  /**
   * Whether the item is selected by default. If the selection input only
   * accepts one value (such as for radio buttons or a dropdown menu), only set
   * this field for one item.
   */
  selected?: boolean;
  /**
   * For multiselect menus, the URL for the icon displayed next to the item's
   * `text` field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For
   * example,
   * `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`.
   */
  startIconUri?: string;
  /**
   * The text that identifies or describes the item to users.
   */
  text?: string;
  /**
   * The value associated with this item. The client should use this as a form
   * input value. For details about working with form inputs, see [Receive form
   * data](https://developers.google.com/workspace/chat/read-form-data).
   */
  value?: string;
}

/**
 * One suggested value that users can enter in a text input field. [Google
 * Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1SuggestionItem {
  /**
   * The value of a suggested input to a text input field. This is equivalent
   * to what users enter themselves.
   */
  text?: string;
}

/**
 * Suggested values that users can enter. These values appear when users click
 * inside the text input field. As users type, the suggested values dynamically
 * filter to match what the users have typed. For example, a text input field
 * for programming language might suggest Java, JavaScript, Python, and C++.
 * When users start typing `Jav`, the list of suggestions filters to show `Java`
 * and `JavaScript`. Suggested values help guide users to enter values that your
 * app can make sense of. When referring to JavaScript, some users might enter
 * `javascript` and others `java script`. Suggesting `JavaScript` can
 * standardize how users interact with your app. When specified,
 * `TextInput.type` is always `SINGLE_LINE`, even if it's set to
 * `MULTIPLE_LINE`. [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1Suggestions {
  /**
   * A list of suggestions used for autocomplete recommendations in text input
   * fields.
   */
  items?: GoogleAppsCardV1SuggestionItem[];
}

/**
 * Either a toggle-style switch or a checkbox inside a `decoratedText` widget.
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend): Only supported in the
 * `decoratedText` widget.
 */
export interface GoogleAppsCardV1SwitchControl {
  /**
   * How the switch appears in the user interface. [Google Workspace Add-ons
   * and Chat apps](https://developers.google.com/workspace/extend):
   */
  controlType?:  | "SWITCH" | "CHECKBOX" | "CHECK_BOX";
  /**
   * The name by which the switch widget is identified in a form input event.
   * For details about working with form inputs, see [Receive form
   * data](https://developers.google.com/workspace/chat/read-form-data).
   */
  name?: string;
  /**
   * The action to perform when the switch state is changed, such as what
   * function to run.
   */
  onChangeAction?: GoogleAppsCardV1Action;
  /**
   * When `true`, the switch is selected.
   */
  selected?: boolean;
  /**
   * The value entered by a user, returned as part of a form input event. For
   * details about working with form inputs, see [Receive form
   * data](https://developers.google.com/workspace/chat/read-form-data).
   */
  value?: string;
}

/**
 * A field in which users can enter text. Supports suggestions and on-change
 * actions. For an example in Google Chat apps, see [Add a field in which a user
 * can enter
 * text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text).
 * Chat apps receive and can process the value of entered text during form input
 * events. For details about working with form inputs, see [Receive form
 * data](https://developers.google.com/workspace/chat/read-form-data). When you
 * need to collect undefined or abstract data from users, use a text input. To
 * collect defined or enumerated data from users, use the SelectionInput widget.
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1TextInput {
  /**
   * Optional. Specify what action to take when the text input field provides
   * suggestions to users who interact with it. If unspecified, the suggestions
   * are set by `initialSuggestions` and are processed by the client. If
   * specified, the app takes the action specified here, such as running a
   * custom function. [Google Workspace
   * Add-ons](https://developers.google.com/workspace/add-ons):
   */
  autoCompleteAction?: GoogleAppsCardV1Action;
  /**
   * Text that appears below the text input field meant to assist users by
   * prompting them to enter a certain value. This text is always visible.
   * Required if `label` is unspecified. Otherwise, optional.
   */
  hintText?: string;
  /**
   * Suggested values that users can enter. These values appear when users
   * click inside the text input field. As users type, the suggested values
   * dynamically filter to match what the users have typed. For example, a text
   * input field for programming language might suggest Java, JavaScript,
   * Python, and C++. When users start typing `Jav`, the list of suggestions
   * filters to show just `Java` and `JavaScript`. Suggested values help guide
   * users to enter values that your app can make sense of. When referring to
   * JavaScript, some users might enter `javascript` and others `java script`.
   * Suggesting `JavaScript` can standardize how users interact with your app.
   * When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set
   * to `MULTIPLE_LINE`. [Google Workspace Add-ons and Chat
   * apps](https://developers.google.com/workspace/extend):
   */
  initialSuggestions?: GoogleAppsCardV1Suggestions;
  /**
   * The text that appears above the text input field in the user interface.
   * Specify text that helps the user enter the information your app needs. For
   * example, if you are asking someone's name, but specifically need their
   * surname, write `surname` instead of `name`. Required if `hintText` is
   * unspecified. Otherwise, optional.
   */
  label?: string;
  /**
   * The name by which the text input is identified in a form input event. For
   * details about working with form inputs, see [Receive form
   * data](https://developers.google.com/workspace/chat/read-form-data).
   */
  name?: string;
  /**
   * What to do when a change occurs in the text input field. For example, a
   * user adding to the field or deleting text. Examples of actions to take
   * include running a custom function or opening a
   * [dialog](https://developers.google.com/workspace/chat/dialogs) in Google
   * Chat.
   */
  onChangeAction?: GoogleAppsCardV1Action;
  /**
   * Text that appears in the text input field when the field is empty. Use
   * this text to prompt users to enter a value. For example, `Enter a number
   * from 0 to 100`. [Google Chat
   * apps](https://developers.google.com/workspace/chat):
   */
  placeholderText?: string;
  /**
   * How a text input field appears in the user interface. For example, whether
   * the field is single or multi-line.
   */
  type?:  | "SINGLE_LINE" | "MULTIPLE_LINE";
  /**
   * The value entered by a user, returned as part of a form input event. For
   * details about working with form inputs, see [Receive form
   * data](https://developers.google.com/workspace/chat/read-form-data).
   */
  value?: string;
}

/**
 * A paragraph of text that supports formatting. For an example in Google Chat
 * apps, see [Add a paragraph of formatted
 * text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text).
 * For more information about formatting text, see [Formatting text in Google
 * Chat
 * apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
 * and [Formatting text in Google Workspace
 * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
 * [Google Workspace Add-ons and Chat
 * apps](https://developers.google.com/workspace/extend):
 */
export interface GoogleAppsCardV1TextParagraph {
  /**
   * The maximum number of lines of text that are displayed in the widget. If
   * the text exceeds the specified maximum number of lines, the excess content
   * is concealed behind a **show more** button. If the text is equal or shorter
   * than the specified maximum number of lines, a **show more** button isn't
   * displayed. The default value is 0, in which case all context is displayed.
   * Negative values are ignored. [Google Chat
   * apps](https://developers.google.com/workspace/chat):
   */
  maxLines?: number;
  /**
   * The text that's shown in the widget.
   */
  text?: string;
}

/**
 * Each card is made up of widgets. A widget is a composite object that can
 * represent one of text, images, buttons, and other object types.
 */
export interface GoogleAppsCardV1Widget {
  /**
   * A list of buttons. For example, the following JSON creates two buttons.
   * The first is a blue text button and the second is an image button that
   * opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": {
   * "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": {
   * "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": {
   * "openLink": { "url": "https://example.com/calendar" } } } ] } ```
   */
  buttonList?: GoogleAppsCardV1ButtonList;
  /**
   * A list of chips. For example, the following JSON creates two chips. The
   * first is a text chip and the second is an icon chip that opens a link: ```
   * "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": {
   * "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": {
   * "openLink": { "url": "https://example.com/calendar" } } } ] } ``` [Google
   * Chat apps](https://developers.google.com/workspace/chat):
   */
  chipList?: GoogleAppsCardV1ChipList;
  /**
   * Displays up to 2 columns. To include more than 2 columns, or to use rows,
   * use the `Grid` widget. For example, the following JSON creates 2 columns
   * that each contain text paragraphs: ``` "columns": { "columnItems": [ {
   * "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment":
   * "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": {
   * "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle":
   * "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER",
   * "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text":
   * "Second column text paragraph" } } ] } ] } ```
   */
  columns?: GoogleAppsCardV1Columns;
  /**
   * Displays a widget that lets users input a date, time, or date and time.
   * For example, the following JSON creates a date time picker to schedule an
   * appointment: ``` "dateTimePicker": { "name": "appointment_time", "label":
   * "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch":
   * "796435200000" } ```
   */
  dateTimePicker?: GoogleAppsCardV1DateTimePicker;
  /**
   * Displays a decorated text item. For example, the following JSON creates a
   * decorated text widget showing email address: ``` "decoratedText": { "icon":
   * { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text":
   * "sasha@example.com", "bottomLabel": "This is a new Email address!",
   * "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected":
   * false, "controlType": "CHECKBOX" } } ```
   */
  decoratedText?: GoogleAppsCardV1DecoratedText;
  /**
   * Displays a horizontal line divider between widgets. For example, the
   * following JSON creates a divider: ``` "divider": { } ```
   */
  divider?: GoogleAppsCardV1Divider;
  /**
   * Displays a grid with a collection of items. A grid supports any number of
   * columns and items. The number of rows is determined by the upper bounds of
   * the number items divided by the number of columns. A grid with 10 items and
   * 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows.
   * [Google Workspace Add-ons and Chat
   * apps](https://developers.google.com/workspace/extend): For example, the
   * following JSON creates a 2 column grid with a single item: ``` "grid": {
   * "title": "A fine collection of items", "columnCount": 2, "borderStyle": {
   * "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri":
   * "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" },
   * "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment":
   * "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" }
   * } } ```
   */
  grid?: GoogleAppsCardV1Grid;
  /**
   * Specifies whether widgets align to the left, right, or center of a column.
   */
  horizontalAlignment?:  | "HORIZONTAL_ALIGNMENT_UNSPECIFIED" | "START" | "CENTER" | "END";
  /**
   * Displays an image. For example, the following JSON creates an image with
   * alternative text: ``` "image": { "imageUrl":
   * "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
   * "altText": "Chat app avatar" } ```
   */
  image?: GoogleAppsCardV1Image;
  /**
   * Displays a selection control that lets users select items. Selection
   * controls can be checkboxes, radio buttons, switches, or dropdown menus. For
   * example, the following JSON creates a dropdown menu that lets users choose
   * a size: ``` "selectionInput": { "name": "size", "label": "Size" "type":
   * "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false
   * }, { "text": "M", "value": "medium", "selected": true }, { "text": "L",
   * "value": "large", "selected": false }, { "text": "XL", "value":
   * "extra_large", "selected": false } ] } ```
   */
  selectionInput?: GoogleAppsCardV1SelectionInput;
  /**
   * Displays a text box that users can type into. For example, the following
   * JSON creates a text input for an email address: ``` "textInput": { "name":
   * "mailing_address", "label": "Mailing Address" } ``` As another example, the
   * following JSON creates a text input for a programming language with static
   * suggestions: ``` "textInput": { "name": "preferred_programing_language",
   * "label": "Preferred Language", "initialSuggestions": { "items": [ { "text":
   * "C++" }, { "text": "Java" }, { "text": "JavaScript" }, { "text": "Python" }
   * ] } } ```
   */
  textInput?: GoogleAppsCardV1TextInput;
  /**
   * Displays a text paragraph. Supports simple HTML formatted text. For more
   * information about formatting text, see [Formatting text in Google Chat
   * apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
   * and [Formatting text in Google Workspace
   * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
   * For example, the following JSON creates a bolded text: ``` "textParagraph":
   * { "text": " *bold text*" } ```
   */
  textParagraph?: GoogleAppsCardV1TextParagraph;
}

function serializeGoogleAppsCardV1Widget(data: any): GoogleAppsCardV1Widget {
  return {
    ...data,
    buttonList: data["buttonList"] !== undefined ? serializeGoogleAppsCardV1ButtonList(data["buttonList"]) : undefined,
    chipList: data["chipList"] !== undefined ? serializeGoogleAppsCardV1ChipList(data["chipList"]) : undefined,
    columns: data["columns"] !== undefined ? serializeGoogleAppsCardV1Columns(data["columns"]) : undefined,
    dateTimePicker: data["dateTimePicker"] !== undefined ? serializeGoogleAppsCardV1DateTimePicker(data["dateTimePicker"]) : undefined,
    decoratedText: data["decoratedText"] !== undefined ? serializeGoogleAppsCardV1DecoratedText(data["decoratedText"]) : undefined,
    grid: data["grid"] !== undefined ? serializeGoogleAppsCardV1Grid(data["grid"]) : undefined,
    image: data["image"] !== undefined ? serializeGoogleAppsCardV1Image(data["image"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1Widget(data: any): GoogleAppsCardV1Widget {
  return {
    ...data,
    buttonList: data["buttonList"] !== undefined ? deserializeGoogleAppsCardV1ButtonList(data["buttonList"]) : undefined,
    chipList: data["chipList"] !== undefined ? deserializeGoogleAppsCardV1ChipList(data["chipList"]) : undefined,
    columns: data["columns"] !== undefined ? deserializeGoogleAppsCardV1Columns(data["columns"]) : undefined,
    dateTimePicker: data["dateTimePicker"] !== undefined ? deserializeGoogleAppsCardV1DateTimePicker(data["dateTimePicker"]) : undefined,
    decoratedText: data["decoratedText"] !== undefined ? deserializeGoogleAppsCardV1DecoratedText(data["decoratedText"]) : undefined,
    grid: data["grid"] !== undefined ? deserializeGoogleAppsCardV1Grid(data["grid"]) : undefined,
    image: data["image"] !== undefined ? deserializeGoogleAppsCardV1Image(data["image"]) : undefined,
  };
}

/**
 * The supported widgets that you can include in a column. [Google Workspace
 * Add-ons and Chat apps](https://developers.google.com/workspace/extend)
 */
export interface GoogleAppsCardV1Widgets {
  /**
   * ButtonList widget.
   */
  buttonList?: GoogleAppsCardV1ButtonList;
  /**
   * ChipList widget. [Google Chat
   * apps](https://developers.google.com/workspace/chat):
   */
  chipList?: GoogleAppsCardV1ChipList;
  /**
   * DateTimePicker widget.
   */
  dateTimePicker?: GoogleAppsCardV1DateTimePicker;
  /**
   * DecoratedText widget.
   */
  decoratedText?: GoogleAppsCardV1DecoratedText;
  /**
   * Image widget.
   */
  image?: GoogleAppsCardV1Image;
  /**
   * SelectionInput widget.
   */
  selectionInput?: GoogleAppsCardV1SelectionInput;
  /**
   * TextInput widget.
   */
  textInput?: GoogleAppsCardV1TextInput;
  /**
   * TextParagraph widget.
   */
  textParagraph?: GoogleAppsCardV1TextParagraph;
}

function serializeGoogleAppsCardV1Widgets(data: any): GoogleAppsCardV1Widgets {
  return {
    ...data,
    buttonList: data["buttonList"] !== undefined ? serializeGoogleAppsCardV1ButtonList(data["buttonList"]) : undefined,
    chipList: data["chipList"] !== undefined ? serializeGoogleAppsCardV1ChipList(data["chipList"]) : undefined,
    dateTimePicker: data["dateTimePicker"] !== undefined ? serializeGoogleAppsCardV1DateTimePicker(data["dateTimePicker"]) : undefined,
    decoratedText: data["decoratedText"] !== undefined ? serializeGoogleAppsCardV1DecoratedText(data["decoratedText"]) : undefined,
    image: data["image"] !== undefined ? serializeGoogleAppsCardV1Image(data["image"]) : undefined,
  };
}

function deserializeGoogleAppsCardV1Widgets(data: any): GoogleAppsCardV1Widgets {
  return {
    ...data,
    buttonList: data["buttonList"] !== undefined ? deserializeGoogleAppsCardV1ButtonList(data["buttonList"]) : undefined,
    chipList: data["chipList"] !== undefined ? deserializeGoogleAppsCardV1ChipList(data["chipList"]) : undefined,
    dateTimePicker: data["dateTimePicker"] !== undefined ? deserializeGoogleAppsCardV1DateTimePicker(data["dateTimePicker"]) : undefined,
    decoratedText: data["decoratedText"] !== undefined ? deserializeGoogleAppsCardV1DecoratedText(data["decoratedText"]) : undefined,
    image: data["image"] !== undefined ? deserializeGoogleAppsCardV1Image(data["image"]) : undefined,
  };
}

/**
 * A Google Group in Google Chat.
 */
export interface Group {
  /**
   * Resource name for a Google Group. Represents a
   * [group](https://cloud.google.com/identity/docs/reference/rest/v1/groups) in
   * Cloud Identity Groups API. Format: groups/{group}
   */
  name?: string;
}

/**
 * For a `SelectionInput` widget that uses a multiselect menu, a data source
 * from a Google Workspace application. The data source populates selection
 * items for the multiselect menu. [Google Chat
 * apps](https://developers.google.com/workspace/chat):
 */
export interface HostAppDataSourceMarkup {
  /**
   * A data source from Google Chat.
   */
  chatDataSource?: ChatClientDataSourceMarkup;
}

/**
 * An image that's specified by a URL and can have an `onclick` action.
 */
export interface Image {
  /**
   * The aspect ratio of this image (width and height). This field lets you
   * reserve the right height for the image while waiting for it to load. It's
   * not meant to override the built-in aspect ratio of the image. If unset, the
   * server fills it by prefetching the image.
   */
  aspectRatio?: number;
  /**
   * The URL of the image.
   */
  imageUrl?: string;
  /**
   * The `onclick` action.
   */
  onClick?: OnClick;
}

/**
 * An image button with an `onclick` action.
 */
export interface ImageButton {
  /**
   * The icon specified by an `enum` that indices to an icon provided by Chat
   * API.
   */
  icon?:  | "ICON_UNSPECIFIED" | "AIRPLANE" | "BOOKMARK" | "BUS" | "CAR" | "CLOCK" | "CONFIRMATION_NUMBER_ICON" | "DOLLAR" | "DESCRIPTION" | "EMAIL" | "EVENT_PERFORMER" | "EVENT_SEAT" | "FLIGHT_ARRIVAL" | "FLIGHT_DEPARTURE" | "HOTEL" | "HOTEL_ROOM_TYPE" | "INVITE" | "MAP_PIN" | "MEMBERSHIP" | "MULTIPLE_PEOPLE" | "OFFER" | "PERSON" | "PHONE" | "RESTAURANT_ICON" | "SHOPPING_CART" | "STAR" | "STORE" | "TICKET" | "TRAIN" | "VIDEO_CAMERA" | "VIDEO_PLAY";
  /**
   * The icon specified by a URL.
   */
  iconUrl?: string;
  /**
   * The name of this `image_button` that's used for accessibility. Default
   * value is provided if this name isn't specified.
   */
  name?: string;
  /**
   * The `onclick` action.
   */
  onClick?: OnClick;
}

/**
 * Types of data that users can [input on cards or
 * dialogs](https://developers.google.com/chat/ui/read-form-data). The input
 * type depends on the type of values that the widget accepts.
 */
export interface Inputs {
  /**
   * Date input values from a
   * [`DateTimePicker`](https://developers.google.com/chat/api/reference/rest/v1/cards#DateTimePicker)
   * widget that only accepts date values.
   */
  dateInput?: DateInput;
  /**
   * Date and time input values from a
   * [`DateTimePicker`](https://developers.google.com/chat/api/reference/rest/v1/cards#DateTimePicker)
   * widget that accepts both a date and time.
   */
  dateTimeInput?: DateTimeInput;
  /**
   * A list of strings that represent the values that the user inputs in a
   * widget. If the widget only accepts one value, such as a
   * [`TextInput`](https://developers.google.com/chat/api/reference/rest/v1/cards#TextInput)
   * widget, the list contains one string object. If the widget accepts multiple
   * values, such as a
   * [`SelectionInput`](https://developers.google.com/chat/api/reference/rest/v1/cards#selectioninput)
   * widget of checkboxes, the list contains a string object for each value that
   * the user inputs or selects.
   */
  stringInputs?: StringInputs;
  /**
   * Time input values from a
   * [`DateTimePicker`](https://developers.google.com/chat/api/reference/rest/v1/cards#DateTimePicker)
   * widget that only accepts time values.
   */
  timeInput?: TimeInput;
}

function serializeInputs(data: any): Inputs {
  return {
    ...data,
    dateInput: data["dateInput"] !== undefined ? serializeDateInput(data["dateInput"]) : undefined,
    dateTimeInput: data["dateTimeInput"] !== undefined ? serializeDateTimeInput(data["dateTimeInput"]) : undefined,
  };
}

function deserializeInputs(data: any): Inputs {
  return {
    ...data,
    dateInput: data["dateInput"] !== undefined ? deserializeDateInput(data["dateInput"]) : undefined,
    dateTimeInput: data["dateTimeInput"] !== undefined ? deserializeDateTimeInput(data["dateTimeInput"]) : undefined,
  };
}

/**
 * A UI element contains a key (label) and a value (content). This element can
 * also contain some actions such as `onclick` button.
 */
export interface KeyValue {
  /**
   * The text of the bottom label. Formatted text supported. For more
   * information about formatting text, see [Formatting text in Google Chat
   * apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
   * and [Formatting text in Google Workspace
   * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
   */
  bottomLabel?: string;
  /**
   * A button that can be clicked to trigger an action.
   */
  button?: Button;
  /**
   * The text of the content. Formatted text supported and always required. For
   * more information about formatting text, see [Formatting text in Google Chat
   * apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
   * and [Formatting text in Google Workspace
   * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
   */
  content?: string;
  /**
   * If the content should be multiline.
   */
  contentMultiline?: boolean;
  /**
   * An enum value that's replaced by the Chat API with the corresponding icon
   * image.
   */
  icon?:  | "ICON_UNSPECIFIED" | "AIRPLANE" | "BOOKMARK" | "BUS" | "CAR" | "CLOCK" | "CONFIRMATION_NUMBER_ICON" | "DOLLAR" | "DESCRIPTION" | "EMAIL" | "EVENT_PERFORMER" | "EVENT_SEAT" | "FLIGHT_ARRIVAL" | "FLIGHT_DEPARTURE" | "HOTEL" | "HOTEL_ROOM_TYPE" | "INVITE" | "MAP_PIN" | "MEMBERSHIP" | "MULTIPLE_PEOPLE" | "OFFER" | "PERSON" | "PHONE" | "RESTAURANT_ICON" | "SHOPPING_CART" | "STAR" | "STORE" | "TICKET" | "TRAIN" | "VIDEO_CAMERA" | "VIDEO_PLAY";
  /**
   * The icon specified by a URL.
   */
  iconUrl?: string;
  /**
   * The `onclick` action. Only the top label, bottom label, and content region
   * are clickable.
   */
  onClick?: OnClick;
  /**
   * The text of the top label. Formatted text supported. For more information
   * about formatting text, see [Formatting text in Google Chat
   * apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
   * and [Formatting text in Google Workspace
   * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
   */
  topLabel?: string;
}

/**
 * Response to list memberships of the space.
 */
export interface ListMembershipsResponse {
  /**
   * Unordered list. List of memberships in the requested (or first) page.
   */
  memberships?: Membership[];
  /**
   * A token that you can send as `pageToken` to retrieve the next page of
   * results. If empty, there are no subsequent pages.
   */
  nextPageToken?: string;
}

function serializeListMembershipsResponse(data: any): ListMembershipsResponse {
  return {
    ...data,
    memberships: data["memberships"] !== undefined ? data["memberships"].map((item: any) => (serializeMembership(item))) : undefined,
  };
}

function deserializeListMembershipsResponse(data: any): ListMembershipsResponse {
  return {
    ...data,
    memberships: data["memberships"] !== undefined ? data["memberships"].map((item: any) => (deserializeMembership(item))) : undefined,
  };
}

/**
 * Response message for listing messages.
 */
export interface ListMessagesResponse {
  /**
   * List of messages.
   */
  messages?: Message[];
  /**
   * You can send a token as `pageToken` to retrieve the next page of results.
   * If empty, there are no subsequent pages.
   */
  nextPageToken?: string;
}

function serializeListMessagesResponse(data: any): ListMessagesResponse {
  return {
    ...data,
    messages: data["messages"] !== undefined ? data["messages"].map((item: any) => (serializeMessage(item))) : undefined,
  };
}

function deserializeListMessagesResponse(data: any): ListMessagesResponse {
  return {
    ...data,
    messages: data["messages"] !== undefined ? data["messages"].map((item: any) => (deserializeMessage(item))) : undefined,
  };
}

/**
 * Response to a list reactions request.
 */
export interface ListReactionsResponse {
  /**
   * Continuation token to retrieve the next page of results. It's empty for
   * the last page of results.
   */
  nextPageToken?: string;
  /**
   * List of reactions in the requested (or first) page.
   */
  reactions?: Reaction[];
}

/**
 * Response message for listing space events.
 */
export interface ListSpaceEventsResponse {
  /**
   * Continuation token used to fetch more events. If this field is omitted,
   * there are no subsequent pages.
   */
  nextPageToken?: string;
  /**
   * Results are returned in chronological order (oldest event first). Note:
   * The `permissionSettings` field is not returned in the Space object for list
   * requests.
   */
  spaceEvents?: SpaceEvent[];
}

function serializeListSpaceEventsResponse(data: any): ListSpaceEventsResponse {
  return {
    ...data,
    spaceEvents: data["spaceEvents"] !== undefined ? data["spaceEvents"].map((item: any) => (serializeSpaceEvent(item))) : undefined,
  };
}

function deserializeListSpaceEventsResponse(data: any): ListSpaceEventsResponse {
  return {
    ...data,
    spaceEvents: data["spaceEvents"] !== undefined ? data["spaceEvents"].map((item: any) => (deserializeSpaceEvent(item))) : undefined,
  };
}

/**
 * The response for a list spaces request.
 */
export interface ListSpacesResponse {
  /**
   * You can send a token as `pageToken` to retrieve the next page of results.
   * If empty, there are no subsequent pages.
   */
  nextPageToken?: string;
  /**
   * List of spaces in the requested (or first) page. Note: The
   * `permissionSettings` field is not returned in the Space object for list
   * requests.
   */
  spaces?: Space[];
}

function serializeListSpacesResponse(data: any): ListSpacesResponse {
  return {
    ...data,
    spaces: data["spaces"] !== undefined ? data["spaces"].map((item: any) => (serializeSpace(item))) : undefined,
  };
}

function deserializeListSpacesResponse(data: any): ListSpacesResponse {
  return {
    ...data,
    spaces: data["spaces"] !== undefined ? data["spaces"].map((item: any) => (deserializeSpace(item))) : undefined,
  };
}

/**
 * A matched URL in a Chat message. Chat apps can preview matched URLs. For
 * more information, see [Preview
 * links](https://developers.google.com/chat/how-tos/preview-links).
 */
export interface MatchedUrl {
  /**
   * Output only. The URL that was matched.
   */
  readonly url?: string;
}

/**
 * Media resource.
 */
export interface Media {
  /**
   * Name of the media resource.
   */
  resourceName?: string;
}

/**
 * Represents a membership relation in Google Chat, such as whether a user or
 * Chat app is invited to, part of, or absent from a space.
 */
export interface Membership {
  /**
   * Optional. Immutable. The creation time of the membership, such as when a
   * member joined or was invited to join a space. This field is output only,
   * except when used to import historical memberships in import mode spaces.
   */
  createTime?: Date;
  /**
   * Optional. Immutable. The deletion time of the membership, such as when a
   * member left or was removed from a space. This field is output only, except
   * when used to import historical memberships in import mode spaces.
   */
  deleteTime?: Date;
  /**
   * Optional. The Google Group the membership corresponds to. Reading or
   * mutating memberships for Google Groups requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   */
  groupMember?: Group;
  /**
   * Optional. The Google Chat user or app the membership corresponds to. If
   * your Chat app [authenticates as a
   * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
   * the output populates the
   * [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
   * `name` and `type`.
   */
  member?: User;
  /**
   * Identifier. Resource name of the membership, assigned by the server.
   * Format: `spaces/{space}/members/{member}`
   */
  name?: string;
  /**
   * Optional. User's role within a Chat space, which determines their
   * permitted actions in the space. This field can only be used as input in
   * `UpdateMembership`.
   */
  role?:  | "MEMBERSHIP_ROLE_UNSPECIFIED" | "ROLE_MEMBER" | "ROLE_MANAGER";
  /**
   * Output only. State of the membership.
   */
  readonly state?:  | "MEMBERSHIP_STATE_UNSPECIFIED" | "JOINED" | "INVITED" | "NOT_A_MEMBER";
}

function serializeMembership(data: any): Membership {
  return {
    ...data,
    createTime: data["createTime"] !== undefined ? data["createTime"].toISOString() : undefined,
    deleteTime: data["deleteTime"] !== undefined ? data["deleteTime"].toISOString() : undefined,
  };
}

function deserializeMembership(data: any): Membership {
  return {
    ...data,
    createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined,
    deleteTime: data["deleteTime"] !== undefined ? new Date(data["deleteTime"]) : undefined,
  };
}

/**
 * Event payload for multiple new memberships. Event type:
 * `google.workspace.chat.membership.v1.batchCreated`
 */
export interface MembershipBatchCreatedEventData {
  /**
   * A list of new memberships.
   */
  memberships?: MembershipCreatedEventData[];
}

function serializeMembershipBatchCreatedEventData(data: any): MembershipBatchCreatedEventData {
  return {
    ...data,
    memberships: data["memberships"] !== undefined ? data["memberships"].map((item: any) => (serializeMembershipCreatedEventData(item))) : undefined,
  };
}

function deserializeMembershipBatchCreatedEventData(data: any): MembershipBatchCreatedEventData {
  return {
    ...data,
    memberships: data["memberships"] !== undefined ? data["memberships"].map((item: any) => (deserializeMembershipCreatedEventData(item))) : undefined,
  };
}

/**
 * Event payload for multiple deleted memberships. Event type:
 * `google.workspace.chat.membership.v1.batchDeleted`
 */
export interface MembershipBatchDeletedEventData {
  /**
   * A list of deleted memberships.
   */
  memberships?: MembershipDeletedEventData[];
}

function serializeMembershipBatchDeletedEventData(data: any): MembershipBatchDeletedEventData {
  return {
    ...data,
    memberships: data["memberships"] !== undefined ? data["memberships"].map((item: any) => (serializeMembershipDeletedEventData(item))) : undefined,
  };
}

function deserializeMembershipBatchDeletedEventData(data: any): MembershipBatchDeletedEventData {
  return {
    ...data,
    memberships: data["memberships"] !== undefined ? data["memberships"].map((item: any) => (deserializeMembershipDeletedEventData(item))) : undefined,
  };
}

/**
 * Event payload for multiple updated memberships. Event type:
 * `google.workspace.chat.membership.v1.batchUpdated`
 */
export interface MembershipBatchUpdatedEventData {
  /**
   * A list of updated memberships.
   */
  memberships?: MembershipUpdatedEventData[];
}

function serializeMembershipBatchUpdatedEventData(data: any): MembershipBatchUpdatedEventData {
  return {
    ...data,
    memberships: data["memberships"] !== undefined ? data["memberships"].map((item: any) => (serializeMembershipUpdatedEventData(item))) : undefined,
  };
}

function deserializeMembershipBatchUpdatedEventData(data: any): MembershipBatchUpdatedEventData {
  return {
    ...data,
    memberships: data["memberships"] !== undefined ? data["memberships"].map((item: any) => (deserializeMembershipUpdatedEventData(item))) : undefined,
  };
}

/**
 * Represents the count of memberships of a space, grouped into categories.
 */
export interface MembershipCount {
  /**
   * Output only. Count of human users that have directly joined the space, not
   * counting users joined by having membership in a joined group.
   */
  readonly joinedDirectHumanUserCount?: number;
  /**
   * Output only. Count of all groups that have directly joined the space.
   */
  readonly joinedGroupCount?: number;
}

/**
 * Event payload for a new membership. Event type:
 * `google.workspace.chat.membership.v1.created`.
 */
export interface MembershipCreatedEventData {
  /**
   * The new membership.
   */
  membership?: Membership;
}

function serializeMembershipCreatedEventData(data: any): MembershipCreatedEventData {
  return {
    ...data,
    membership: data["membership"] !== undefined ? serializeMembership(data["membership"]) : undefined,
  };
}

function deserializeMembershipCreatedEventData(data: any): MembershipCreatedEventData {
  return {
    ...data,
    membership: data["membership"] !== undefined ? deserializeMembership(data["membership"]) : undefined,
  };
}

/**
 * Event payload for a deleted membership. Event type:
 * `google.workspace.chat.membership.v1.deleted`
 */
export interface MembershipDeletedEventData {
  /**
   * The deleted membership. Only the `name` and `state` fields are populated.
   */
  membership?: Membership;
}

function serializeMembershipDeletedEventData(data: any): MembershipDeletedEventData {
  return {
    ...data,
    membership: data["membership"] !== undefined ? serializeMembership(data["membership"]) : undefined,
  };
}

function deserializeMembershipDeletedEventData(data: any): MembershipDeletedEventData {
  return {
    ...data,
    membership: data["membership"] !== undefined ? deserializeMembership(data["membership"]) : undefined,
  };
}

/**
 * Event payload for an updated membership. Event type:
 * `google.workspace.chat.membership.v1.updated`
 */
export interface MembershipUpdatedEventData {
  /**
   * The updated membership.
   */
  membership?: Membership;
}

function serializeMembershipUpdatedEventData(data: any): MembershipUpdatedEventData {
  return {
    ...data,
    membership: data["membership"] !== undefined ? serializeMembership(data["membership"]) : undefined,
  };
}

function deserializeMembershipUpdatedEventData(data: any): MembershipUpdatedEventData {
  return {
    ...data,
    membership: data["membership"] !== undefined ? deserializeMembership(data["membership"]) : undefined,
  };
}

/**
 * A message in a Google Chat space.
 */
export interface Message {
  /**
   * Optional. One or more interactive widgets that appear at the bottom of a
   * message. You can add accessory widgets to messages that contain text,
   * cards, or both text and cards. Not supported for messages that contain
   * dialogs. For details, see [Add interactive widgets at the bottom of a
   * message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).
   * Creating a message with accessory widgets requires [app authentication]
   * (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
   */
  accessoryWidgets?: AccessoryWidget[];
  /**
   * Input only. Parameters that a Chat app can use to configure how its
   * response is posted.
   */
  actionResponse?: ActionResponse;
  /**
   * Output only. Annotations associated with the `text` in this message.
   */
  readonly annotations?: Annotation[];
  /**
   * Output only. Plain-text body of the message with all Chat app mentions
   * stripped out.
   */
  readonly argumentText?: string;
  /**
   * Output only. GIF images that are attached to the message.
   */
  readonly attachedGifs?: AttachedGif[];
  /**
   * Optional. User-uploaded attachment.
   */
  attachment?: Attachment[];
  /**
   * Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards
   * that you can use to display UI elements such as: formatted texts, buttons,
   * and clickable images. Cards are normally displayed below the plain-text
   * body of the message. `cards` and `cards_v2` can have a maximum size of 32
   * KB.
   */
  cards?: Card[];
  /**
   * Optional. An array of
   * [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards).
   * Only Chat apps can create cards. If your Chat app [authenticates as a
   * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
   * the messages can't contain cards. To learn how to create a message that
   * contains cards, see [Send a
   * message](https://developers.google.com/workspace/chat/create-messages).
   * [Card builder](https://addons.gsuite.google.com/uikit/builder)
   */
  cardsV2?: CardWithId[];
  /**
   * Optional. A custom ID for the message. You can use field to identify a
   * message, or to get, delete, or update a message. To set a custom ID,
   * specify the
   * [`messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id)
   * field when you create the message. For details, see [Name a
   * message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
   */
  clientAssignedMessageId?: string;
  /**
   * Optional. Immutable. For spaces created in Chat, the time at which the
   * message was created. This field is output only, except when used in import
   * mode spaces. For import mode spaces, set this field to the historical
   * timestamp at which the message was created in the source in order to
   * preserve the original creation time.
   */
  createTime?: Date;
  /**
   * Output only. The time at which the message was deleted in Google Chat. If
   * the message is never deleted, this field is empty.
   */
  readonly deleteTime?: Date;
  /**
   * Output only. Information about a deleted message. A message is deleted
   * when `delete_time` is set.
   */
  readonly deletionMetadata?: DeletionMetadata;
  /**
   * Output only. The list of emoji reaction summaries on the message.
   */
  readonly emojiReactionSummaries?: EmojiReactionSummary[];
  /**
   * Optional. A plain-text description of the message's cards, used when the
   * actual cards can't be displayed—for example, mobile notifications.
   */
  fallbackText?: string;
  /**
   * Output only. Contains the message `text` with markups added to communicate
   * formatting. This field might not capture all formatting visible in the UI,
   * but includes the following: * [Markup
   * syntax](https://developers.google.com/workspace/chat/format-messages) for
   * bold, italic, strikethrough, monospace, monospace block, and bulleted list.
   * * [User
   * mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention)
   * using the format ``. * Custom hyperlinks using the format
   * `<{url}|{rendered_text}>` where the first string is the URL and the second
   * is the rendered text—for example, ``. * Custom emoji using the format
   * `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode
   * emoji, such as `U+1F600` for a grinning face emoji. For more information,
   * see [View text formatting sent in a
   * message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message)
   */
  readonly formattedText?: string;
  /**
   * Output only. The time at which the message was last edited by a user. If
   * the message has never been edited, this field is empty.
   */
  readonly lastUpdateTime?: Date;
  /**
   * Output only. A URL in `spaces.messages.text` that matches a link preview
   * pattern. For more information, see [Preview
   * links](https://developers.google.com/workspace/chat/preview-links).
   */
  readonly matchedUrl?: MatchedUrl;
  /**
   * Identifier. Resource name of the message. Format:
   * `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space
   * where the message is posted and `{message}` is a system-assigned ID for the
   * message. For example,
   * `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom
   * ID when you create a message, you can use this ID to specify the message in
   * a request by replacing `{message}` with the value from the
   * `clientAssignedMessageId` field. For example,
   * `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a
   * message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
   */
  name?: string;
  /**
   * Optional. Immutable. Input for creating a message, otherwise output only.
   * The user that can view the message. When set, the message is private and
   * only visible to the specified user and the Chat app. To include this field
   * in your request, you must call the Chat API using [app
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
   * and omit the following: *
   * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments)
   * * [Accessory
   * widgets](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#Message.AccessoryWidget)
   * For details, see [Send a message
   * privately](https://developers.google.com/workspace/chat/create-messages#private).
   */
  privateMessageViewer?: User;
  /**
   * Output only. Information about a message that's quoted by a Google Chat
   * user in a space. Google Chat users can quote a message to reply to it.
   */
  readonly quotedMessageMetadata?: QuotedMessageMetadata;
  /**
   * Output only. The user who created the message. If your Chat app
   * [authenticates as a
   * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
   * the output populates the
   * [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
   * `name` and `type`.
   */
  readonly sender?: User;
  /**
   * Output only. Slash command information, if applicable.
   */
  readonly slashCommand?: SlashCommand;
  /**
   * Output only. If your Chat app [authenticates as a
   * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
   * the output only populates the
   * [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces)
   * `name`.
   */
  readonly space?: Space;
  /**
   * Optional. Plain-text body of the message. The first link to an image,
   * video, or web page generates a [preview
   * chip](https://developers.google.com/workspace/chat/preview-links). You can
   * also [@mention a Google Chat
   * user](https://developers.google.com/workspace/chat/format-messages#messages-@mention),
   * or everyone in the space. To learn about creating text messages, see [Send
   * a message](https://developers.google.com/workspace/chat/create-messages).
   */
  text?: string;
  /**
   * The thread the message belongs to. For example usage, see [Start or reply
   * to a message
   * thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).
   */
  thread?: Thread;
  /**
   * Output only. When `true`, the message is a response in a reply thread.
   * When `false`, the message is visible in the space's top-level conversation
   * as either the first message of a thread or a message with no threaded
   * replies. If the space doesn't support reply in threads, this field is
   * always `false`.
   */
  readonly threadReply?: boolean;
}

function serializeMessage(data: any): Message {
  return {
    ...data,
    accessoryWidgets: data["accessoryWidgets"] !== undefined ? data["accessoryWidgets"].map((item: any) => (serializeAccessoryWidget(item))) : undefined,
    actionResponse: data["actionResponse"] !== undefined ? serializeActionResponse(data["actionResponse"]) : undefined,
    cardsV2: data["cardsV2"] !== undefined ? data["cardsV2"].map((item: any) => (serializeCardWithId(item))) : undefined,
    createTime: data["createTime"] !== undefined ? data["createTime"].toISOString() : undefined,
  };
}

function deserializeMessage(data: any): Message {
  return {
    ...data,
    accessoryWidgets: data["accessoryWidgets"] !== undefined ? data["accessoryWidgets"].map((item: any) => (deserializeAccessoryWidget(item))) : undefined,
    actionResponse: data["actionResponse"] !== undefined ? deserializeActionResponse(data["actionResponse"]) : undefined,
    annotations: data["annotations"] !== undefined ? data["annotations"].map((item: any) => (deserializeAnnotation(item))) : undefined,
    cardsV2: data["cardsV2"] !== undefined ? data["cardsV2"].map((item: any) => (deserializeCardWithId(item))) : undefined,
    createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined,
    deleteTime: data["deleteTime"] !== undefined ? new Date(data["deleteTime"]) : undefined,
    lastUpdateTime: data["lastUpdateTime"] !== undefined ? new Date(data["lastUpdateTime"]) : undefined,
    slashCommand: data["slashCommand"] !== undefined ? deserializeSlashCommand(data["slashCommand"]) : undefined,
    space: data["space"] !== undefined ? deserializeSpace(data["space"]) : undefined,
  };
}

/**
 * Event payload for multiple new messages. Event type:
 * `google.workspace.chat.message.v1.batchCreated`
 */
export interface MessageBatchCreatedEventData {
  /**
   * A list of new messages.
   */
  messages?: MessageCreatedEventData[];
}

function serializeMessageBatchCreatedEventData(data: any): MessageBatchCreatedEventData {
  return {
    ...data,
    messages: data["messages"] !== undefined ? data["messages"].map((item: any) => (serializeMessageCreatedEventData(item))) : undefined,
  };
}

function deserializeMessageBatchCreatedEventData(data: any): MessageBatchCreatedEventData {
  return {
    ...data,
    messages: data["messages"] !== undefined ? data["messages"].map((item: any) => (deserializeMessageCreatedEventData(item))) : undefined,
  };
}

/**
 * Event payload for multiple deleted messages. Event type:
 * `google.workspace.chat.message.v1.batchDeleted`
 */
export interface MessageBatchDeletedEventData {
  /**
   * A list of deleted messages.
   */
  messages?: MessageDeletedEventData[];
}

function serializeMessageBatchDeletedEventData(data: any): MessageBatchDeletedEventData {
  return {
    ...data,
    messages: data["messages"] !== undefined ? data["messages"].map((item: any) => (serializeMessageDeletedEventData(item))) : undefined,
  };
}

function deserializeMessageBatchDeletedEventData(data: any): MessageBatchDeletedEventData {
  return {
    ...data,
    messages: data["messages"] !== undefined ? data["messages"].map((item: any) => (deserializeMessageDeletedEventData(item))) : undefined,
  };
}

/**
 * Event payload for multiple updated messages. Event type:
 * `google.workspace.chat.message.v1.batchUpdated`
 */
export interface MessageBatchUpdatedEventData {
  /**
   * A list of updated messages.
   */
  messages?: MessageUpdatedEventData[];
}

function serializeMessageBatchUpdatedEventData(data: any): MessageBatchUpdatedEventData {
  return {
    ...data,
    messages: data["messages"] !== undefined ? data["messages"].map((item: any) => (serializeMessageUpdatedEventData(item))) : undefined,
  };
}

function deserializeMessageBatchUpdatedEventData(data: any): MessageBatchUpdatedEventData {
  return {
    ...data,
    messages: data["messages"] !== undefined ? data["messages"].map((item: any) => (deserializeMessageUpdatedEventData(item))) : undefined,
  };
}

/**
 * Event payload for a new message. Event type:
 * `google.workspace.chat.message.v1.created`
 */
export interface MessageCreatedEventData {
  /**
   * The new message.
   */
  message?: Message;
}

function serializeMessageCreatedEventData(data: any): MessageCreatedEventData {
  return {
    ...data,
    message: data["message"] !== undefined ? serializeMessage(data["message"]) : undefined,
  };
}

function deserializeMessageCreatedEventData(data: any): MessageCreatedEventData {
  return {
    ...data,
    message: data["message"] !== undefined ? deserializeMessage(data["message"]) : undefined,
  };
}

/**
 * Event payload for a deleted message. Event type:
 * `google.workspace.chat.message.v1.deleted`
 */
export interface MessageDeletedEventData {
  /**
   * The deleted message. Only the `name`, `createTime`, `deleteTime`, and
   * `deletionMetadata` fields are populated.
   */
  message?: Message;
}

function serializeMessageDeletedEventData(data: any): MessageDeletedEventData {
  return {
    ...data,
    message: data["message"] !== undefined ? serializeMessage(data["message"]) : undefined,
  };
}

function deserializeMessageDeletedEventData(data: any): MessageDeletedEventData {
  return {
    ...data,
    message: data["message"] !== undefined ? deserializeMessage(data["message"]) : undefined,
  };
}

/**
 * Event payload for an updated message. Event type:
 * `google.workspace.chat.message.v1.updated`
 */
export interface MessageUpdatedEventData {
  /**
   * The updated message.
   */
  message?: Message;
}

function serializeMessageUpdatedEventData(data: any): MessageUpdatedEventData {
  return {
    ...data,
    message: data["message"] !== undefined ? serializeMessage(data["message"]) : undefined,
  };
}

function deserializeMessageUpdatedEventData(data: any): MessageUpdatedEventData {
  return {
    ...data,
    message: data["message"] !== undefined ? deserializeMessage(data["message"]) : undefined,
  };
}

/**
 * An `onclick` action (for example, open a link).
 */
export interface OnClick {
  /**
   * A form action is triggered by this `onclick` action if specified.
   */
  action?: FormAction;
  /**
   * This `onclick` action triggers an open link action if specified.
   */
  openLink?: OpenLink;
}

/**
 * A link that opens a new window.
 */
export interface OpenLink {
  /**
   * The URL to open.
   */
  url?: string;
}

/**
 * Represents a space permission setting.
 */
export interface PermissionSetting {
  /**
   * Optional. Whether spaces managers have this permission.
   */
  managersAllowed?: boolean;
  /**
   * Optional. Whether non-manager members have this permission.
   */
  membersAllowed?: boolean;
}

/**
 * [Permission settings](https://support.google.com/chat/answer/13340792) that
 * you can specify when updating an existing named space. To set permission
 * settings when creating a space, specify the `PredefinedPermissionSettings`
 * field in your request.
 */
export interface PermissionSettings {
  /**
   * Optional. Setting for managing apps in a space.
   */
  manageApps?: PermissionSetting;
  /**
   * Optional. Setting for managing members and groups in a space.
   */
  manageMembersAndGroups?: PermissionSetting;
  /**
   * Optional. Setting for managing webhooks in a space.
   */
  manageWebhooks?: PermissionSetting;
  /**
   * Optional. Setting for updating space name, avatar, description and
   * guidelines.
   */
  modifySpaceDetails?: PermissionSetting;
  /**
   * Output only. Setting for posting messages in a space.
   */
  readonly postMessages?: PermissionSetting;
  /**
   * Optional. Setting for replying to messages in a space.
   */
  replyMessages?: PermissionSetting;
  /**
   * Optional. Setting for toggling space history on and off.
   */
  toggleHistory?: PermissionSetting;
  /**
   * Optional. Setting for using @all in a space.
   */
  useAtMentionAll?: PermissionSetting;
}

/**
 * Information about a quoted message.
 */
export interface QuotedMessageMetadata {
  /**
   * Output only. The timestamp when the quoted message was created or when the
   * quoted message was last updated.
   */
  readonly lastUpdateTime?: Date;
  /**
   * Output only. Resource name of the quoted message. Format:
   * `spaces/{space}/messages/{message}`
   */
  readonly name?: string;
}

/**
 * A reaction to a message.
 */
export interface Reaction {
  /**
   * Required. The emoji used in the reaction.
   */
  emoji?: Emoji;
  /**
   * Identifier. The resource name of the reaction. Format:
   * `spaces/{space}/messages/{message}/reactions/{reaction}`
   */
  name?: string;
  /**
   * Output only. The user who created the reaction.
   */
  readonly user?: User;
}

/**
 * Event payload for multiple new reactions. Event type:
 * `google.workspace.chat.reaction.v1.batchCreated`
 */
export interface ReactionBatchCreatedEventData {
  /**
   * A list of new reactions.
   */
  reactions?: ReactionCreatedEventData[];
}

/**
 * Event payload for multiple deleted reactions. Event type:
 * `google.workspace.chat.reaction.v1.batchDeleted`
 */
export interface ReactionBatchDeletedEventData {
  /**
   * A list of deleted reactions.
   */
  reactions?: ReactionDeletedEventData[];
}

/**
 * Event payload for a new reaction. Event type:
 * `google.workspace.chat.reaction.v1.created`
 */
export interface ReactionCreatedEventData {
  /**
   * The new reaction.
   */
  reaction?: Reaction;
}

/**
 * Event payload for a deleted reaction. Type:
 * `google.workspace.chat.reaction.v1.deleted`
 */
export interface ReactionDeletedEventData {
  /**
   * The deleted reaction.
   */
  reaction?: Reaction;
}

/**
 * A rich link to a resource.
 */
export interface RichLinkMetadata {
  /**
   * Data for a chat space link.
   */
  chatSpaceLinkData?: ChatSpaceLinkData;
  /**
   * Data for a drive link.
   */
  driveLinkData?: DriveLinkData;
  /**
   * The rich link type.
   */
  richLinkType?:  | "RICH_LINK_TYPE_UNSPECIFIED" | "DRIVE_FILE" | "CHAT_SPACE";
  /**
   * The URI of this link.
   */
  uri?: string;
}

/**
 * Response with a list of spaces corresponding to the search spaces request.
 */
export interface SearchSpacesResponse {
  /**
   * A token that can be used to retrieve the next page. If this field is
   * empty, there are no subsequent pages.
   */
  nextPageToken?: string;
  /**
   * A page of the requested spaces.
   */
  spaces?: Space[];
  /**
   * The total number of spaces that match the query, across all pages. If the
   * result is over 10,000 spaces, this value is an estimate.
   */
  totalSize?: number;
}

function serializeSearchSpacesResponse(data: any): SearchSpacesResponse {
  return {
    ...data,
    spaces: data["spaces"] !== undefined ? data["spaces"].map((item: any) => (serializeSpace(item))) : undefined,
  };
}

function deserializeSearchSpacesResponse(data: any): SearchSpacesResponse {
  return {
    ...data,
    spaces: data["spaces"] !== undefined ? data["spaces"].map((item: any) => (deserializeSpace(item))) : undefined,
  };
}

/**
 * A section contains a collection of widgets that are rendered (vertically) in
 * the order that they are specified. Across all platforms, cards have a narrow
 * fixed width, so there's currently no need for layout properties (for example,
 * float).
 */
export interface Section {
  /**
   * The header of the section. Formatted text is supported. For more
   * information about formatting text, see [Formatting text in Google Chat
   * apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
   * and [Formatting text in Google Workspace
   * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
   */
  header?: string;
  /**
   * A section must contain at least one widget.
   */
  widgets?: WidgetMarkup[];
}

/**
 * List of widget autocomplete results.
 */
export interface SelectionItems {
  /**
   * An array of the SelectionItem objects.
   */
  items?: GoogleAppsCardV1SelectionItem[];
}

/**
 * Request to create a space and add specified users to it.
 */
export interface SetUpSpaceRequest {
  /**
   * Optional. The Google Chat users or groups to invite to join the space.
   * Omit the calling user, as they are added automatically. The set currently
   * allows up to 20 memberships (in addition to the caller). For human
   * membership, the `Membership.member` field must contain a `user` with `name`
   * populated (format: `users/{user}`) and `type` set to `User.Type.HUMAN`. You
   * can only add human users when setting up a space (adding Chat apps is only
   * supported for direct message setup with the calling app). You can also add
   * members using the user's email as an alias for {user}. For example, the
   * `user.name` can be `users/example@gmail.com`. To invite Gmail users or
   * users from external Google Workspace domains, user's email must be used for
   * `{user}`. For Google group membership, the `Membership.group_member` field
   * must contain a `group` with `name` populated (format `groups/{group}`). You
   * can only add Google groups when setting `Space.spaceType` to `SPACE`.
   * Optional when setting `Space.spaceType` to `SPACE`. Required when setting
   * `Space.spaceType` to `GROUP_CHAT`, along with at least two memberships.
   * Required when setting `Space.spaceType` to `DIRECT_MESSAGE` with a human
   * user, along with exactly one membership. Must be empty when creating a 1:1
   * conversation between a human and the calling Chat app (when setting
   * `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to
   * `true`).
   */
  memberships?: Membership[];
  /**
   * Optional. A unique identifier for this request. A random UUID is
   * recommended. Specifying an existing request ID returns the space created
   * with that ID instead of creating a new space. Specifying an existing
   * request ID from the same Chat app with a different authenticated user
   * returns an error.
   */
  requestId?: string;
  /**
   * Required. The `Space.spaceType` field is required. To create a space, set
   * `Space.spaceType` to `SPACE` and set `Space.displayName`. 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. To create a group chat, set
   * `Space.spaceType` to `GROUP_CHAT`. Don't set `Space.displayName`. To create
   * a 1:1 conversation between humans, set `Space.spaceType` to
   * `DIRECT_MESSAGE` and set `Space.singleUserBotDm` to `false`. Don't set
   * `Space.displayName` or `Space.spaceDetails`. To create an 1:1 conversation
   * between a human and the calling Chat app, set `Space.spaceType` to
   * `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`. Don't set
   * `Space.displayName` or `Space.spaceDetails`. If a `DIRECT_MESSAGE` space
   * already exists, that space is returned instead of creating a new space.
   */
  space?: Space;
}

function serializeSetUpSpaceRequest(data: any): SetUpSpaceRequest {
  return {
    ...data,
    memberships: data["memberships"] !== undefined ? data["memberships"].map((item: any) => (serializeMembership(item))) : undefined,
    space: data["space"] !== undefined ? serializeSpace(data["space"]) : undefined,
  };
}

function deserializeSetUpSpaceRequest(data: any): SetUpSpaceRequest {
  return {
    ...data,
    memberships: data["memberships"] !== undefined ? data["memberships"].map((item: any) => (deserializeMembership(item))) : undefined,
    space: data["space"] !== undefined ? deserializeSpace(data["space"]) : undefined,
  };
}

/**
 * A [slash
 * command](https://developers.google.com/workspace/chat/slash-commands) in
 * Google Chat.
 */
export interface SlashCommand {
  /**
   * The ID of the slash command invoked.
   */
  commandId?: bigint;
}

function serializeSlashCommand(data: any): SlashCommand {
  return {
    ...data,
    commandId: data["commandId"] !== undefined ? String(data["commandId"]) : undefined,
  };
}

function deserializeSlashCommand(data: any): SlashCommand {
  return {
    ...data,
    commandId: data["commandId"] !== undefined ? BigInt(data["commandId"]) : undefined,
  };
}

/**
 * Annotation metadata for slash commands (/).
 */
export interface SlashCommandMetadata {
  /**
   * The Chat app whose command was invoked.
   */
  bot?: User;
  /**
   * The command ID of the invoked slash command.
   */
  commandId?: bigint;
  /**
   * The name of the invoked slash command.
   */
  commandName?: string;
  /**
   * Indicates whether the slash command is for a dialog.
   */
  triggersDialog?: boolean;
  /**
   * The type of slash command.
   */
  type?:  | "TYPE_UNSPECIFIED" | "ADD" | "INVOKE";
}

function serializeSlashCommandMetadata(data: any): SlashCommandMetadata {
  return {
    ...data,
    commandId: data["commandId"] !== undefined ? String(data["commandId"]) : undefined,
  };
}

function deserializeSlashCommandMetadata(data: any): SlashCommandMetadata {
  return {
    ...data,
    commandId: data["commandId"] !== undefined ? BigInt(data["commandId"]) : undefined,
  };
}

/**
 * A space in Google Chat. Spaces are conversations between two or more users
 * or 1:1 messages between a user and a Chat app.
 */
export interface Space {
  /**
   * Optional. Specifies the [access
   * setting](https://support.google.com/chat/answer/11971020) of the space.
   * Only populated when the `space_type` is `SPACE`.
   */
  accessSettings?: AccessSettings;
  /**
   * Output only. For direct message (DM) spaces with a Chat app, whether the
   * space was created by a Google Workspace administrator. Administrators can
   * install and set up a direct message with a Chat app on behalf of users in
   * their organization. To support admin install, your Chat app must feature
   * direct messaging.
   */
  readonly adminInstalled?: boolean;
  /**
   * Optional. Immutable. For spaces created in Chat, the time the space was
   * created. This field is output only, except when used in import mode spaces.
   * For import mode spaces, set this field to the historical timestamp at which
   * the space was created in the source in order to preserve the original
   * creation time. Only populated in the output when `spaceType` is
   * `GROUP_CHAT` or `SPACE`.
   */
  createTime?: Date;
  /**
   * Optional. The space's display name. Required when [creating a
   * space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create)
   * with a `spaceType` of `SPACE`. If you receive the error message
   * `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a
   * different `displayName`. An existing space within the Google Workspace
   * organization might already use this display name. For direct messages, this
   * field might be empty. Supports up to 128 characters.
   */
  displayName?: string;
  /**
   * Optional. Immutable. Whether this space permits any Google Chat user as a
   * member. Input when creating a space in a Google Workspace organization.
   * Omit this field when creating spaces in the following conditions: * The
   * authenticated user uses a consumer account (unmanaged user account). By
   * default, a space created by a consumer account permits any Google Chat
   * user. For existing spaces, this field is output only.
   */
  externalUserAllowed?: boolean;
  /**
   * Optional. Whether this space is created in `Import Mode` as part of a data
   * migration into Google Workspace. While spaces are being imported, they
   * aren't visible to users until the import is complete. Creating a space in
   * `Import Mode`requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   */
  importMode?: boolean;
  /**
   * Output only. Timestamp of the last message in the space.
   */
  readonly lastActiveTime?: Date;
  /**
   * Output only. The count of joined memberships grouped by member type.
   * Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or
   * `GROUP_CHAT`.
   */
  readonly membershipCount?: MembershipCount;
  /**
   * Identifier. Resource name of the space. Format: `spaces/{space}` Where
   * `{space}` represents the system-assigned ID for the space. You can obtain
   * the space ID by calling the
   * [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list)
   * method or from the space URL. For example, if the space URL is
   * `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is
   * `AAAAAAAAA`.
   */
  name?: string;
  /**
   * Optional. Space permission settings for existing spaces. Input for
   * updating exact space permission settings, where existing permission
   * settings are replaced. Output lists current permission settings.
   */
  permissionSettings?: PermissionSettings;
  /**
   * Optional. Input only. Predefined space permission settings, input only
   * when creating a space. If the field is not set, a collaboration space is
   * created. After you create the space, settings are populated in the
   * `PermissionSettings` field.
   */
  predefinedPermissionSettings?:  | "PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED" | "COLLABORATION_SPACE" | "ANNOUNCEMENT_SPACE";
  /**
   * Optional. Whether the space is a DM between a Chat app and a single human.
   */
  singleUserBotDm?: boolean;
  /**
   * Optional. Details about the space including description and rules.
   */
  spaceDetails?: SpaceDetails;
  /**
   * Optional. The message history state for messages and threads in this
   * space.
   */
  spaceHistoryState?:  | "HISTORY_STATE_UNSPECIFIED" | "HISTORY_OFF" | "HISTORY_ON";
  /**
   * Output only. The threading state in the Chat space.
   */
  readonly spaceThreadingState?:  | "SPACE_THREADING_STATE_UNSPECIFIED" | "THREADED_MESSAGES" | "GROUPED_MESSAGES" | "UNTHREADED_MESSAGES";
  /**
   * Optional. The type of space. Required when creating a space or updating
   * the space type of a space. Output only for other usage.
   */
  spaceType?:  | "SPACE_TYPE_UNSPECIFIED" | "SPACE" | "GROUP_CHAT" | "DIRECT_MESSAGE";
  /**
   * Output only. The URI for a user to access the space.
   */
  readonly spaceUri?: string;
  /**
   * Output only. Deprecated: Use `spaceThreadingState` instead. Whether
   * messages are threaded in this space.
   */
  readonly threaded?: boolean;
  /**
   * Output only. Deprecated: Use `space_type` instead. The type of a space.
   */
  readonly type?:  | "TYPE_UNSPECIFIED" | "ROOM" | "DM";
}

function serializeSpace(data: any): Space {
  return {
    ...data,
    createTime: data["createTime"] !== undefined ? data["createTime"].toISOString() : undefined,
  };
}

function deserializeSpace(data: any): Space {
  return {
    ...data,
    createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined,
    lastActiveTime: data["lastActiveTime"] !== undefined ? new Date(data["lastActiveTime"]) : undefined,
  };
}

/**
 * Event payload for multiple updates to a space. Event type:
 * `google.workspace.chat.space.v1.batchUpdated`
 */
export interface SpaceBatchUpdatedEventData {
  /**
   * A list of updated spaces.
   */
  spaces?: SpaceUpdatedEventData[];
}

function serializeSpaceBatchUpdatedEventData(data: any): SpaceBatchUpdatedEventData {
  return {
    ...data,
    spaces: data["spaces"] !== undefined ? data["spaces"].map((item: any) => (serializeSpaceUpdatedEventData(item))) : undefined,
  };
}

function deserializeSpaceBatchUpdatedEventData(data: any): SpaceBatchUpdatedEventData {
  return {
    ...data,
    spaces: data["spaces"] !== undefined ? data["spaces"].map((item: any) => (deserializeSpaceUpdatedEventData(item))) : undefined,
  };
}

/**
 * A data source that populates Google Chat spaces as selection items for a
 * multiselect menu. Only populates spaces that the user is a member of. [Google
 * Chat apps](https://developers.google.com/workspace/chat):
 */
export interface SpaceDataSource {
  /**
   * If set to `true`, the multiselect menu selects the current Google Chat
   * space as an item by default.
   */
  defaultToCurrentSpace?: boolean;
}

/**
 * Details about the space including description and rules.
 */
export interface SpaceDetails {
  /**
   * Optional. A description of the space. For example, describe the space's
   * discussion topic, functional purpose, or participants. Supports up to 150
   * characters.
   */
  description?: string;
  /**
   * Optional. The space's rules, expectations, and etiquette. Supports up to
   * 5,000 characters.
   */
  guidelines?: string;
}

/**
 * An event that represents a change or activity in a Google Chat space. To
 * learn more, see [Work with events from Google
 * Chat](https://developers.google.com/workspace/chat/events-overview).
 */
export interface SpaceEvent {
  /**
   * Time when the event occurred.
   */
  eventTime?: Date;
  /**
   * Type of space event. Each event type has a batch version, which represents
   * multiple instances of the event type that occur in a short period of time.
   * For `spaceEvents.list()` requests, omit batch event types in your query
   * filter. By default, the server returns both event type and its batch
   * version. Supported event types for
   * [messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages):
   * * New message: `google.workspace.chat.message.v1.created` * Updated
   * message: `google.workspace.chat.message.v1.updated` * Deleted message:
   * `google.workspace.chat.message.v1.deleted` * Multiple new messages:
   * `google.workspace.chat.message.v1.batchCreated` * Multiple updated
   * messages: `google.workspace.chat.message.v1.batchUpdated` * Multiple
   * deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported
   * event types for
   * [memberships](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members):
   * * New membership: `google.workspace.chat.membership.v1.created` * Updated
   * membership: `google.workspace.chat.membership.v1.updated` * Deleted
   * membership: `google.workspace.chat.membership.v1.deleted` * Multiple new
   * memberships: `google.workspace.chat.membership.v1.batchCreated` * Multiple
   * updated memberships: `google.workspace.chat.membership.v1.batchUpdated` *
   * Multiple deleted memberships:
   * `google.workspace.chat.membership.v1.batchDeleted` Supported event types
   * for
   * [reactions](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions):
   * * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted
   * reaction: `google.workspace.chat.reaction.v1.deleted` * Multiple new
   * reactions: `google.workspace.chat.reaction.v1.batchCreated` * Multiple
   * deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted`
   * Supported event types about the
   * [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces):
   * * Updated space: `google.workspace.chat.space.v1.updated` * Multiple space
   * updates: `google.workspace.chat.space.v1.batchUpdated`
   */
  eventType?: string;
  /**
   * Event payload for multiple new memberships. Event type:
   * `google.workspace.chat.membership.v1.batchCreated`
   */
  membershipBatchCreatedEventData?: MembershipBatchCreatedEventData;
  /**
   * Event payload for multiple deleted memberships. Event type:
   * `google.workspace.chat.membership.v1.batchDeleted`
   */
  membershipBatchDeletedEventData?: MembershipBatchDeletedEventData;
  /**
   * Event payload for multiple updated memberships. Event type:
   * `google.workspace.chat.membership.v1.batchUpdated`
   */
  membershipBatchUpdatedEventData?: MembershipBatchUpdatedEventData;
  /**
   * Event payload for a new membership. Event type:
   * `google.workspace.chat.membership.v1.created`
   */
  membershipCreatedEventData?: MembershipCreatedEventData;
  /**
   * Event payload for a deleted membership. Event type:
   * `google.workspace.chat.membership.v1.deleted`
   */
  membershipDeletedEventData?: MembershipDeletedEventData;
  /**
   * Event payload for an updated membership. Event type:
   * `google.workspace.chat.membership.v1.updated`
   */
  membershipUpdatedEventData?: MembershipUpdatedEventData;
  /**
   * Event payload for multiple new messages. Event type:
   * `google.workspace.chat.message.v1.batchCreated`
   */
  messageBatchCreatedEventData?: MessageBatchCreatedEventData;
  /**
   * Event payload for multiple deleted messages. Event type:
   * `google.workspace.chat.message.v1.batchDeleted`
   */
  messageBatchDeletedEventData?: MessageBatchDeletedEventData;
  /**
   * Event payload for multiple updated messages. Event type:
   * `google.workspace.chat.message.v1.batchUpdated`
   */
  messageBatchUpdatedEventData?: MessageBatchUpdatedEventData;
  /**
   * Event payload for a new message. Event type:
   * `google.workspace.chat.message.v1.created`
   */
  messageCreatedEventData?: MessageCreatedEventData;
  /**
   * Event payload for a deleted message. Event type:
   * `google.workspace.chat.message.v1.deleted`
   */
  messageDeletedEventData?: MessageDeletedEventData;
  /**
   * Event payload for an updated message. Event type:
   * `google.workspace.chat.message.v1.updated`
   */
  messageUpdatedEventData?: MessageUpdatedEventData;
  /**
   * Resource name of the space event. Format:
   * `spaces/{space}/spaceEvents/{spaceEvent}`
   */
  name?: string;
  /**
   * Event payload for multiple new reactions. Event type:
   * `google.workspace.chat.reaction.v1.batchCreated`
   */
  reactionBatchCreatedEventData?: ReactionBatchCreatedEventData;
  /**
   * Event payload for multiple deleted reactions. Event type:
   * `google.workspace.chat.reaction.v1.batchDeleted`
   */
  reactionBatchDeletedEventData?: ReactionBatchDeletedEventData;
  /**
   * Event payload for a new reaction. Event type:
   * `google.workspace.chat.reaction.v1.created`
   */
  reactionCreatedEventData?: ReactionCreatedEventData;
  /**
   * Event payload for a deleted reaction. Event type:
   * `google.workspace.chat.reaction.v1.deleted`
   */
  reactionDeletedEventData?: ReactionDeletedEventData;
  /**
   * Event payload for multiple updates to a space. Event type:
   * `google.workspace.chat.space.v1.batchUpdated`
   */
  spaceBatchUpdatedEventData?: SpaceBatchUpdatedEventData;
  /**
   * Event payload for a space update. Event type:
   * `google.workspace.chat.space.v1.updated`
   */
  spaceUpdatedEventData?: SpaceUpdatedEventData;
}

function serializeSpaceEvent(data: any): SpaceEvent {
  return {
    ...data,
    eventTime: data["eventTime"] !== undefined ? data["eventTime"].toISOString() : undefined,
    membershipBatchCreatedEventData: data["membershipBatchCreatedEventData"] !== undefined ? serializeMembershipBatchCreatedEventData(data["membershipBatchCreatedEventData"]) : undefined,
    membershipBatchDeletedEventData: data["membershipBatchDeletedEventData"] !== undefined ? serializeMembershipBatchDeletedEventData(data["membershipBatchDeletedEventData"]) : undefined,
    membershipBatchUpdatedEventData: data["membershipBatchUpdatedEventData"] !== undefined ? serializeMembershipBatchUpdatedEventData(data["membershipBatchUpdatedEventData"]) : undefined,
    membershipCreatedEventData: data["membershipCreatedEventData"] !== undefined ? serializeMembershipCreatedEventData(data["membershipCreatedEventData"]) : undefined,
    membershipDeletedEventData: data["membershipDeletedEventData"] !== undefined ? serializeMembershipDeletedEventData(data["membershipDeletedEventData"]) : undefined,
    membershipUpdatedEventData: data["membershipUpdatedEventData"] !== undefined ? serializeMembershipUpdatedEventData(data["membershipUpdatedEventData"]) : undefined,
    messageBatchCreatedEventData: data["messageBatchCreatedEventData"] !== undefined ? serializeMessageBatchCreatedEventData(data["messageBatchCreatedEventData"]) : undefined,
    messageBatchDeletedEventData: data["messageBatchDeletedEventData"] !== undefined ? serializeMessageBatchDeletedEventData(data["messageBatchDeletedEventData"]) : undefined,
    messageBatchUpdatedEventData: data["messageBatchUpdatedEventData"] !== undefined ? serializeMessageBatchUpdatedEventData(data["messageBatchUpdatedEventData"]) : undefined,
    messageCreatedEventData: data["messageCreatedEventData"] !== undefined ? serializeMessageCreatedEventData(data["messageCreatedEventData"]) : undefined,
    messageDeletedEventData: data["messageDeletedEventData"] !== undefined ? serializeMessageDeletedEventData(data["messageDeletedEventData"]) : undefined,
    messageUpdatedEventData: data["messageUpdatedEventData"] !== undefined ? serializeMessageUpdatedEventData(data["messageUpdatedEventData"]) : undefined,
    spaceBatchUpdatedEventData: data["spaceBatchUpdatedEventData"] !== undefined ? serializeSpaceBatchUpdatedEventData(data["spaceBatchUpdatedEventData"]) : undefined,
    spaceUpdatedEventData: data["spaceUpdatedEventData"] !== undefined ? serializeSpaceUpdatedEventData(data["spaceUpdatedEventData"]) : undefined,
  };
}

function deserializeSpaceEvent(data: any): SpaceEvent {
  return {
    ...data,
    eventTime: data["eventTime"] !== undefined ? new Date(data["eventTime"]) : undefined,
    membershipBatchCreatedEventData: data["membershipBatchCreatedEventData"] !== undefined ? deserializeMembershipBatchCreatedEventData(data["membershipBatchCreatedEventData"]) : undefined,
    membershipBatchDeletedEventData: data["membershipBatchDeletedEventData"] !== undefined ? deserializeMembershipBatchDeletedEventData(data["membershipBatchDeletedEventData"]) : undefined,
    membershipBatchUpdatedEventData: data["membershipBatchUpdatedEventData"] !== undefined ? deserializeMembershipBatchUpdatedEventData(data["membershipBatchUpdatedEventData"]) : undefined,
    membershipCreatedEventData: data["membershipCreatedEventData"] !== undefined ? deserializeMembershipCreatedEventData(data["membershipCreatedEventData"]) : undefined,
    membershipDeletedEventData: data["membershipDeletedEventData"] !== undefined ? deserializeMembershipDeletedEventData(data["membershipDeletedEventData"]) : undefined,
    membershipUpdatedEventData: data["membershipUpdatedEventData"] !== undefined ? deserializeMembershipUpdatedEventData(data["membershipUpdatedEventData"]) : undefined,
    messageBatchCreatedEventData: data["messageBatchCreatedEventData"] !== undefined ? deserializeMessageBatchCreatedEventData(data["messageBatchCreatedEventData"]) : undefined,
    messageBatchDeletedEventData: data["messageBatchDeletedEventData"] !== undefined ? deserializeMessageBatchDeletedEventData(data["messageBatchDeletedEventData"]) : undefined,
    messageBatchUpdatedEventData: data["messageBatchUpdatedEventData"] !== undefined ? deserializeMessageBatchUpdatedEventData(data["messageBatchUpdatedEventData"]) : undefined,
    messageCreatedEventData: data["messageCreatedEventData"] !== undefined ? deserializeMessageCreatedEventData(data["messageCreatedEventData"]) : undefined,
    messageDeletedEventData: data["messageDeletedEventData"] !== undefined ? deserializeMessageDeletedEventData(data["messageDeletedEventData"]) : undefined,
    messageUpdatedEventData: data["messageUpdatedEventData"] !== undefined ? deserializeMessageUpdatedEventData(data["messageUpdatedEventData"]) : undefined,
    spaceBatchUpdatedEventData: data["spaceBatchUpdatedEventData"] !== undefined ? deserializeSpaceBatchUpdatedEventData(data["spaceBatchUpdatedEventData"]) : undefined,
    spaceUpdatedEventData: data["spaceUpdatedEventData"] !== undefined ? deserializeSpaceUpdatedEventData(data["spaceUpdatedEventData"]) : undefined,
  };
}

/**
 * A user's read state within a space, used to identify read and unread
 * messages.
 */
export interface SpaceReadState {
  /**
   * Optional. The time when the user's space read state was updated. Usually
   * this corresponds with either the timestamp of the last read message, or a
   * timestamp specified by the user to mark the last read position in a space.
   */
  lastReadTime?: Date;
  /**
   * Resource name of the space read state. Format:
   * `users/{user}/spaces/{space}/spaceReadState`
   */
  name?: string;
}

function serializeSpaceReadState(data: any): SpaceReadState {
  return {
    ...data,
    lastReadTime: data["lastReadTime"] !== undefined ? data["lastReadTime"].toISOString() : undefined,
  };
}

function deserializeSpaceReadState(data: any): SpaceReadState {
  return {
    ...data,
    lastReadTime: data["lastReadTime"] !== undefined ? new Date(data["lastReadTime"]) : undefined,
  };
}

/**
 * Additional options for Chat#spacesCreate.
 */
export interface SpacesCreateOptions {
  /**
   * Optional. A unique identifier for this request. A random UUID is
   * recommended. Specifying an existing request ID returns the space created
   * with that ID instead of creating a new space. Specifying an existing
   * request ID from the same Chat app with a different authenticated user
   * returns an error.
   */
  requestId?: string;
}

/**
 * Additional options for Chat#spacesDelete.
 */
export interface SpacesDeleteOptions {
  /**
   * Optional. When `true`, the method runs using the user's Google Workspace
   * administrator privileges. The calling user must be a Google Workspace
   * administrator with the [manage chat and spaces conversations
   * privilege](https://support.google.com/a/answer/13369245). Requires the
   * `chat.admin.delete` [OAuth 2.0
   * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   */
  useAdminAccess?: boolean;
}

/**
 * Additional options for Chat#spacesFindDirectMessage.
 */
export interface SpacesFindDirectMessageOptions {
  /**
   * Required. Resource name of the user to find direct message with. Format:
   * `users/{user}`, where `{user}` is either the `id` for the
   * [person](https://developers.google.com/people/api/rest/v1/people) from the
   * People API, or the `id` for the
   * [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users)
   * in the Directory API. For example, if the People API profile ID is
   * `123456789`, you can find a direct message with that person by using
   * `users/123456789` as the `name`. When [authenticated as a
   * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
   * you can use the email as an alias for `{user}`. For example,
   * `users/example@gmail.com` where `example@gmail.com` is the email of the
   * Google Chat user.
   */
  name?: string;
}

/**
 * Additional options for Chat#spacesGet.
 */
export interface SpacesGetOptions {
  /**
   * Optional. When `true`, the method runs using the user's Google Workspace
   * administrator privileges. The calling user must be a Google Workspace
   * administrator with the [manage chat and spaces conversations
   * privilege](https://support.google.com/a/answer/13369245). Requires the
   * `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0
   * scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   */
  useAdminAccess?: boolean;
}

/**
 * Additional options for Chat#spacesList.
 */
export interface SpacesListOptions {
  /**
   * Optional. A query filter. You can filter spaces by the space type
   * ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)).
   * To filter by space type, you must specify valid enum value, such as `SPACE`
   * or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To
   * query for multiple space types, use the `OR` operator. For example, the
   * following queries are valid: ``` space_type = "SPACE" spaceType =
   * "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE" ``` Invalid queries are
   * rejected by the server with an `INVALID_ARGUMENT` error.
   */
  filter?: string;
  /**
   * Optional. The maximum number of spaces to return. The service might return
   * fewer than this value. If unspecified, at most 100 spaces are returned. The
   * maximum value is 1000. If you use a value more than 1000, it's
   * automatically changed to 1000. Negative values return an `INVALID_ARGUMENT`
   * error.
   */
  pageSize?: number;
  /**
   * Optional. A page token, received from a previous list spaces call. Provide
   * this parameter to retrieve the subsequent page. When paginating, the filter
   * value should match the call that provided the page token. Passing a
   * different value may lead to unexpected results.
   */
  pageToken?: string;
}

/**
 * Additional options for Chat#spacesMembersCreate.
 */
export interface SpacesMembersCreateOptions {
  /**
   * Optional. When `true`, the method runs using the user's Google Workspace
   * administrator privileges. The calling user must be a Google Workspace
   * administrator with the [manage chat and spaces conversations
   * privilege](https://support.google.com/a/answer/13369245). Requires the
   * `chat.admin.memberships` [OAuth 2.0
   * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   * Creating app memberships or creating memberships for users outside the
   * administrator's Google Workspace organization isn't supported using admin
   * access.
   */
  useAdminAccess?: boolean;
}

/**
 * Additional options for Chat#spacesMembersDelete.
 */
export interface SpacesMembersDeleteOptions {
  /**
   * Optional. When `true`, the method runs using the user's Google Workspace
   * administrator privileges. The calling user must be a Google Workspace
   * administrator with the [manage chat and spaces conversations
   * privilege](https://support.google.com/a/answer/13369245). Requires the
   * `chat.admin.memberships` [OAuth 2.0
   * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   * Deleting app memberships in a space isn't supported using admin access.
   */
  useAdminAccess?: boolean;
}

/**
 * Additional options for Chat#spacesMembersGet.
 */
export interface SpacesMembersGetOptions {
  /**
   * Optional. When `true`, the method runs using the user's Google Workspace
   * administrator privileges. The calling user must be a Google Workspace
   * administrator with the [manage chat and spaces conversations
   * privilege](https://support.google.com/a/answer/13369245). Requires the
   * `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0
   * scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   * Getting app memberships in a space isn't supported when using admin access.
   */
  useAdminAccess?: boolean;
}

/**
 * Additional options for Chat#spacesMembersList.
 */
export interface SpacesMembersListOptions {
  /**
   * Optional. A query filter. You can filter memberships by a member's role
   * ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole))
   * and type
   * ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)).
   * To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter
   * by type, set `member.type` to `HUMAN` or `BOT`. You can also filter for
   * `member.type` using the `!=` operator. To filter by both role and type, use
   * the `AND` operator. To filter by either role or type, use the `OR`
   * operator. Either `member.type = "HUMAN"` or `member.type != "BOT"` is
   * required when `use_admin_access` is set to true. Other member type filters
   * will be rejected. For example, the following queries are valid: ``` role =
   * "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role =
   * "ROLE_MANAGER" member.type != "BOT" ``` The following queries are invalid:
   * ``` member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND
   * role = "ROLE_MEMBER" ``` Invalid queries are rejected by the server with an
   * `INVALID_ARGUMENT` error.
   */
  filter?: string;
  /**
   * Optional. The maximum number of memberships to return. The service might
   * return fewer than this value. If unspecified, at most 100 memberships are
   * returned. The maximum value is 1000. If you use a value more than 1000,
   * it's automatically changed to 1000. Negative values return an
   * `INVALID_ARGUMENT` error.
   */
  pageSize?: number;
  /**
   * Optional. A page token, received from a previous call to list memberships.
   * Provide this parameter to retrieve the subsequent page. When paginating,
   * all other parameters provided should match the call that provided the page
   * token. Passing different values to the other parameters might lead to
   * unexpected results.
   */
  pageToken?: string;
  /**
   * Optional. When `true`, also returns memberships associated with a Google
   * Group, in addition to other types of memberships. If a filter is set,
   * Google Group memberships that don't match the filter criteria aren't
   * returned.
   */
  showGroups?: boolean;
  /**
   * Optional. When `true`, also returns memberships associated with invited
   * members, in addition to other types of memberships. If a filter is set,
   * invited memberships that don't match the filter criteria aren't returned.
   * Currently requires [user
   * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   */
  showInvited?: boolean;
  /**
   * Optional. When `true`, the method runs using the user's Google Workspace
   * administrator privileges. The calling user must be a Google Workspace
   * administrator with the [manage chat and spaces conversations
   * privilege](https://support.google.com/a/answer/13369245). Requires either
   * the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth
   * 2.0
   * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   * Listing app memberships in a space isn't supported when using admin access.
   */
  useAdminAccess?: boolean;
}

/**
 * Additional options for Chat#spacesMembersPatch.
 */
export interface SpacesMembersPatchOptions {
  /**
   * Required. The field paths to update. Separate multiple values with commas
   * or use `*` to update all field paths. Currently supported field paths: -
   * `role`
   */
  updateMask?: string /* FieldMask */;
  /**
   * Optional. When `true`, the method runs using the user's Google Workspace
   * administrator privileges. The calling user must be a Google Workspace
   * administrator with the [manage chat and spaces conversations
   * privilege](https://support.google.com/a/answer/13369245). Requires the
   * `chat.admin.memberships` [OAuth 2.0
   * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   */
  useAdminAccess?: boolean;
}

function serializeSpacesMembersPatchOptions(data: any): SpacesMembersPatchOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

function deserializeSpacesMembersPatchOptions(data: any): SpacesMembersPatchOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

/**
 * Additional options for Chat#spacesMessagesCreate.
 */
export interface SpacesMessagesCreateOptions {
  /**
   * Optional. A custom ID for a message. Lets Chat apps get, update, or delete
   * a message without needing to store the system-assigned ID in the message's
   * resource name (represented in the message `name` field). The value for this
   * field must meet the following requirements: * Begins with `client-`. For
   * example, `client-custom-name` is a valid custom ID, but `custom-name` is
   * not. * Contains up to 63 characters and only lowercase letters, numbers,
   * and hyphens. * Is unique within a space. A Chat app can't use the same
   * custom ID for different messages. For details, see [Name a
   * message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
   */
  messageId?: string;
  /**
   * Optional. Specifies whether a message starts a thread or replies to one.
   * Only supported in named spaces. When [responding to user
   * interactions](https://developers.google.com/workspace/chat/receive-respond-interactions),
   * this field is ignored. For interactions within a thread, the reply is
   * created in the same thread. Otherwise, the reply is created as a new
   * thread.
   */
  messageReplyOption?:  | "MESSAGE_REPLY_OPTION_UNSPECIFIED" | "REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD" | "REPLY_MESSAGE_OR_FAIL";
  /**
   * Optional. A unique request ID for this message. Specifying an existing
   * request ID returns the message created with that ID instead of creating a
   * new message.
   */
  requestId?: string;
  /**
   * Optional. Deprecated: Use thread.thread_key instead. ID for the thread.
   * Supports up to 4000 characters. To start or add to a thread, create a
   * message and specify a `threadKey` or the thread.name. For example usage,
   * see [Start or reply to a message
   * thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).
   */
  threadKey?: string;
}

/**
 * Additional options for Chat#spacesMessagesDelete.
 */
export interface SpacesMessagesDeleteOptions {
  /**
   * Optional. When `true`, deleting a message also deletes its threaded
   * replies. When `false`, if a message has threaded replies, deletion fails.
   * Only applies when [authenticating as a
   * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   * Has no effect when [authenticating as a Chat app]
   * (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
   */
  force?: boolean;
}

/**
 * Additional options for Chat#spacesMessagesList.
 */
export interface SpacesMessagesListOptions {
  /**
   * Optional. A query filter. You can filter messages by date (`create_time`)
   * and thread (`thread.name`). To filter messages by the date they were
   * created, specify the `create_time` with a timestamp in
   * [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and double
   * quotation marks. For example, `"2023-04-21T11:30:00-04:00"`. You can use
   * the greater than operator `>` to list messages that were created after a
   * timestamp, or the less than operator `<` to list messages that were created
   * before a timestamp. To filter messages within a time interval, use the
   * `AND` operator between two timestamps. To filter by thread, specify the
   * `thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can only
   * specify one `thread.name` per query. To filter by both thread and date, use
   * the `AND` operator in your query. For example, the following queries are
   * valid: ``` create_time > "2012-04-21T11:30:00-04:00" create_time >
   * "2012-04-21T11:30:00-04:00" AND thread.name =
   * spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00"
   * AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name =
   * spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123
   * ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
   * error.
   */
  filter?: string;
  /**
   * Optional. How the list of messages is ordered. Specify a value to order by
   * an ordering operation. Valid ordering operation values are as follows: -
   * `ASC` for ascending. - `DESC` for descending. The default ordering is
   * `create_time ASC`.
   */
  orderBy?: string;
  /**
   * Optional. The maximum number of messages returned. The service might
   * return fewer messages than this value. If unspecified, at most 25 are
   * returned. The maximum value is 1000. If you use a value more than 1000,
   * it's automatically changed to 1000. Negative values return an
   * `INVALID_ARGUMENT` error.
   */
  pageSize?: number;
  /**
   * Optional. A page token received from a previous list messages call.
   * Provide this parameter to retrieve the subsequent page. When paginating,
   * all other parameters provided should match the call that provided the page
   * token. Passing different values to the other parameters might lead to
   * unexpected results.
   */
  pageToken?: string;
  /**
   * Optional. Whether to include deleted messages. Deleted messages include
   * deleted time and metadata about their deletion, but message content is
   * unavailable.
   */
  showDeleted?: boolean;
}

/**
 * Additional options for Chat#spacesMessagesPatch.
 */
export interface SpacesMessagesPatchOptions {
  /**
   * Optional. If `true` and the message isn't found, a new message is created
   * and `updateMask` is ignored. The specified message ID must be
   * [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message)
   * or the request fails.
   */
  allowMissing?: boolean;
  /**
   * Required. The field paths to update. Separate multiple values with commas
   * or use `*` to update all field paths. Currently supported field paths: -
   * `text` - `attachment` - `cards` (Requires [app
   * authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2`
   * (Requires [app authentication](/chat/api/guides/auth/service-accounts).) -
   * `accessory_widgets` (Requires [app
   * authentication](/chat/api/guides/auth/service-accounts).)
   */
  updateMask?: string /* FieldMask */;
}

function serializeSpacesMessagesPatchOptions(data: any): SpacesMessagesPatchOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

function deserializeSpacesMessagesPatchOptions(data: any): SpacesMessagesPatchOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

/**
 * Additional options for Chat#spacesMessagesReactionsList.
 */
export interface SpacesMessagesReactionsListOptions {
  /**
   * Optional. A query filter. You can filter reactions by
   * [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji)
   * (either `emoji.unicode` or `emoji.custom_emoji.uid`) and
   * [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User)
   * (`user.name`). To filter reactions for multiple emojis or users, join
   * similar fields with the `OR` operator, such as `emoji.unicode = "🙂" OR
   * emoji.unicode = "👍"` and `user.name = "users/AAAAAA" OR user.name =
   * "users/BBBBBB"`. To filter reactions by emoji and user, use the `AND`
   * operator, such as `emoji.unicode = "🙂" AND user.name = "users/AAAAAA"`. If
   * your query uses both `AND` and `OR`, group them with parentheses. For
   * example, the following queries are valid: ``` user.name = "users/{user}"
   * emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂"
   * OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid =
   * "{uid}" emoji.unicode = "🙂" AND user.name = "users/{user}" (emoji.unicode
   * = "🙂" OR emoji.custom_emoji.uid = "{uid}") AND user.name = "users/{user}"
   * ``` The following queries are invalid: ``` emoji.unicode = "🙂" AND
   * emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid =
   * "{uid}" emoji.unicode = "🙂" OR user.name = "users/{user}" emoji.unicode =
   * "🙂" OR emoji.custom_emoji.uid = "{uid}" OR user.name = "users/{user}"
   * emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" AND user.name =
   * "users/{user}" ``` Invalid queries are rejected by the server with an
   * `INVALID_ARGUMENT` error.
   */
  filter?: string;
  /**
   * Optional. The maximum number of reactions returned. The service can return
   * fewer reactions than this value. If unspecified, the default value is 25.
   * The maximum value is 200; values above 200 are changed to 200.
   */
  pageSize?: number;
  /**
   * Optional. (If resuming from a previous query.) A page token received from
   * a previous list reactions call. Provide this to retrieve the subsequent
   * page. When paginating, the filter value should match the call that provided
   * the page token. Passing a different value might lead to unexpected results.
   */
  pageToken?: string;
}

/**
 * Additional options for Chat#spacesMessagesUpdate.
 */
export interface SpacesMessagesUpdateOptions {
  /**
   * Optional. If `true` and the message isn't found, a new message is created
   * and `updateMask` is ignored. The specified message ID must be
   * [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message)
   * or the request fails.
   */
  allowMissing?: boolean;
  /**
   * Required. The field paths to update. Separate multiple values with commas
   * or use `*` to update all field paths. Currently supported field paths: -
   * `text` - `attachment` - `cards` (Requires [app
   * authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2`
   * (Requires [app authentication](/chat/api/guides/auth/service-accounts).) -
   * `accessory_widgets` (Requires [app
   * authentication](/chat/api/guides/auth/service-accounts).)
   */
  updateMask?: string /* FieldMask */;
}

function serializeSpacesMessagesUpdateOptions(data: any): SpacesMessagesUpdateOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

function deserializeSpacesMessagesUpdateOptions(data: any): SpacesMessagesUpdateOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

/**
 * Additional options for Chat#spacesPatch.
 */
export interface SpacesPatchOptions {
  /**
   * Required. The updated field paths, comma separated if there are multiple.
   * You can update the following fields for a space: `space_details`: Updates
   * the space's description. Supports up to 150 characters. `display_name`:
   * Only supports updating the display name for spaces where `spaceType` field
   * is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a
   * different value. An existing space within the Google Workspace organization
   * might already use this display name. `space_type`: Only supports changing a
   * `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with
   * `space_type` in the update mask and ensure that the specified space has a
   * non-empty display name and the `SPACE` space type. Including the
   * `space_type` mask and the `SPACE` type in the specified space when updating
   * the display name is optional if the existing space already has the `SPACE`
   * type. Trying to update the space type in other ways results in an invalid
   * argument error. `space_type` is not supported with `useAdminAccess`.
   * `space_history_state`: Updates [space history
   * settings](https://support.google.com/chat/answer/7664687) by turning
   * history on or off for the space. Only supported if history settings are
   * enabled for the Google Workspace organization. To update the space history
   * state, you must omit all other field masks in your request.
   * `space_history_state` is not supported with `useAdminAccess`.
   * `access_settings.audience`: Updates the [access
   * setting](https://support.google.com/chat/answer/11971020) of who can
   * discover the space, join the space, and preview the messages in named space
   * where `spaceType` field is `SPACE`. If the existing space has a target
   * audience, you can remove the audience and restrict space access by omitting
   * a value for this field mask. To update access settings for a space, the
   * authenticating user must be a space manager and omit all other field masks
   * in your request. You can't update this field if the space is in [import
   * mode](https://developers.google.com/workspace/chat/import-data-overview).
   * To learn more, see [Make a space discoverable to specific
   * users](https://developers.google.com/workspace/chat/space-target-audience).
   * `access_settings.audience` is not supported with `useAdminAccess`.
   * `permission_settings`: Supports changing the [permission
   * settings](https://support.google.com/chat/answer/13340792) of a space. When
   * updating permission settings, you can only specify `permissionSettings`
   * field masks; you cannot update other field masks at the same time.
   * `permissionSettings` is not supported with `useAdminAccess`. The supported
   * field masks include: - `permission_settings.manageMembersAndGroups` -
   * `permission_settings.modifySpaceDetails` -
   * `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll`
   * - `permission_settings.manageApps` - `permission_settings.manageWebhooks` -
   * `permission_settings.replyMessages`
   */
  updateMask?: string /* FieldMask */;
  /**
   * Optional. When `true`, the method runs using the user's Google Workspace
   * administrator privileges. The calling user must be a Google Workspace
   * administrator with the [manage chat and spaces conversations
   * privilege](https://support.google.com/a/answer/13369245). Requires the
   * `chat.admin.spaces` [OAuth 2.0
   * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   * Some `FieldMask` values are not supported using admin access. For details,
   * see the description of `update_mask`.
   */
  useAdminAccess?: boolean;
}

function serializeSpacesPatchOptions(data: any): SpacesPatchOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

function deserializeSpacesPatchOptions(data: any): SpacesPatchOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

/**
 * Additional options for Chat#spacesSearch.
 */
export interface SpacesSearchOptions {
  /**
   * Optional. How the list of spaces is ordered. Supported attributes to order
   * by are: - `membership_count.joined_direct_human_user_count` — Denotes the
   * count of human users that have directly joined a space. -
   * `last_active_time` — Denotes the time when last eligible item is added to
   * any topic of this space. - `create_time` — Denotes the time of the space
   * creation. Valid ordering operation values are: - `ASC` for ascending.
   * Default value. - `DESC` for descending. The supported syntax are: -
   * `membership_count.joined_direct_human_user_count DESC` -
   * `membership_count.joined_direct_human_user_count ASC` - `last_active_time
   * DESC` - `last_active_time ASC` - `create_time DESC` - `create_time ASC`
   */
  orderBy?: string;
  /**
   * The maximum number of spaces to return. The service may return fewer than
   * this value. If unspecified, at most 100 spaces are returned. The maximum
   * value is 1000. If you use a value more than 1000, it's automatically
   * changed to 1000.
   */
  pageSize?: number;
  /**
   * A token, received from the previous search spaces call. Provide this
   * parameter to retrieve the subsequent page. When paginating, all other
   * parameters provided should match the call that provided the page token.
   * Passing different values to the other parameters might lead to unexpected
   * results.
   */
  pageToken?: string;
  /**
   * Required. A search query. You can search by using the following
   * parameters: - `create_time` - `customer` - `display_name` -
   * `external_user_allowed` - `last_active_time` - `space_history_state` -
   * `space_type` `create_time` and `last_active_time` accept a timestamp in
   * [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported
   * comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required
   * and is used to indicate which customer to fetch spaces from.
   * `customers/my_customer` is the only supported value. `display_name` only
   * accepts the `HAS` (`:`) operator. The text to match is first tokenized into
   * tokens and each token is prefix-matched case-insensitively and
   * independently as a substring anywhere in the space's `display_name`. For
   * example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not
   * `notFun event` or `even`. `external_user_allowed` accepts either `true` or
   * `false`. `space_history_state` only accepts values from the
   * [`historyState`]
   * (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState)
   * field of a `space` resource. `space_type` is required and the only valid
   * value is `SPACE`. Across different fields, only `AND` operators are
   * supported. A valid example is `space_type = "SPACE" AND
   * display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR
   * display_name:"Hello"`. Among the same field, `space_type` doesn't support
   * `AND` or `OR` operators. `display_name`, 'space_history_state', and
   * 'external_user_allowed' only support `OR` operators. `last_active_time` and
   * `create_time` support both `AND` and `OR` operators. `AND` can only be used
   * to represent an interval, such as `last_active_time <
   * "2022-01-01T00:00:00+00:00" AND last_active_time >
   * "2023-01-01T00:00:00+00:00"`. The following example queries are valid: ```
   * customer = "customers/my_customer" AND space_type = "SPACE" customer =
   * "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello
   * World" customer = "customers/my_customer" AND space_type = "SPACE" AND
   * (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
   * "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND
   * space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun
   * event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND
   * last_active_time < "2022-01-01T00:00:00+00:00") customer =
   * "customers/my_customer" AND space_type = "SPACE" AND (create_time >
   * "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00")
   * AND (external_user_allowed = "true") AND (space_history_state =
   * "HISTORY_ON" OR space_history_state = "HISTORY_OFF") ```
   */
  query?: string;
  /**
   * When `true`, the method runs using the user's Google Workspace
   * administrator privileges. The calling user must be a Google Workspace
   * administrator with the [manage chat and spaces conversations
   * privilege](https://support.google.com/a/answer/13369245). Requires either
   * the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0
   * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
   * This method currently only supports admin access, thus only `true` is
   * accepted for this field.
   */
  useAdminAccess?: boolean;
}

/**
 * Additional options for Chat#spacesSpaceEventsList.
 */
export interface SpacesSpaceEventsListOptions {
  /**
   * Required. A query filter. You must specify at least one event type
   * (`event_type`) using the has `:` operator. To filter by multiple event
   * types, use the `OR` operator. Omit batch event types in your filter. The
   * request automatically returns any related batch events. For example, if you
   * filter by new reactions (`google.workspace.chat.reaction.v1.created`), the
   * server also returns batch new reactions events
   * (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported
   * event types, see the [`SpaceEvents` reference
   * documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type).
   * Optionally, you can also filter by start time (`start_time`) and end time
   * (`end_time`): * `start_time`: Exclusive timestamp from which to start
   * listing space events. You can list events that occurred up to 28 days ago.
   * If unspecified, lists space events from the past 28 days. * `end_time`:
   * Inclusive timestamp until which space events are listed. If unspecified,
   * lists events up to the time of the request. To specify a start or end time,
   * use the equals `=` operator and format in
   * [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both
   * `start_time` and `end_time`, use the `AND` operator. For example, the
   * following queries are valid: ``` start_time="2023-08-23T19:20:33+00:00" AND
   * end_time="2023-08-23T19:21:54+00:00" ``` ```
   * start_time="2023-08-23T19:20:33+00:00" AND
   * (event_types:"google.workspace.chat.space.v1.updated" OR
   * event_types:"google.workspace.chat.message.v1.created") ``` The following
   * queries are invalid: ``` start_time="2023-08-23T19:20:33+00:00" OR
   * end_time="2023-08-23T19:21:54+00:00" ``` ```
   * event_types:"google.workspace.chat.space.v1.updated" AND
   * event_types:"google.workspace.chat.message.v1.created" ``` Invalid queries
   * are rejected by the server with an `INVALID_ARGUMENT` error.
   */
  filter?: string;
  /**
   * Optional. The maximum number of space events returned. The service might
   * return fewer than this value. Negative values return an `INVALID_ARGUMENT`
   * error.
   */
  pageSize?: number;
  /**
   * Optional. A page token, received from a previous list space events call.
   * Provide this to retrieve the subsequent page. When paginating, all other
   * parameters provided to list space events must match the call that provided
   * the page token. Passing different values to the other parameters might lead
   * to unexpected results.
   */
  pageToken?: string;
}

/**
 * Event payload for an updated space. Event type:
 * `google.workspace.chat.space.v1.updated`
 */
export interface SpaceUpdatedEventData {
  /**
   * The updated space.
   */
  space?: Space;
}

function serializeSpaceUpdatedEventData(data: any): SpaceUpdatedEventData {
  return {
    ...data,
    space: data["space"] !== undefined ? serializeSpace(data["space"]) : undefined,
  };
}

function deserializeSpaceUpdatedEventData(data: any): SpaceUpdatedEventData {
  return {
    ...data,
    space: data["space"] !== undefined ? deserializeSpace(data["space"]) : undefined,
  };
}

/**
 * The `Status` type defines a logical error model that is suitable for
 * different programming environments, including REST APIs and RPC APIs. It is
 * used by [gRPC](https://github.com/grpc). Each `Status` message contains three
 * pieces of data: error code, error message, and error details. You can find
 * out more about this error model and how to work with it in the [API Design
 * Guide](https://cloud.google.com/apis/design/errors).
 */
export interface Status {
  /**
   * The status code, which should be an enum value of google.rpc.Code.
   */
  code?: number;
  /**
   * A list of messages that carry the error details. There is a common set of
   * message types for APIs to use.
   */
  details?: {
    [key: string]: any
  }[];
  /**
   * A developer-facing error message, which should be in English. Any
   * user-facing error message should be localized and sent in the
   * google.rpc.Status.details field, or localized by the client.
   */
  message?: string;
}

/**
 * Input parameter for regular widgets. For single-valued widgets, it is a
 * single value list. For multi-valued widgets, such as checkbox, all the values
 * are presented.
 */
export interface StringInputs {
  /**
   * An list of strings entered by the user.
   */
  value?: string[];
}

/**
 * A button with text and `onclick` action.
 */
export interface TextButton {
  /**
   * The `onclick` action of the button.
   */
  onClick?: OnClick;
  /**
   * The text of the button.
   */
  text?: string;
}

/**
 * A paragraph of text. Formatted text supported. For more information about
 * formatting text, see [Formatting text in Google Chat
 * apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
 * and [Formatting text in Google Workspace
 * Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
 */
export interface TextParagraph {
  text?: string;
}

/**
 * A thread in a Google Chat space. For example usage, see [Start or reply to a
 * message
 * thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).
 * If you specify a thread when creating a message, you can set the
 * [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption)
 * field to determine what happens if no matching thread is found.
 */
export interface Thread {
  /**
   * Identifier. Resource name of the thread. Example:
   * `spaces/{space}/threads/{thread}`
   */
  name?: string;
  /**
   * Optional. Input for creating or updating a thread. Otherwise, output only.
   * ID for the thread. Supports up to 4000 characters. This ID is unique to the
   * Chat app that sets it. For example, if multiple Chat apps create a message
   * using the same thread key, the messages are posted in different threads. To
   * reply in a thread created by a person or another Chat app, specify the
   * thread `name` field instead.
   */
  threadKey?: string;
}

/**
 * A user's read state within a thread, used to identify read and unread
 * messages.
 */
export interface ThreadReadState {
  /**
   * The time when the user's thread read state was updated. Usually this
   * corresponds with the timestamp of the last read message in a thread.
   */
  lastReadTime?: Date;
  /**
   * Resource name of the thread read state. Format:
   * `users/{user}/spaces/{space}/threads/{thread}/threadReadState`
   */
  name?: string;
}

function serializeThreadReadState(data: any): ThreadReadState {
  return {
    ...data,
    lastReadTime: data["lastReadTime"] !== undefined ? data["lastReadTime"].toISOString() : undefined,
  };
}

function deserializeThreadReadState(data: any): ThreadReadState {
  return {
    ...data,
    lastReadTime: data["lastReadTime"] !== undefined ? new Date(data["lastReadTime"]) : undefined,
  };
}

/**
 * Time input values.
 */
export interface TimeInput {
  /**
   * The hour on a 24-hour clock.
   */
  hours?: number;
  /**
   * The number of minutes past the hour. Valid values are 0 to 59.
   */
  minutes?: number;
}

/**
 * The timezone ID and offset from Coordinated Universal Time (UTC). Only
 * supported for the event types
 * [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED)
 * and
 * [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).
 */
export interface TimeZone {
  /**
   * The [IANA TZ](https://www.iana.org/time-zones) time zone database code,
   * such as "America/Toronto".
   */
  id?: string;
  /**
   * The user timezone offset, in milliseconds, from Coordinated Universal Time
   * (UTC).
   */
  offset?: number;
}

/**
 * For `selectionInput` widgets, returns autocomplete suggestions for a
 * multiselect menu.
 */
export interface UpdatedWidget {
  /**
   * List of widget autocomplete results
   */
  suggestions?: SelectionItems;
  /**
   * The ID of the updated widget. The ID must match the one for the widget
   * that triggered the update request.
   */
  widget?: string;
}

/**
 * Request to upload an attachment.
 */
export interface UploadAttachmentRequest {
  /**
   * Required. The filename of the attachment, including the file extension.
   */
  filename?: string;
}

/**
 * Response of uploading an attachment.
 */
export interface UploadAttachmentResponse {
  /**
   * Reference to the uploaded attachment.
   */
  attachmentDataRef?: AttachmentDataRef;
}

/**
 * A user in Google Chat. When returned as an output from a request, if your
 * Chat app [authenticates as a
 * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
 * the output for a `User` resource only populates the user's `name` and `type`.
 */
export interface User {
  /**
   * Output only. The user's display name.
   */
  readonly displayName?: string;
  /**
   * Unique identifier of the user's Google Workspace domain.
   */
  domainId?: string;
  /**
   * Output only. When `true`, the user is deleted or their profile is not
   * visible.
   */
  readonly isAnonymous?: boolean;
  /**
   * Resource name for a Google Chat user. Format: `users/{user}`. `users/app`
   * can be used as an alias for the calling app bot user. For human users,
   * `{user}` is the same user identifier as: - the `id` for the
   * [Person](https://developers.google.com/people/api/rest/v1/people) in the
   * People API. For example, `users/123456789` in Chat API represents the same
   * person as the `123456789` Person profile ID in People API. - the `id` for a
   * [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users)
   * in the Admin SDK Directory API. - the user's email address can be used as
   * an alias for `{user}` in API requests. For example, if the People API
   * Person profile ID for `user@example.com` is `123456789`, you can use
   * `users/user@example.com` as an alias to reference `users/123456789`. Only
   * the canonical resource name (for example `users/123456789`) will be
   * returned from the API.
   */
  name?: string;
  /**
   * User type.
   */
  type?:  | "TYPE_UNSPECIFIED" | "HUMAN" | "BOT";
}

/**
 * Annotation metadata for user mentions (@).
 */
export interface UserMentionMetadata {
  /**
   * The type of user mention.
   */
  type?:  | "TYPE_UNSPECIFIED" | "ADD" | "MENTION";
  /**
   * The user mentioned.
   */
  user?: User;
}

/**
 * Additional options for Chat#usersSpacesUpdateSpaceReadState.
 */
export interface UsersSpacesUpdateSpaceReadStateOptions {
  /**
   * Required. The field paths to update. Currently supported field paths: -
   * `last_read_time` When the `last_read_time` is before the latest message
   * create time, the space appears as unread in the UI. To mark the space as
   * read, set `last_read_time` to any value later (larger) than the latest
   * message create time. The `last_read_time` is coerced to match the latest
   * message create time. Note that the space read state only affects the read
   * state of messages that are visible in the space's top-level conversation.
   * Replies in threads are unaffected by this timestamp, and instead rely on
   * the thread read state.
   */
  updateMask?: string /* FieldMask */;
}

function serializeUsersSpacesUpdateSpaceReadStateOptions(data: any): UsersSpacesUpdateSpaceReadStateOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

function deserializeUsersSpacesUpdateSpaceReadStateOptions(data: any): UsersSpacesUpdateSpaceReadStateOptions {
  return {
    ...data,
    updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined,
  };
}

/**
 * A widget is a UI element that presents text and images.
 */
export interface WidgetMarkup {
  /**
   * A list of buttons. Buttons is also `oneof data` and only one of these
   * fields should be set.
   */
  buttons?: Button[];
  /**
   * Display an image in this widget.
   */
  image?: Image;
  /**
   * Display a key value item in this widget.
   */
  keyValue?: KeyValue;
  /**
   * Display a text paragraph in this widget.
   */
  textParagraph?: TextParagraph;
}