// Copyright 2022 Luca Casonato. All rights reserved. MIT license.
/**
 * Google Chat API Client for Deno
 * ===============================
 * 
 * Enables apps to fetch information and perform actions in Google Chat. Authentication is a prerequisite for using the Google Chat REST API.
 * 
 * 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 };

/**
 * Enables apps to fetch information and perform actions in Google Chat.
 * Authentication is a prerequisite for using the Google Chat REST API.
 */
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;
  }

  /**
   * Returns a space. Requires
   * [authentication](https://developers.google.com/chat/api/guides/auth). Fully
   * supports [service account
   * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
   * Supports [user
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * as part of the [Google Workspace Developer Preview
   * Program](https://developers.google.com/workspace/preview), which grants
   * early access to certain features. [User
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * requires the `chat.spaces` or `chat.spaces.readonly` authorization scope.
   *
   * @param name Required. Resource name of the space, in the form "spaces/*". Format: spaces/{space}
   */
  async spacesGet(name: string): Promise<Space> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as Space;
  }

  /**
   * Lists spaces the caller is a member of. Requires
   * [authentication](https://developers.google.com/chat/api/guides/auth). Fully
   * supports [service account
   * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
   * Supports [user
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * as part of the [Google Workspace Developer Preview
   * Program](https://developers.google.com/workspace/preview), which grants
   * early access to certain features. [User
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * requires the `chat.spaces` or `chat.spaces.readonly` authorization scope.
   * Lists spaces visible to the caller or authenticated user. Group chats and
   * DMs aren't listed until the first message is sent.
   *
   */
  async spacesList(opts: SpacesListOptions = {}): Promise<ListSpacesResponse> {
    const url = new URL(`${this.#baseUrl}v1/spaces`);
    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 ListSpacesResponse;
  }

  /**
   * Returns a membership. Requires
   * [authentication](https://developers.google.com/chat/api/guides/auth/).
   * Fully supports [service account
   * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
   * Supports [user
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * as part of the [Google Workspace Developer Preview
   * Program](https://developers.google.com/workspace/preview), which grants
   * early access to certain features. [User
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * requires the `chat.memberships` or `chat.memberships.readonly`
   * authorization scope.
   *
   * @param name Required. Resource name of the membership to retrieve. Format: spaces/{space}/members/{member}
   */
  async spacesMembersGet(name: string): Promise<Membership> {
    const url = new URL(`${this.#baseUrl}v1/${ name }`);
    const data = await request(url.href, {
      client: this.#client,
      method: "GET",
    });
    return data as Membership;
  }

  /**
   * Lists memberships in a space. Requires
   * [authentication](https://developers.google.com/chat/api/guides/auth/).
   * Fully supports [service account
   * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
   * Supports [user
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * as part of the [Google Workspace Developer Preview
   * Program](https://developers.google.com/workspace/preview), which grants
   * early access to certain features. [User
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * requires the `chat.memberships` or `chat.memberships.readonly`
   * authorization scope.
   *
   * @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.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 ListMembershipsResponse;
  }

  /**
   * Gets the metadata of a message attachment. The attachment data is fetched
   * using the [media
   * API](https://developers.google.com/chat/api/reference/rest/v1/media/download).
   * Requires [service account
   * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
   *
   * @param name Required. Resource name of the attachment, in the form "spaces/*/messages/*/attachments/*".
   */
  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. For example usage, see [Create a
   * message](https://developers.google.com/chat/api/guides/crudl/messages#create_a_message).
   * Requires
   * [authentication](https://developers.google.com/chat/api/guides/auth). Fully
   * supports [service account
   * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
   * Supports [user
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * as part of the [Google Workspace Developer Preview
   * Program](https://developers.google.com/workspace/preview), which grants
   * early access to certain features. [User
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * requires the `chat.messages` or `chat.messages.create` authorization scope.
   * Because Chat provides authentication for
   * [webhooks](https://developers.google.com/chat/how-tos/webhooks) as part of
   * the URL that's generated when a webhook is registered, webhooks can create
   * messages without a service account or user authentication.
   *
   * @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 example usage, see [Delete a
   * message](https://developers.google.com/chat/api/guides/crudl/messages#delete_a_message).
   * Requires
   * [authentication](https://developers.google.com/chat/api/guides/auth). Fully
   * supports [service account
   * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
   * Supports [user
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * as part of the [Google Workspace Developer Preview
   * Program](https://developers.google.com/workspace/preview), which grants
   * early access to certain features. [User
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * requires the `chat.messages` authorization scope.
   *
   * @param name Required. Resource name of the message to be deleted, in the form "spaces/*/messages/*" Example: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB
   */
  async spacesMessagesDelete(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;
  }

  /**
   * Returns a message. For example usage, see [Read a
   * message](https://developers.google.com/chat/api/guides/crudl/messages#read_a_message).
   * Requires
   * [authentication](https://developers.google.com/chat/api/guides/auth). Fully
   * supports [Service account
   * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
   * Supports [user
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * as part of the [Google Workspace Developer Preview
   * Program](https://developers.google.com/workspace/preview), which grants
   * early access to certain features. [User
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * requires the `chat.messages` or `chat.messages.readonly` authorization
   * scope. Note: Might return a message from a blocked member or space.
   *
   * @param name Required. Resource name of the message to retrieve. Format: spaces/{space}/messages/{message} If the message begins with `client-`, then it has a custom name assigned by a Chat app that created it with the Chat REST API. That Chat app (but not others) can pass the custom name to get, update, or delete the message. To learn more, see [create and name a message] (https://developers.google.com/chat/api/guides/crudl/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);
  }

  /**
   * Updates a message. For example usage, see [Update a
   * message](https://developers.google.com/chat/api/guides/crudl/messages#update_a_message).
   * Requires
   * [authentication](https://developers.google.com/chat/api/guides/auth/).
   * Fully supports [service account
   * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
   * Supports [user
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * as part of the [Google Workspace Developer Preview
   * Program](https://developers.google.com/workspace/preview), which grants
   * early access to certain features. [User
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * requires the `chat.messages` authorization scope.
   *
   * @param name Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`
   */
  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);
  }

  /**
   * Updates a message. For example usage, see [Update a
   * message](https://developers.google.com/chat/api/guides/crudl/messages#update_a_message).
   * Requires
   * [authentication](https://developers.google.com/chat/api/guides/auth/).
   * Fully supports [service account
   * authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
   * Supports [user
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * as part of the [Google Workspace Developer Preview
   * Program](https://developers.google.com/workspace/preview), which grants
   * early access to certain features. [User
   * authentication](https://developers.google.com/chat/api/guides/auth/users)
   * requires the `chat.messages` authorization scope.
   *
   * @param name Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`
   */
  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);
  }
}

/**
 * List of string parameters to supply when the action method is invoked. For
 * example, consider three snooze buttons: snooze now, snooze 1 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 event related to a
   * [dialog](https://developers.google.com/chat/how-tos/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";
  /**
   * Input only. URL for users to auth or config. (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/chat/how-tos/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;
}

/**
 * Annotations associated with the plain-text body of the message. 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 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";
  /**
   * 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,
  };
}

/**
 * An attachment in Google Chat.
 */
export interface Attachment {
  /**
   * A reference to the attachment data. This is used with the media API to
   * download the attachment data.
   */
  attachmentDataRef?: AttachmentDataRef;
  /**
   * The original file name for the content, not the full path.
   */
  contentName?: string;
  /**
   * The content type (MIME type) of the file.
   */
  contentType?: string;
  /**
   * Output only. The download URL which should be used to allow a human user
   * to download the attachment. Chat apps should not use this URL to download
   * attachment content.
   */
  readonly downloadUri?: string;
  /**
   * A reference to the drive attachment. This is used with the Drive API.
   */
  driveDataRef?: DriveDataRef;
  /**
   * Resource name of the attachment, in the form
   * "spaces/*\/messages/*\/attachments/*".
   */
  name?: string;
  /**
   * The source of the attachment.
   */
  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 should not use this URL to download
   * attachment content.
   */
  readonly thumbnailUri?: string;
}

export interface AttachmentDataRef {
  /**
   * The resource name of the attachment data. This 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 texts, 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 (e.g. 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 will take up 1 line. If only the
   * title is specified, it will take up both lines.
   */
  title?: string;
}

/**
 * Widgets for Chat apps to specify.
 */
export interface CardWithId {
  /**
   * Cards support a defined layout, interactive UI elements like buttons, and
   * rich media like images. Use this card to present detailed information,
   * gather information from users, and guide users to take a next step.
   */
  card?: GoogleAppsCardV1Card;
  /**
   * Required for `cardsV2` messages. Chat app-specified identifier for this
   * widget. Scoped within 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;
}

/**
 * Represents a color in the RGBA color space. This representation is designed
 * for simplicity of conversion to/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 carry
 * information about the absolute color space that should be used to interpret
 * the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). 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 current values of the widgets in a card. The map keys
   * are the string IDs assigned to each widget, and the values represent inputs
   * to the widget. Depending on the input data type, a different object
   * represents each input: For single-value widgets, `StringInput`. For
   * multi-value widgets, an array of `StringInput` objects. For a date-time
   * picker, a `DateTimeInput`. For a date-only picker, a `DateInput`. For a
   * time-only picker, a `TimeInput`. Corresponds with the data entered by a
   * user on a card in a
   * [dialog](https://developers.google.com/chat/how-tos/dialogs).
   */
  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).
   */
  timeZone?: TimeZone;
  /**
   * The full `locale.displayName` in the format of [ISO 639 language
   * code]-[ISO 3166 country/region code] such as "en-US". Not supported by Chat
   * apps.
   */
  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,
  };
}

/**
 * Date input values. Not supported by Chat apps.
 */
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. Not supported by Chat apps.
 */
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,
  };
}

/**
 * Google Chat events.
 */
export interface DeprecatedEvent {
  /**
   * The form action data associated with an interactive card that was clicked.
   * Only populated for CARD_CLICKED events. See the [Interactive Cards
   * guide](/chat/how-tos/cards-onclick) for more information.
   */
  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/chat/how-tos/dialogs), like data
   * entered on a card.
   */
  common?: CommonEventObject;
  /**
   * The URL the Chat app should redirect the user to after they have completed
   * an authorization or configuration flow outside of Google Chat. See the
   * [Authorizing access to 3p services guide](/chat/how-tos/auth-3p) for more
   * information.
   */
  configCompleteRedirectUrl?: string;
  /**
   * The type of [dialog](https://developers.google.com/chat/how-tos/dialogs)
   * event received.
   */
  dialogEventType?:  | "TYPE_UNSPECIFIED" | "REQUEST_DIALOG" | "SUBMIT_DIALOG" | "CANCEL_DIALOG";
  /**
   * The timestamp indicating when the event occurred.
   */
  eventTime?: Date;
  /**
   * True when the event is related to
   * [dialogs](https://developers.google.com/chat/how-tos/dialogs).
   */
  isDialogEvent?: boolean;
  /**
   * The message that triggered the event, if applicable.
   */
  message?: Message;
  /**
   * The space in which the event occurred.
   */
  space?: Space;
  /**
   * The Chat app-defined key for the thread related to the 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 of the event.
   */
  type?:  | "UNSPECIFIED" | "MESSAGE" | "ADDED_TO_SPACE" | "REMOVED_FROM_SPACE" | "CARD_CLICKED";
  /**
   * The user that triggered the event.
   */
  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,
  };
}

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

/**
 * 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 do not 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/chat/how-tos/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/chat/how-tos/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/chat/how-tos/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, for use with the Drive API.
   */
  driveFileId?: string;
}

/**
 * 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, an Apps Script can be invoked 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. The same method name can be used for several elements
   * that trigger a common behavior if desired.
   */
  actionMethodName?: string;
  /**
   * List of action parameters.
   */
  parameters?: ActionParameter[];
}

