@google-apps/chat 0.14.0 → 0.16.0

package/README.md

@@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 1.  [Select or create a Cloud Platform project][projects].
 1.  [Enable billing for your project][billing].
 1.  [Enable the Google Chat API API][enable_api].
-1.  [Set up authentication with a service account][auth] so you can access the
+1.  [Set up authentication][auth] so you can access the
     API from your local workstation.
 
 ### Installing the client library
@@ -127,16 +127,19 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Sample                      | Source Code                       | Try it |
 | --------------------------- | --------------------------------- | ------ |
 | Chat_service.complete_import_space | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.complete_import_space.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.complete_import_space.js,packages/google-chat/samples/README.md) |
+| Chat_service.create_custom_emoji | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.create_custom_emoji.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.create_custom_emoji.js,packages/google-chat/samples/README.md) |
 | Chat_service.create_membership | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.create_membership.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.create_membership.js,packages/google-chat/samples/README.md) |
 | Chat_service.create_message | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.create_message.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.create_message.js,packages/google-chat/samples/README.md) |
 | Chat_service.create_reaction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.create_reaction.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.create_reaction.js,packages/google-chat/samples/README.md) |
 | Chat_service.create_space | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.create_space.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.create_space.js,packages/google-chat/samples/README.md) |
+| Chat_service.delete_custom_emoji | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.delete_custom_emoji.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.delete_custom_emoji.js,packages/google-chat/samples/README.md) |
 | Chat_service.delete_membership | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.delete_membership.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.delete_membership.js,packages/google-chat/samples/README.md) |
 | Chat_service.delete_message | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.delete_message.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.delete_message.js,packages/google-chat/samples/README.md) |
 | Chat_service.delete_reaction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.delete_reaction.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.delete_reaction.js,packages/google-chat/samples/README.md) |
 | Chat_service.delete_space | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.delete_space.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.delete_space.js,packages/google-chat/samples/README.md) |
 | Chat_service.find_direct_message | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.find_direct_message.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.find_direct_message.js,packages/google-chat/samples/README.md) |
 | Chat_service.get_attachment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.get_attachment.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.get_attachment.js,packages/google-chat/samples/README.md) |
+| Chat_service.get_custom_emoji | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.get_custom_emoji.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.get_custom_emoji.js,packages/google-chat/samples/README.md) |
 | Chat_service.get_membership | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.get_membership.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.get_membership.js,packages/google-chat/samples/README.md) |
 | Chat_service.get_message | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.get_message.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.get_message.js,packages/google-chat/samples/README.md) |
 | Chat_service.get_space | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.get_space.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.get_space.js,packages/google-chat/samples/README.md) |
@@ -144,6 +147,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Chat_service.get_space_notification_setting | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.get_space_notification_setting.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.get_space_notification_setting.js,packages/google-chat/samples/README.md) |
 | Chat_service.get_space_read_state | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.get_space_read_state.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.get_space_read_state.js,packages/google-chat/samples/README.md) |
 | Chat_service.get_thread_read_state | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.get_thread_read_state.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.get_thread_read_state.js,packages/google-chat/samples/README.md) |
+| Chat_service.list_custom_emojis | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.list_custom_emojis.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.list_custom_emojis.js,packages/google-chat/samples/README.md) |
 | Chat_service.list_memberships | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.list_memberships.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.list_memberships.js,packages/google-chat/samples/README.md) |
 | Chat_service.list_messages | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.list_messages.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.list_messages.js,packages/google-chat/samples/README.md) |
 | Chat_service.list_reactions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-chat/samples/generated/v1/chat_service.list_reactions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-chat/samples/generated/v1/chat_service.list_reactions.js,packages/google-chat/samples/README.md) |
