@google-apps/chat 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.6.0](https://github.com/googleapis/google-cloud-node/compare/chat-v0.5.0...chat-v0.6.0) (2024-07-10)
+
+
+### Features
+
+* [chat] Add doc for Discoverable Space support for GA launch ([#5525](https://github.com/googleapis/google-cloud-node/issues/5525)) ([9a80089](https://github.com/googleapis/google-cloud-node/commit/9a80089d974280420e269f24aba563f4adceb4c3))
+
 ## [0.5.0](https://github.com/googleapis/google-cloud-node/compare/chat-v0.4.0...chat-v0.5.0) (2024-05-21)
 
 

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

@@ -48,7 +48,7 @@ message Attachment {
   }
 
   // Resource name of the attachment, in the form
-  // `spaces/*/messages/*/attachments/*`.
+  // `spaces/{space}/messages/{message}/attachments/{attachment}`.
   string name = 1;
 
   // Output only. The original file name for the content, not the full path.
@@ -103,7 +103,7 @@ message AttachmentDataRef {
 // Request to get an attachment.
 message GetAttachmentRequest {
   // Required. Resource name of the attachment, in the form
-  // `spaces/*/messages/*/attachments/*`.
+  // `spaces/{space}/messages/{message}/attachments/{attachment}`.
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = { type: "chat.googleapis.com/Attachment" }

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

@@ -42,6 +42,11 @@ option ruby_package = "Google::Apps::Chat::V1";
 service ChatService {
   option (google.api.default_host) = "chat.googleapis.com";
   option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/chat.admin.delete,"
+      "https://www.googleapis.com/auth/chat.admin.memberships,"
+      "https://www.googleapis.com/auth/chat.admin.memberships.readonly,"
+      "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.delete,"
       "https://www.googleapis.com/auth/chat.import,"
@@ -253,6 +258,9 @@ service ChatService {
   // Lists spaces visible to the caller or authenticated user. Group chats
   // and DMs aren't listed until the first message is sent.
   //
+  // To list all named spaces by Google Workspace organization, use the
+  // [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search)
+  // method using Workspace administrator privileges instead.
   rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse) {
     option (google.api.http) = {
       get: "/v1/spaces"
@@ -311,6 +319,17 @@ service ChatService {
   // you can add the user to the space by setting the `membership.member.name`
   // to `users/user@example.com` or `users/123456789`.
   //
+  // To specify the Google groups to add, add memberships with the
+  // appropriate `membership.group_member.name`. To add or invite a Google
+  // group, use `groups/{group}`, where `{group}` is the `id` for the group from
+  // the Cloud Identity Groups API. For example, you can use [Cloud Identity
+  // Groups lookup
+  // API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
+  // to retrieve the ID `123456789` for group email `group@example.com`, then
+  // you can add the group to the space by setting the
+  // `membership.group_member.name` to `groups/123456789`. Group email is not
+  // supported, and Google groups can only be added as members in named spaces.
+  //
   // For a named space or group chat, if the caller blocks, or is blocked
   // by some members, or doesn't have permission to add some members, then
   // those members aren't added to the created space.
@@ -427,7 +446,8 @@ service ChatService {
   // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   //
   // To specify the member to add, set the `membership.member.name` for the
-  // human or app member.
+  // human or app member, or set the `membership.group_member.name` for the
+  // group member.
   //
   // - To add the calling app to a space or a direct message between two human
   //   users, use `users/app`. Unable to add other
@@ -440,6 +460,15 @@ service ChatService {
   // profile ID for `user@example.com` is `123456789`, you can add the user to
   // the space by setting the `membership.member.name` to
   // `users/user@example.com` or `users/123456789`.
+  //
+  // - To add or invite a Google group in a named space, use
+  // `groups/{group}`, where `{group}` is the `id` for the group from the Cloud
+  // Identity Groups API. For example, you can use [Cloud Identity Groups lookup
+  // API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
+  // to retrieve the ID `123456789` for group email `group@example.com`, then
+  // you can add or invite the group to a named space by setting the
+  // `membership.group_member.name` to `groups/123456789`. Group email is not
+  // supported, and Google groups can only be added as members in named spaces.
   rpc CreateMembership(CreateMembershipRequest) returns (Membership) {
     option (google.api.http) = {
       post: "/v1/{parent=spaces/*}/members"

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

@@ -106,8 +106,6 @@ message Membership {
     User member = 3;
 
     // The Google Group the membership corresponds to.
-    // Only supports read operations. Other operations, like
-    // creating or updating a membership, aren't currently supported.
     Group group_member = 5;
   }
 
@@ -217,16 +215,23 @@ message ListMembershipsRequest {
   //
   // To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`.
   //
-  // To filter by type, set `member.type` to `HUMAN` or `BOT`.
+  // To filter by type, set `member.type` to `HUMAN` or `BOT`. Developer
+  // Preview: You can also filter for `member.type` using the `!=` operator.
   //
   // To filter by both role and type, use the `AND` operator. To filter by
   // either role or type, use the `OR` operator.
   //
+  // Either `member.type = "HUMAN"` or `member.type != "BOT"` is required
+  // when `use_admin_access` is set to true. Other member type filters will be
+  // rejected.
+  //
   // For example, the following queries are valid:
   //
   // ```
   // role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
   // member.type = "HUMAN" AND role = "ROLE_MANAGER"
+  //
+  // member.type != "BOT"
   // ```
   //
   // The following queries are invalid:
@@ -236,7 +241,6 @@ message ListMembershipsRequest {
   // role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
   // ```
   //
-  //
   // Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
   // error.
   string filter = 5 [(google.api.field_behavior) = OPTIONAL];

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

@@ -103,6 +103,39 @@ message Space {
     string guidelines = 2;
   }
 
+  // Represents the [access
+  // setting](https://support.google.com/chat/answer/11971020) of the space.
+  message AccessSettings {
+    // Represents the access state of the space.
+    enum AccessState {
+      // Access state is unknown or not supported in this API.
+      ACCESS_STATE_UNSPECIFIED = 0;
+
+      // Space is discoverable by added or invited members or groups.
+      PRIVATE = 1;
+
+      // Space is discoverable by the selected [target
+      // audience](https://support.google.com/a/answer/9934697), as well as
+      // added or invited members or groups.
+      DISCOVERABLE = 2;
+    }
+
+    // Output only. Indicates the access state of the space.
+    AccessState access_state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Optional. The resource name of the [target
+    // audience](https://support.google.com/a/answer/9934697) who can discover
+    // the space, join the space, and preview the messages in the space. For
+    // details, see [Make a space discoverable to a target
+    // audience](https://developers.google.com/workspace/chat/space-target-audience).
+    //
+    // Format: `audiences/{audience}`
+    //
+    // To use the default target audience for the Google Workspace organization,
+    // set to `audiences/default`.
+    string audience = 3 [(google.api.field_behavior) = OPTIONAL];
+  }
+
   // Resource name of the space.
   //
   // Format: `spaces/{space}`
@@ -192,6 +225,14 @@ message Space {
   //
   // To support admin install, your Chat app must feature direct messaging.
   bool admin_installed = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. Specifies the [access
+  // setting](https://support.google.com/chat/answer/11971020) of the space.
+  // Only populated when the `space_type` is `SPACE`.
+  AccessSettings access_settings = 23 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. The URI for a user to access the space.
+  string space_uri = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // A request to create a named space.
@@ -270,7 +311,7 @@ message ListSpacesResponse {
 
 // A request to return a single space.
 message GetSpaceRequest {
-  // Required. Resource name of the space, in the form "spaces/*".
+  // Required. Resource name of the space, in the form `spaces/{space}`.
   //
   // Format: `spaces/{space}`
   string name = 1 [
@@ -325,6 +366,7 @@ message UpdateSpaceRequest {
   // the display name is optional if the existing space already has the `SPACE`
   // type. Trying to update the space type in other ways results in an invalid
   // argument error).
+  // `space_type` is not supported with admin access.
   //
   // - `space_details`
   //
@@ -333,12 +375,27 @@ message UpdateSpaceRequest {
   // allows users to change their history
   // setting](https://support.google.com/a/answer/7664184).
   // Warning: mutually exclusive with all other field paths.)
+  // `space_history_state` is not supported with admin access.
+  //
+  // - `access_settings.audience` (Supports changing the [access
+  // setting](https://support.google.com/chat/answer/11971020) of who can
+  // discover the space, join the space, and preview the messages in space. If
+  // no audience is specified in the access setting, the space's access setting
+  // is updated to private. Warning: mutually exclusive with all other field
+  // paths.)
+  // `access_settings.audience` is not supported with admin access.
   //
-  // - Developer Preview: `access_settings.audience` (Supports changing the
-  // [access setting](https://support.google.com/chat/answer/11971020) of a
-  // space. If no audience is specified in the access setting, the space's
-  // access setting is updated to restricted. Warning: mutually exclusive with
-  // all other field paths.)
+  // - Developer Preview: Supports changing the [permission
+  // settings](https://support.google.com/chat/answer/13340792) of a space,
+  // supported field paths
+  // include: `permission_settings.manage_members_and_groups`,
+  // `permission_settings.modify_space_details`,
+  // `permission_settings.toggle_history`,
+  // `permission_settings.use_at_mention_all`,
+  // `permission_settings.manage_apps`, `permission_settings.manage_webhooks`,
+  // `permission_settings.reply_messages`
+  //  (Warning: mutually exclusive with all other non-permission settings field
+  // paths). `permission_settings` is not supported with admin access.
   google.protobuf.FieldMask update_mask = 2;
 }
 

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

@@ -64,8 +64,8 @@ message SetUpSpaceRequest {
   // authenticated user returns an error.
   string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. The Google Chat users to invite to join the space. Omit the
-  // calling user, as they are added automatically.
+  // Optional. The Google Chat users or groups to invite to join the space. Omit
+  // the calling user, as they are added automatically.
   //
   // The set currently allows up to 20 memberships (in addition to the caller).
   //
@@ -78,6 +78,10 @@ message SetUpSpaceRequest {
   // To invite Gmail users or users from external Google Workspace domains,
   // user's email must be used for `{user}`.
   //
+  // For Google group membership, the `Membership.group_member` field must
+  // contain a `group` with `name` populated (format `groups/{group}`). You
+  // can only add Google groups when setting `Space.spaceType` to `SPACE`.
+  //
   // Optional when setting `Space.spaceType` to `SPACE`.
   //
   // Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at

package/build/protos/protos.d.ts

@@ -17563,6 +17563,12 @@ export namespace google {
 
                 /** Space adminInstalled */
                 adminInstalled?: (boolean|null);
+
+                /** Space accessSettings */
+                accessSettings?: (google.chat.v1.Space.IAccessSettings|null);
+
+                /** Space spaceUri */
+                spaceUri?: (string|null);
             }
 
             /** Represents a Space. */
@@ -17613,6 +17619,12 @@ export namespace google {
                 /** Space adminInstalled. */
                 public adminInstalled: boolean;
 
+                /** Space accessSettings. */
+                public accessSettings?: (google.chat.v1.Space.IAccessSettings|null);
+
+                /** Space spaceUri. */
+                public spaceUri: string;
+
                 /**
                  * Creates a new Space instance using the specified properties.
                  * @param [properties] Properties to set
@@ -17818,6 +17830,119 @@ export namespace google {
                      */
                     public static getTypeUrl(typeUrlPrefix?: string): string;
                 }
+
+                /** Properties of an AccessSettings. */
+                interface IAccessSettings {
+
+                    /** AccessSettings accessState */
+                    accessState?: (google.chat.v1.Space.AccessSettings.AccessState|keyof typeof google.chat.v1.Space.AccessSettings.AccessState|null);
+
+                    /** AccessSettings audience */
+                    audience?: (string|null);
+                }
+
+                /** Represents an AccessSettings. */
+                class AccessSettings implements IAccessSettings {
+
+                    /**
+                     * Constructs a new AccessSettings.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.chat.v1.Space.IAccessSettings);
+
+                    /** AccessSettings accessState. */
+                    public accessState: (google.chat.v1.Space.AccessSettings.AccessState|keyof typeof google.chat.v1.Space.AccessSettings.AccessState);
+
+                    /** AccessSettings audience. */
+                    public audience: string;
+
+                    /**
+                     * Creates a new AccessSettings instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns AccessSettings instance
+                     */
+                    public static create(properties?: google.chat.v1.Space.IAccessSettings): google.chat.v1.Space.AccessSettings;
+
+                    /**
+                     * Encodes the specified AccessSettings message. Does not implicitly {@link google.chat.v1.Space.AccessSettings.verify|verify} messages.
+                     * @param message AccessSettings message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.chat.v1.Space.IAccessSettings, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified AccessSettings message, length delimited. Does not implicitly {@link google.chat.v1.Space.AccessSettings.verify|verify} messages.
+                     * @param message AccessSettings message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.chat.v1.Space.IAccessSettings, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes an AccessSettings message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns AccessSettings
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.chat.v1.Space.AccessSettings;
+
+                    /**
+                     * Decodes an AccessSettings message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns AccessSettings
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.chat.v1.Space.AccessSettings;
+
+                    /**
+                     * Verifies an AccessSettings message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates an AccessSettings message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns AccessSettings
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.chat.v1.Space.AccessSettings;
+
+                    /**
+                     * Creates a plain object from an AccessSettings message. Also converts values to other types if specified.
+                     * @param message AccessSettings
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.chat.v1.Space.AccessSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this AccessSettings to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for AccessSettings
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
+                namespace AccessSettings {
+
+                    /** AccessState enum. */
+                    enum AccessState {
+                        ACCESS_STATE_UNSPECIFIED = 0,
+                        PRIVATE = 1,
+                        DISCOVERABLE = 2
+                    }
+                }
             }
 
             /** Properties of a CreateSpaceRequest. */