/**
 * An action that describes the behavior when the form is submitted. For
 * example, an Apps Script can be invoked to handle the form.
 */
export interface GoogleAppsCardV1Action {
  /**
   * A custom function to invoke when the containing element is clicked or
   * othrwise activated. For example usage, see [Create interactive
   * cards](https://developers.google.com/chat/how-tos/cards-onclick).
   */
  function?: string;
  /**
   * Optional. Required when opening a
   * [dialog](https://developers.google.com/chat/how-tos/dialogs). What to do in
   * response to an interaction with a user, such as a user clicking button on 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/chat/how-tos/dialogs). When
   * specified, a loading indicator is not shown. Supported by Chat apps, but
   * not Google Workspace Add-ons. If specified for an add-on, the entire card
   * is stripped and nothing is shown in the client.
   */
  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.
   * When using
   * [LoadIndicator.NONE](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
   * for actions, `persist_values` = `true`is recommended, as it ensures that
   * any changes made by the user after form or on change actions are sent to
   * the server are not overwritten by the response. If `false`, the form values
   * are cleared when the action is triggered. When `persist_values` is set to
   * `false`, it is strongly recommended that the card use
   * [LoadIndicator.SPINNER](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
   * for all actions, as this locks the UI to ensure no changes are made by the
   * user while the action is being processed. Not supported by Chat apps.
   */
  persistValues?: boolean;
}

/**
 * List of string parameters to supply when the action method is invoked. For
 * example, consider three snooze buttons: snooze now, snooze 1 day, 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/chat/api/reference/rest/v1/Event#commoneventobject).
 */
export interface GoogleAppsCardV1ActionParameter {
  /**
   * The name of the parameter for the action script.
   */
  key?: string;
  /**
   * The value of the parameter.
   */
  value?: string;
}

/**
 * Represents the complete border style applied to items in a widget.
 */
export interface GoogleAppsCardV1BorderStyle {
  /**
   * The corner radius for the border.
   */
  cornerRadius?: number;
  /**
   * The colors to use when the type is `BORDER_TYPE_STROKE`.
   */
  strokeColor?: Color;
  /**
   * The border type.
   */
  type?:  | "BORDER_TYPE_UNSPECIFIED" | "NO_BORDER" | "STROKE";
}

/**
 * A text, icon, or text + icon button that users can click. To make an image a
 * clickable button, specify an Image (not an ImageComponent) and set an
 * `onClick` action. Currently supported in Chat apps (including [dialogs]
 * (https://developers.google.com/chat/how-tos/dialogs) and [card messages]
 * (https://developers.google.com/chat/api/guides/message-formats/cards)) and
 * Google Workspace Add-ons.
 */
export interface GoogleAppsCardV1Button {
  /**
   * The alternative text 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/chat".
   */
  altText?: string;
  /**
   * If set, the button is filled with a solid background color and the font
   * color changes to maintain contrast with the background color. For example,
   * setting a blue background will likely result in white text. If unset, the
   * image background is white and the font color is blue. For red, green and
   * blue, the value of each field is a `float` number that can be expressed in
   * either of two ways: as a number between 0 and 255 divided by 255 (153/255)
   * or as a value between 0 and 1 (0.6). 0 represents the absence of a color
   * and 1 or 255/255 represent the full presence of that color on the RGB
   * scale. Optionally set alpha, which sets a level of transparency using this
   * equation: ``` pixel color = alpha * (this color) + (1.0 - alpha) *
   * (background color) ``` For alpha, a value of 1 corresponds with a solid
   * color, and a value of 0 corresponds with a completely transparent color.
   * For example, the following color represents a half transparent red: ```
   * "color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 } ```
   */
  color?: Color;
  /**
   * If `true`, the button is displayed in an inactive state and doesn't
   * respond to user actions.
   */
  disabled?: boolean;
  /**
   * The icon image. If both `icon` and `text` are set, then the icon appears
   * before the text.
   */
  icon?: GoogleAppsCardV1Icon;
  /**
   * Required. The action to perform when the button is clicked, such as
   * opening a hyperlink or running a custom function.
   */
  onClick?: GoogleAppsCardV1OnClick;
  /**
   * The text displayed inside the button.
   */
  text?: string;
}

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.
 */
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,
  };
}