@@ -226,4 +230,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
 [projects]: https://console.cloud.google.com/project
 [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
 [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=chat.googleapis.com
-[auth]: https://cloud.google.com/docs/authentication/getting-started
+[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local

package/build/protos/google/chat/v1/chat_service.proto

@@ -50,6 +50,8 @@ service ChatService {
       "https://www.googleapis.com/auth/chat.admin.spaces,"
       "https://www.googleapis.com/auth/chat.admin.spaces.readonly,"
       "https://www.googleapis.com/auth/chat.bot,"
+      "https://www.googleapis.com/auth/chat.customemojis,"
+      "https://www.googleapis.com/auth/chat.customemojis.readonly,"
       "https://www.googleapis.com/auth/chat.delete,"
       "https://www.googleapis.com/auth/chat.import,"
       "https://www.googleapis.com/auth/chat.memberships,"
@@ -653,6 +655,85 @@ service ChatService {
     option (google.api.method_signature) = "name";
   }
 
+  // Creates a custom emoji.
+  //
+  // Custom emojis are only available for Google Workspace accounts, and the
+  // administrator must turn custom emojis on for the organization. For more
+  // information, see [Learn about custom emojis in Google
+  // Chat](https://support.google.com/chat/answer/12800149) and
+  // [Manage custom emoji
+  // permissions](https://support.google.com/a/answer/12850085).
+  //
+  // Requires [user
+  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji) {
+    option (google.api.http) = {
+      post: "/v1/customEmojis"
+      body: "custom_emoji"
+    };
+    option (google.api.method_signature) = "custom_emoji";
+  }
+
+  // Returns details about a custom emoji.
+  //
+  // Custom emojis are only available for Google Workspace accounts, and the
+  // administrator must turn custom emojis on for the organization. For more
+  // information, see [Learn about custom emojis in Google
+  // Chat](https://support.google.com/chat/answer/12800149) and
+  // [Manage custom emoji
+  // permissions](https://support.google.com/a/answer/12850085).
+  //
+  // Requires [user
+  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji) {
+    option (google.api.http) = {
+      get: "/v1/{name=customEmojis/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Lists custom emojis visible to the authenticated user.
+  //
+  // Custom emojis are only available for Google Workspace accounts, and the
+  // administrator must turn custom emojis on for the organization. For more
+  // information, see [Learn about custom emojis in Google
+  // Chat](https://support.google.com/chat/answer/12800149) and
+  // [Manage custom emoji
+  // permissions](https://support.google.com/a/answer/12850085).
+  //
+  // Requires [user
+  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  rpc ListCustomEmojis(ListCustomEmojisRequest)
+      returns (ListCustomEmojisResponse) {
+    option (google.api.http) = {
+      get: "/v1/customEmojis"
+    };
+    option (google.api.method_signature) = "";
+  }
+
+  // Deletes a custom emoji. By default, users can only delete custom emoji they
+  // created. [Emoji managers](https://support.google.com/a/answer/12850085)
+  // assigned by the administrator can delete any custom emoji in the
+  // organization. See [Learn about custom emojis in Google
+  // Chat](https://support.google.com/chat/answer/12800149).
+  //
+  // Custom emojis are only available for Google Workspace accounts, and the
+  // administrator must turn custom emojis on for the organization. For more
+  // information, see [Learn about custom emojis in Google
+  // Chat](https://support.google.com/chat/answer/12800149) and
+  // [Manage custom emoji
+  // permissions](https://support.google.com/a/answer/12850085).
+  //
+  // Requires [user
+  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  rpc DeleteCustomEmoji(DeleteCustomEmojiRequest)
+      returns (google.protobuf.Empty) {
+    option (google.api.http) = {
+      delete: "/v1/{name=customEmojis/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
   // Returns details about a user's read state within a space, used to identify
   // read and unread messages. For an example, see [Get details about a user's
   // space read

package/build/protos/google/chat/v1/reaction.proto

@@ -61,13 +61,74 @@ message Emoji {
   }
 }
 
-// Represents a custom emoji.
+// Represents a [custom emoji](https://support.google.com/chat/answer/12800149).
 message CustomEmoji {
+  option (google.api.resource) = {
+    type: "chat.googleapis.com/CustomEmoji"
+    pattern: "customEmojis/{custom_emoji}"
+    plural: "customEmojis"
+    singular: "customEmoji"
+  };
+
+  // Payload data for the custom emoji.
+  message CustomEmojiPayload {
+    // Required. Input only. The image used for the custom emoji.
+    //
+    // The payload must be under 256 KB and the dimension of
+    // the image must be square and between 64 and 500 pixels. The
+    // restrictions are subject to change.
+    bytes file_content = 1 [
+      (google.api.field_behavior) = INPUT_ONLY,
+      (google.api.field_behavior) = REQUIRED
+    ];
+
+    // Required. Input only. The image file name.
+    //
+    // Supported file extensions: `.png`, `.jpg`, `.gif`.
+    string filename = 2 [
+      (google.api.field_behavior) = INPUT_ONLY,
+      (google.api.field_behavior) = REQUIRED
+    ];
+  }
+
+  // Identifier. The resource name of the custom emoji, assigned by the server.
+  //
+  // Format: `customEmojis/{customEmoji}`
+  string name = 2 [(google.api.field_behavior) = IDENTIFIER];
+
   // Output only. Unique key for the custom emoji resource.
   string uid = 1 [
     (google.api.field_info).format = UUID4,
     (google.api.field_behavior) = OUTPUT_ONLY
   ];
+
+  // Optional. Immutable. User-provided name for the custom emoji, which is
+  // unique within the organization.
+  //
+  // Required when the custom emoji is created, output only otherwise.
+  //
+  // Emoji names must start and end with colons, must be lowercase and can only
+  // contain alphanumeric characters, hyphens, and underscores.
+  // Hyphens and underscores should be used to separate words and cannot be used
+  // consecutively.
+  //
+  // Example: `:valid-emoji-name:`
+  string emoji_name = 3 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
+
+  // Output only. A temporary image URL for the custom emoji, valid for at least
+  // 10 minutes. Note that this is not populated in the response when the custom
+  // emoji is created.
+  string temporary_image_uri = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. Input only. Payload data.
+  // Required when the custom emoji is created.
+  CustomEmojiPayload payload = 5 [
+    (google.api.field_behavior) = INPUT_ONLY,
+    (google.api.field_behavior) = OPTIONAL
+  ];
 }
 
 // The number of people who reacted to a message with a specific emoji.
@@ -163,8 +224,7 @@ message ListReactionsRequest {
   // AND user.name = "users/{user}"
   // ```
   //
-  // Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
-  // error.
+  // Invalid queries are rejected with an `INVALID_ARGUMENT` error.
   string filter = 4 [(google.api.field_behavior) = OPTIONAL];
 }
 
@@ -188,3 +248,88 @@ message DeleteReactionRequest {
     (google.api.resource_reference) = { type: "chat.googleapis.com/Reaction" }
   ];
 }
+
+// A request to create a custom emoji.
+message CreateCustomEmojiRequest {
+  // Required. The custom emoji to create.
+  CustomEmoji custom_emoji = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// A request to return a single custom emoji.
+message GetCustomEmojiRequest {
+  // Required. Resource name of the custom emoji.
+  //
+  // Format: `customEmojis/{customEmoji}`
+  //
+  // You can use the emoji name as an alias for `{customEmoji}`. For example,
+  // `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name
+  // for a custom emoji.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "chat.googleapis.com/CustomEmoji"
+    }
+  ];
+}
+
+// A request to return a list of custom emojis.
+message ListCustomEmojisRequest {
+  // Optional. The maximum number of custom emojis returned. The service can
+  // return fewer custom emojis than this value. If unspecified, the default
+  // value is 25. The maximum value is 200; values above 200 are changed to 200.
+  int32 page_size = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. (If resuming from a previous query.)
+  //
+  // A page token received from a previous list custom emoji call. Provide this
+  // to retrieve the subsequent page.
+  //
+  // When paginating, the filter value should match the call that provided the
+  // page token. Passing a different value might lead to unexpected results.
+  string page_token = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A query filter.
+  //
+  // Supports filtering by creator.
+  //
+  // To filter by creator, you must specify a valid value. Currently only
+  // `creator("users/me")` and `NOT creator("users/me")` are accepted to filter
+  // custom emojis by whether they were created by the calling user or not.
+  //
+  // For example, the following query returns custom emojis created by the
+  // caller:
+  // ```
+  // creator("users/me")
+  // ```
+  //
+  // Invalid queries are rejected with an `INVALID_ARGUMENT` error.
+  string filter = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// A response to list custom emojis.
+message ListCustomEmojisResponse {
+  // Unordered list. List of custom emojis.
+  repeated CustomEmoji custom_emojis = 1
+      [(google.api.field_behavior) = UNORDERED_LIST];
+
+  // A token that you can send as `pageToken` to retrieve the next page of
+  // results. If empty, there are no subsequent pages.
+  string next_page_token = 2;
+}
+
+// Request for deleting a custom emoji.
+message DeleteCustomEmojiRequest {
+  // Required. Resource name of the custom emoji to delete.
+  //
+  // Format: `customEmojis/{customEmoji}`
+  //
+  // You can use the emoji name as an alias for `{customEmoji}`. For example,
+  // `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name
+  // for a custom emoji.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "chat.googleapis.com/CustomEmoji"
+    }
+  ];
+}