/**
 * 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. In Google Chat,
 * cards appear in several places: - As stand-alone messages. - Accompanying a
 * text message, just beneath the text message. - As a
 * [dialog](https://developers.google.com/chat/how-tos/dialogs). The following
 * example JSON creates a "contact card" that features: - A header with the
 * contact's name, job title, avatar picture. - A section with the contact
 * information, including formatted text. - Buttons that users can click to
 * share the contact or see more or less info. ![Example contact
 * card](https://developers.google.com/chat/images/card_api_reference.png) ``` {
 * "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title":
 * "Sasha", "subtitle": "Software Engineer", "imageUrl":
 * "https://developers.google.com/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. Because
   * Chat app cards have no toolbar, `cardActions[]` is not supported by Chat
   * apps. 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`. Not supported by Chat apps.
   */
  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. Chat apps support `fixedFooter` in
   * [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not in
   * [card
   * messages](https://developers.google.com/chat/api/guides/message-formats/cards).
   */
  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. Because
   * Chat apps don't support card navigation, they ignore this field.
   */
  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. Not supported by Chat apps.
   */
  peekCardHeader?: GoogleAppsCardV1CardHeader;
  /**
   * Contains a collection of widgets. Each section has its own, optional
   * header. Sections are visually separated by a line divider.
   */
  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. Not supported by Chat apps.
 */
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. Chat apps support `fixedFooter` in
 * [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not in
 * [card
 * messages](https://developers.google.com/chat/api/guides/message-formats/cards).
 */
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. `primaryButton` must be set if `secondaryButton`
   * is set.
   */
  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.
 */
export interface GoogleAppsCardV1CardHeader {
  /**
   * The alternative text of this image which is used for accessibility.
   */
  imageAltText?: string;
  /**
   * The shape used to crop the image.
   */
  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;
}

/**
 * Lets users specify a date, a time, or both a date and a time. Accepts text
 * input from users, but features an interactive date and time selector that
 * helps users enter correctly-formatted dates and times. If users enter a date
 * or time incorrectly, the widget shows an error that prompts users to enter
 * the correct format. Not supported by Chat apps. Support by Chat apps coming
 * soon.
 */
export interface GoogleAppsCardV1DateTimePicker {
  /**
   * The text that prompts users to enter a date, time, or datetime. Specify
   * text that helps the user enter the information your app needs. For example,
   * if users are setting an appointment, then a label like "Appointment date"
   * or "Appointment date and time" might work well.
   */
  label?: string;
  /**
   * The name by which the datetime picker is identified in a form input event.
   * For details about working with form inputs, see [Receive form
   * data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
   */
  name?: string;
  /**
   * Triggered when the user clicks **Save** or **Clear** from the datetime
   * picker 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 not set,
   * it uses the user's time zone setting on the client side.
   */
  timezoneOffsetDate?: number;
  /**
   * What kind of date and time input the datetime picker supports.
   */
  type?:  | "DATE_AND_TIME" | "DATE_ONLY" | "TIME_ONLY";
  /**
   * The value displayed as the default value before user input or previous
   * user input, represented in milliseconds ([Epoch
   * time](https://en.wikipedia.org/wiki/Unix_time)). For `DATE_AND_TIME` type,
   * the full epoch value is used. For `DATE_ONLY` type, only date of the epoch
   * time is used. For `TIME_ONLY` type, only time of the epoch time is used.
   * For example, to represent 3:00 AM, set epoch time to `3 * 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.
 */
export interface GoogleAppsCardV1DecoratedText {
  /**
   * The text that appears below `text`. Always truncates. Supports simple
   * formatting. See Text formatting for formatting details.
   */
  bottomLabel?: string;
  /**
   * A button that can be clicked to trigger an action.
   */
  button?: GoogleAppsCardV1Button;
  /**
   * An icon displayed after the text. Supports
   * [standard](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons)
   * and
   * [custom](https://developers.google.com/chat/api/guides/message-formats/cards#customicons)
   * icons.
   */
  endIcon?: GoogleAppsCardV1Icon;
  /**
   * Deprecated in favor of `startIcon`.
   */
  icon?: GoogleAppsCardV1Icon;
  /**
   * When users click on `topLabel` or `bottomLabel`, this action triggers.
   */
  onClick?: GoogleAppsCardV1OnClick;
  /**
   * The icon displayed in front of the text.
   */
  startIcon?: GoogleAppsCardV1Icon;
  /**
   * A switch widget can be clicked to change its state and trigger an action.
   * Currently supported in
   * [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for
   * [card
   * messages](https://developers.google.com/chat/api/guides/message-formats/cards)
   * is coming soon.
   */
  switchControl?: GoogleAppsCardV1SwitchControl;
  /**
   * Required. The primary text. Supports simple formatting. See Text
   * formatting for formatting details.
   */
  text?: string;
  /**
   * The text that appears above `text`. Always truncates. Supports simple
   * formatting. See Text formatting for formatting details.
   */
  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, a horizontal line. For example, the
 * following JSON creates a divider: ``` "divider": { } ```
 */
export interface 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 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. Currently supported in
 * [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for
 * [card
 * messages](https://developers.google.com/chat/api/guides/message-formats/cards)
 * is coming soon. For example, the following JSON creates a 2 column grid with
 * a single item: ``` "grid": { "title": "A fine collection of items",
 * "numColumns": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4.0 },
 * "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 a single item in the grid layout.
 */
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. Supports
 * [standard](https://developers.google.com/chat/api/guides/message-formats/cards)
 * and
 * [custom](https://developers.google.com/chat/api/guides/message-formats/cards#customicons)
 * icons.
 */
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/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/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 standard icon.
   */
  imageType?:  | "SQUARE" | "CIRCLE";
  /**
   * Display one of the standard 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 [standard
   * icons](https://developers.google.com/chat/api/guides/message-formats/cards).
   */
  knownIcon?: string;
}

/**
 * An image that is specified by a URL and can have an `onClick` action.
 */
export interface GoogleAppsCardV1Image {
  /**
   * The alternative text of this image, used for accessibility.
   */
  altText?: string;
  /**
   * The `https` URL that hosts the image. For example: ```
   * https://developers.google.com/chat/images/quickstart-app-avatar.png ```
   */
  imageUrl?: string;
  /**
   * When a user clicks on 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.
 */
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. For example, here's how to
 * apply a 16 by 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 by 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";
}

/**
 * Represents how to respond when users click an interactive element on a card,
 * such as a button.
 */
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.
   * Supported by Google Workspace Add-ons, but not Chat apps.
   */
  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.
   */
  openDynamicLinkAction?: GoogleAppsCardV1Action;
  /**
   * If specified, this `onClick` triggers an open link action.
   */
  openLink?: GoogleAppsCardV1OpenLink;
}

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

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

/**
 * Represents an `onClick` event that opens a hyperlink.
 */
export interface GoogleAppsCardV1OpenLink {
  /**
   * Whether the client forgets about a link after opening it, or observes it
   * until the window closes. Not supported by Chat apps.
   */
  onClose?:  | "NOTHING" | "RELOAD";
  /**
   * How to open a link. Not supported by Chat apps.
   */
  openAs?:  | "FULL_SIZE" | "OVERLAY";
  /**
   * The URL to open.
   */
  url?: string;
}

/**
 * A section contains a collection of widgets that are rendered vertically in
 * the order that they are specified.
 */
export interface GoogleAppsCardV1Section {
  /**
   * 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](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 1 widget.
   */
  widgets?: GoogleAppsCardV1Widget[];
}

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

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

/**
 * A widget that creates a UI item with options for users to select. For
 * example, a dropdown menu or check list. 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/chat/how-tos/dialogs#receive_form_data_from_dialogs).
 * When you need to collect data from users that matches options you set, use a
 * selection input. To collect abstract data from users, use the text input
 * widget instead. Only supported in
 * [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for
 * [card
 * messages](https://developers.google.com/chat/api/guides/message-formats/cards)
 * coming soon.
 */
export interface GoogleAppsCardV1SelectionInput {
  /**
   * An array of the selected items. For example, all the selected check boxes.
   */
  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;
  /**
   * The name by which the selection input is identified in a form input event.
   * For details about working with form inputs, see [Receive form
   * data](https://developers.google.com/chat/how-tos/dialogs#receive_form_data_from_dialogs).
   */
  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/chat/how-tos/dialogs#receive_form_data_from_dialogs).
   */
  onChangeAction?: GoogleAppsCardV1Action;
  /**
   * The way that an option appears to users. Different options support
   * different types of interactions. For example, users can enable multiple
   * check boxes, but can only select one value from a dropdown menu. Each
   * selection input supports one type of selection. Mixing check boxes and
   * switches, for example, is not supported.
   */
  type?:  | "CHECK_BOX" | "RADIO_BUTTON" | "SWITCH" | "DROPDOWN";
}

/**
 * A selectable item in a selection input, such as a check box or a switch.
 */
export interface GoogleAppsCardV1SelectionItem {
  /**
   * When `true`, more than one item is selected. If more than one item is
   * selected for radio buttons and dropdown menus, the first selected item is
   * received and the ones after are ignored.
   */
  selected?: boolean;
  /**
   * The text displayed 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/chat/how-tos/dialogs#receive_form_data_from_dialogs).
   */
  value?: string;
}

/**
 * One suggested value that users can enter in a text input field.
 */
export interface GoogleAppsCardV1SuggestionItem {
  /**
   * The value of a suggested input to a text input field. This is equivalent
   * to what users would 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 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 is set to
 * `MULTIPLE_LINE`.
 */
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.
 * Only supported on the `decoratedText` widget. Currently supported in
 * [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for
 * [card
 * messages](https://developers.google.com/chat/api/guides/message-formats/cards)
 * is coming soon.
 */
export interface GoogleAppsCardV1SwitchControl {
  /**
   * How the switch appears in the user interface.
   */
  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/chat/how-tos/dialogs#receive_form_data_from_dialogs).
   */
  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/chat/how-tos/dialogs#receive_form_data_from_dialogs).
   */
  value?: string;
}

/**
 * A field in which users can enter text. Supports suggestions and on-change
 * actions. 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/chat/how-tos/dialogs#receive_form_data_from_dialogs).
 * When you need to collect abstract data from users, use a text input. To
 * collect defined data from users, use the selection input widget instead. Only
 * supported in [dialogs](https://developers.google.com/chat/how-tos/dialogs).
 * Support for [card
 * messages](https://developers.google.com/chat/api/guides/message-formats/cards)
 * coming soon.
 */
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. Supported by Google Workspace Add-ons, but not Chat apps.
   * Support by Chat apps coming soon.
   */
  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 is set
   * to `MULTIPLE_LINE`.
   */
  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/chat/how-tos/dialogs#receive_form_data_from_dialogs).
   */
  name?: string;
  /**
   * What to do when a change occurs in the text input field. Examples of
   * changes include 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/chat/how-tos/dialogs) in Google
   * Chat.
   */
  onChangeAction?: GoogleAppsCardV1Action;
  /**
   * 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/chat/how-tos/dialogs#receive_form_data_from_dialogs).
   */
  value?: string;
}

/**
 * A paragraph of text that supports formatting. See [Text
 * formatting](https://developers.google.com/workspace/add-ons/concepts/widgets#text_formatting)
 * for details.
 */
export interface GoogleAppsCardV1TextParagraph {
  /**
   * 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": [ "button": { "text": "Edit",
   * "color": { "red": 0, "green": 0, "blue": 1, "alpha": 1 } "disabled": true
   * }, "button": { "icon": { "knownIcon": "INVITE" "altText": "check calendar"
   * }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } },
   * ] } ```
   */
  buttonList?: GoogleAppsCardV1ButtonList;
  /**
   * Displays a selection/input widget for date, time, or date and time. Not
   * supported by Chat apps. Support by Chat apps is coming soon. For example,
   * the following JSON creates a datetime picker to schedule an appointment:
   * ``` "date_time_picker": { "name": "appointment_time", "label": "Book your
   * appointment at:", "type": "DateTimePickerType.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!",
   * "switchWidget": { "name": "has_send_welcome_email_to_sasha", "selected":
   * false, "controlType": "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.
   * Currently supported in
   * [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for
   * [card
   * messages](https://developers.google.com/chat/api/guides/message-formats/cards)
   * is coming soon. For example, the following JSON creates a 2 column grid
   * with a single item: ``` "grid": { "title": "A fine collection of items",
   * "numColumns": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4.0 },
   * "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;
  /**
   * Displays an image. For example, the following JSON creates an image with
   * alternative text: ``` "image": { "imageUrl":
   * "https://developers.google.com/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 check boxes, radio buttons, switches, or dropdown menus.
   * Currently supported in
   * [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for
   * [card
   * messages](https://developers.google.com/chat/api/guides/message-formats/cards)
   * is coming soon. For example, the following JSON creates a dropdown menu
   * that lets users choose a size: ``` "selectionInput": { "name": "size",
   * "label": "Size" "type": "SelectionType.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. Currently supported in
   * [dialogs](https://developers.google.com/chat/how-tos/dialogs). Support for
   * [card
   * messages](https://developers.google.com/chat/api/guides/message-formats/cards)
   * is coming soon. 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](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,
    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,
    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,
  };
}

/**
 * An image that is specified by a URL and can have an onclick action.
 */
export interface Image {
  /**
   * The aspect ratio of this image (width/height). This field allows clients
   * to reserve the right height for the image while waiting for it to load.
   * It's not meant to override the native 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 which will be used for accessibility.
   * Default value will be provided if developers don't specify.
   */
  name?: string;
  /**
   * The onclick action.
   */
  onClick?: OnClick;
}

/**
 * Types of data inputs for widgets. Users enter data with these inputs.
 */
export interface Inputs {
  /**
   * Date input values. Not supported by Chat apps.
   */
  dateInput?: DateInput;
  /**
   * Date and time input values. Not supported by Chat apps.
   */
  dateTimeInput?: DateTimeInput;
  /**
   * 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.
   */
  stringInputs?: StringInputs;
  /**
   * Time input values. Not supported by Chat apps.
   */
  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). And this element
 * may also contain some actions such as onclick button.
 */
export interface KeyValue {
  /**
   * The text of the bottom label. Formatted text supported.
   */
  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.
   */
  content?: string;
  /**
   * If the content should be multiline.
   */
  contentMultiline?: boolean;
  /**
   * An enum value that will be 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.
   */
  topLabel?: string;
}

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

export interface ListSpacesResponse {
  /**
   * A token that can be sent 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.
   */
  spaces?: Space[];
}

/**
 * A matched url in a Chat message. Chat apps can preview matched URLs. For
 * more information, refer to [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 {
  /**
   * Output only. The creation time of the membership, such as when a member
   * joined or was invited to join a space.
   */
  readonly createTime?: Date;
  /**
   * A Google Chat user or app. Format: `users/{user}` or `users/app` When
   * `users/{user}`, represents a
   * [person](https://developers.google.com/people/api/rest/v1/people) in the
   * People API or a
   * [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users)
   * in the Admin SDK Directory API. When `users/app`, represents a Chat app
   * creating membership for itself.
   */
  member?: User;
  /**
   * Resource name of the membership. Format: spaces/{space}/members/{member}
   */
  name?: string;
  /**
   * Output only. User's role within a Chat space, which determines their
   * permitted actions in the space.
   */
  readonly role?:  | "MEMBERSHIP_ROLE_UNSPECIFIED" | "ROLE_MEMBER" | "ROLE_MANAGER";
  /**
   * Output only. State of the membership.
   */
  readonly state?:  | "MEMBERSHIP_STATE_UNSPECIFIED" | "JOINED" | "INVITED" | "NOT_A_MEMBER";
}

/**
 * A message in Google Chat.
 */
export interface Message {
  /**
   * 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[];
  /**
   * Plain-text body of the message with all Chat app mentions stripped out.
   */
  argumentText?: string;
  /**
   * User-uploaded attachment.
   */
  attachment?: Attachment[];
  /**
   * Deprecated: Use `cards_v2` instead. Rich, formatted and interactive cards
   * that can be used to display UI elements such as: formatted texts, buttons,
   * clickable images. Cards are normally displayed below the plain-text body of
   * the message.
   */
  cards?: Card[];
  /**
   * Richly formatted and interactive cards that display UI elements and
   * editable widgets, such as: - Formatted text - Buttons - Clickable images -
   * Checkboxes - Radio buttons - Input widgets. Cards are usually displayed
   * below the text body of a Chat message, but can situationally appear other
   * places, such as
   * [dialogs](https://developers.google.com/chat/how-tos/dialogs). The `cardId`
   * is a unique identifier among cards in the same message and for identifying
   * user input values. Currently supported widgets include: - `TextParagraph` -
   * `DecoratedText` - `Image` - `ButtonList` - `Divider`
   */
  cardsV2?: CardWithId[];
  /**
   * A custom name for a Chat message assigned at creation. Must start with
   * `client-` and contain only lowercase letters, numbers, and hyphens up to 63
   * characters in length. Specify this field to get, update, or delete the
   * message with the specified value. For example usage, see [Name a created
   * message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).
   */
  clientAssignedMessageId?: string;
  /**
   * Output only. The time at which the message was created in Google Chat
   * server.
   */
  readonly createTime?: Date;
  /**
   * A plain-text description of the message's cards, used when the actual
   * cards cannot be displayed (e.g. mobile notifications).
   */
  fallbackText?: 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, refer to [Preview
   * links](https://developers.google.com/chat/how-tos/preview-links).
   */
  readonly matchedUrl?: MatchedUrl;
  /**
   * Resource name in the form `spaces/*\/messages/*`. Example:
   * `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`
   */
  name?: string;
  /**
   * Output only. The user who created the message.
   */
  readonly sender?: User;
  /**
   * Output only. Slash command information, if applicable.
   */
  readonly slashCommand?: SlashCommand;
  /**
   * The space the message belongs to. When accessed with [user
   * authentication](https://developers.google.com/chat/api/guides/auth/users),
   * only the name of the Space is populated.
   */
  space?: Space;
  /**
   * Plain-text body of the message. The first link to an image, video, web
   * page, or other preview-able item generates a preview chip.
   */
  text?: string;
  /**
   * The thread the message belongs to. For example usage, see [Start or reply
   * to a message
   * thread](https://developers.google.com/chat/api/guides/crudl/messages#start_or_reply_to_a_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,
    actionResponse: data["actionResponse"] !== undefined ? serializeActionResponse(data["actionResponse"]) : undefined,
    cardsV2: data["cardsV2"] !== undefined ? data["cardsV2"].map((item: any) => (serializeCardWithId(item))) : undefined,
  };
}

function deserializeMessage(data: any): Message {
  return {
    ...data,
    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,
    lastUpdateTime: data["lastUpdateTime"] !== undefined ? new Date(data["lastUpdateTime"]) : undefined,
    slashCommand: data["slashCommand"] !== undefined ? deserializeSlashCommand(data["slashCommand"]) : undefined,
  };
}

/**
 * An onclick action (e.g. open a link).
 */
export interface OnClick {
  /**
   * A form action will be triggered by this onclick if specified.
   */
  action?: FormAction;
  /**
   * This onclick 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;
}

/**
 * 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 is currently no need for layout properties (e.g.
 * float).
 */
export interface Section {
  /**
   * The header of the section, text formatted supported.
   */
  header?: string;
  /**
   * A section must contain at least 1 widget.
   */
  widgets?: WidgetMarkup[];
}

/**
 * A [slash command](https://developers.google.com/chat/how-tos/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;
  /**
   * Indicating 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 {
  /**
   * The space's display name. Required when [creating a
   * space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create).
   * For direct messages, this field may be empty.
   */
  displayName?: string;
  /**
   * Resource name of the space. Format: spaces/{space}
   */
  name?: string;
  /**
   * Optional. Whether the space is a DM between a Chat app and a single human.
   */
  singleUserBotDm?: boolean;
  /**
   * Details about the space including description and rules.
   */
  spaceDetails?: SpaceDetails;
  /**
   * Output only. The threading state in the Chat space.
   */
  readonly spaceThreadingState?:  | "SPACE_THREADING_STATE_UNSPECIFIED" | "THREADED_MESSAGES" | "GROUPED_MESSAGES" | "UNTHREADED_MESSAGES";
  /**
   * Output only. Deprecated: Use `spaceThreadingState` instead. Whether
   * messages are threaded in this space.
   */
  readonly threaded?: boolean;
  /**
   * Output only. Deprecated: Use `singleUserBotDm` or `spaceType` (developer
   * preview) instead. The type of a space.
   */
  readonly type?:  | "TYPE_UNSPECIFIED" | "ROOM" | "DM";
}

/**
 * Details about the space including description and rules.
 */
export interface SpaceDetails {
  /**
   * Optional. A description of the space. It could describe the space's
   * discussion topic, functional purpose, or participants.
   */
  description?: string;
  /**
   * Optional. The space's rules, expectations, and etiquette.
   */
  guidelines?: string;
}

/**
 * Additional options for Chat#spacesList.
 */
export interface SpacesListOptions {
  /**
   * Optional. 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; values above 1000 are coerced to 1000. Negative
   * values return an INVALID_ARGUMENT error.
   */
  pageSize?: number;
  /**
   * Optional. A page token, received from a previous list spaces 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 may lead to unexpected results.
   */
  pageToken?: string;
}

/**
 * Additional options for Chat#spacesMembersList.
 */
export interface SpacesMembersListOptions {
  /**
   * The maximum number of memberships to return. The service may return fewer
   * than this value. If unspecified, at most 100 memberships are returned. The
   * maximum value is 1000; values above 1000 are coerced to 1000. Negative
   * values return an INVALID_ARGUMENT error.
   */
  pageSize?: number;
  /**
   * A page token, received from a previous list memberships call. Provide this
   * 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 may lead to unexpected results.
   */
  pageToken?: string;
}

/**
 * Additional options for Chat#spacesMessagesCreate.
 */
export interface SpacesMessagesCreateOptions {
  /**
   * Optional. A custom name for a Chat message assigned at creation. Must
   * start with `client-` and contain only lowercase letters, numbers, and
   * hyphens up to 63 characters in length. Specify this field to get, update,
   * or delete the message with the specified value. For example usage, see
   * [Name a created
   * message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).
   */
  messageId?: string;
  /**
   * Optional. Specifies whether a message starts a thread or replies to one.
   * Only supported in named spaces.
   */
  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. Opaque thread
   * identifier. 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/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).
   */
  threadKey?: string;
}

/**
 * Additional options for Chat#spacesMessagesPatch.
 */
export interface SpacesMessagesPatchOptions {
  /**
   * Optional. If `true` and the message is not found, a new message is created
   * and `updateMask` is ignored. The specified message ID must be
   * [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message)
   * or the request fails.
   */
  allowMissing?: boolean;
  /**
   * Required. The field paths to update. Separate multiple values with commas.
   * Currently supported field paths: - text - cards (Requires [service account
   * authentication](/chat/api/guides/auth/service-accounts).) - cards_v2
   */
  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#spacesMessagesUpdate.
 */
export interface SpacesMessagesUpdateOptions {
  /**
   * Optional. If `true` and the message is not found, a new message is created
   * and `updateMask` is ignored. The specified message ID must be
   * [client-assigned](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message)
   * or the request fails.
   */
  allowMissing?: boolean;
  /**
   * Required. The field paths to update. Separate multiple values with commas.
   * Currently supported field paths: - text - cards (Requires [service account
   * authentication](/chat/api/guides/auth/service-accounts).) - cards_v2
   */
  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,
  };
}

/**
 * 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 array 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.
 */
export interface TextParagraph {
  text?: string;
}

/**
 * A thread in Google Chat.
 */
export interface Thread {
  /**
   * Resource name of the thread. Example: spaces/{space}/threads/{thread}
   */
  name?: string;
  /**
   * Optional. Opaque thread identifier. 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/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).
   * For other requests, this is an output only field.
   */
  threadKey?: string;
}

/**
 * Time input values. Not supported by Chat apps.
 */
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). Not
 * supported by Chat apps.
 */
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;
}

/**
 * A user in Google Chat.
 */
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. For human users, represents a person
   * in the People API or a user in the Admin SDK Directory API. Format:
   * `users/{user}`
   */
  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;
}

/**
 * A widget is a UI element that presents texts, images, etc.
 */
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;
}