@google-apps/chat 0.9.0 → 0.11.0

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

@@ -95,22 +95,23 @@ message Space {
     // discussion topic, functional purpose, or participants.
     //
     // Supports up to 150 characters.
-    string description = 1;
+    string description = 1 [(google.api.field_behavior) = OPTIONAL];
 
     // Optional. The space's rules, expectations, and etiquette.
     //
     // Supports up to 5,000 characters.
-    string guidelines = 2;
+    string guidelines = 2 [(google.api.field_behavior) = OPTIONAL];
   }
 
   // Represents the count of memberships of a space, grouped into categories.
   message MembershipCount {
-    // Count of human users that have directly joined the space, not counting
-    // users joined by having membership in a joined group.
-    int32 joined_direct_human_user_count = 4;
+    // Output only. Count of human users that have directly joined the space,
+    // not counting users joined by having membership in a joined group.
+    int32 joined_direct_human_user_count = 4
+        [(google.api.field_behavior) = OUTPUT_ONLY];
 
-    // Count of all groups that have directly joined the space.
-    int32 joined_group_count = 5;
+    // Output only. Count of all groups that have directly joined the space.
+    int32 joined_group_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
   // Represents the [access
@@ -121,12 +122,19 @@ message Space {
       // Access state is unknown or not supported in this API.
       ACCESS_STATE_UNSPECIFIED = 0;
 
-      // Space is discoverable by added or invited members or groups.
+      // Only users or Google Groups that have been individually added or
+      // invited by other users or Google Workspace administrators can discover
+      // and access the space.
       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.
+      // A space manager has granted a target audience access to
+      // the space. Users or Google Groups that have been individually added or
+      // invited to the space can also discover and access the space. To learn
+      // more, see [Make a space discoverable to specific
+      // users](https://developers.google.com/workspace/chat/space-target-audience).
+      //
+      // Creating discoverable spaces requires [user
+      // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
       DISCOVERABLE = 2;
     }
 
@@ -135,29 +143,122 @@ message Space {
 
     // 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
+    // the space, join the space, and preview the messages in the space. If
+    // unset, only users or Google Groups who have been individually invited or
+    // added to the space can access it. For details, see [Make a space
+    // discoverable to a target
     // audience](https://developers.google.com/workspace/chat/space-target-audience).
     //
     // Format: `audiences/{audience}`
     //
     // To use the default target audience for the Google Workspace organization,
     // set to `audiences/default`.
+    //
+    // Reading the target audience supports:
+    //
+    // - [User
+    // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
+    //
+    // - [App
+    // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)
+    // with [administrator
+    // approval](https://support.google.com/a?p=chat-app-auth)
+    // with the `chat.app.spaces` scope in [Developer
+    // Preview](https://developers.google.com/workspace/preview).
+    //
+    // This field is not populated when using the `chat.bot` scope with [app
+    // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
+    //
+    // Setting the target audience requires [user
+    // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
     string audience = 3 [(google.api.field_behavior) = OPTIONAL];
   }
 
-  // Resource name of the space.
+  // Predefined permission settings that you can only specify when creating a
+  // named space. More settings might be added in the future.
+  // For details about permission settings for named spaces, see [Learn about
+  // spaces](https://support.google.com/chat/answer/7659784).
+  enum PredefinedPermissionSettings {
+    // Unspecified. Don't use.
+    PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED = 0;
+
+    // Setting to make the space a collaboration space where all members can
+    // post messages.
+    COLLABORATION_SPACE = 1;
+
+    // Setting to make the space an announcement space where only space managers
+    // can post messages.
+    ANNOUNCEMENT_SPACE = 2;
+  }
+
+  // [Permission settings](https://support.google.com/chat/answer/13340792)
+  // that you can specify when updating an existing named space.
+  //
+  // To set permission settings when creating a space, specify the
+  // `PredefinedPermissionSettings` field in your request.
+  message PermissionSettings {
+    // Optional. Setting for managing members and groups in a space.
+    optional PermissionSetting manage_members_and_groups = 1
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Setting for updating space name, avatar, description and
+    // guidelines.
+    optional PermissionSetting modify_space_details = 2
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Setting for toggling space history on and off.
+    optional PermissionSetting toggle_history = 3
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Setting for using @all in a space.
+    optional PermissionSetting use_at_mention_all = 4
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Setting for managing apps in a space.
+    optional PermissionSetting manage_apps = 5
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Setting for managing webhooks in a space.
+    optional PermissionSetting manage_webhooks = 6
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Output only. Setting for posting messages in a space.
+    optional PermissionSetting post_messages = 7
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Optional. Setting for replying to messages in a space.
+    optional PermissionSetting reply_messages = 8
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Represents a space permission setting.
+  message PermissionSetting {
+    // Optional. Whether spaces managers have this permission.
+    bool managers_allowed = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Whether non-manager members have this permission.
+    bool members_allowed = 2 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Identifier. Resource name of the space.
   //
   // Format: `spaces/{space}`
-  string name = 1;
+  //
+  // Where `{space}` represents the system-assigned ID for the space. You can
+  // obtain the space ID by calling the
+  // [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list)
+  // method or from the space URL. For example, if the space URL
+  // is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID
+  // is `AAAAAAAAA`.
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Output only. Deprecated: Use `space_type` instead.
   // The type of a space.
   Type type = 2 [deprecated = true, (google.api.field_behavior) = OUTPUT_ONLY];
 
-  // The type of space. Required when creating a space or updating the space
-  // type of a space. Output only for other usage.
-  SpaceType space_type = 10;
+  // Optional. The type of space. Required when creating a space or updating the
+  // space type of a space. Output only for other usage.
+  SpaceType space_type = 10 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Whether the space is a DM between a Chat app and a single
   // human.
@@ -168,51 +269,49 @@ message Space {
   bool threaded = 5
       [deprecated = true, (google.api.field_behavior) = OUTPUT_ONLY];
 
-  // The space's display name. Required when [creating a
-  // space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create).
-  // If you receive the error message `ALREADY_EXISTS` when creating a space or
-  // updating the `displayName`, try a different `displayName`. An
-  // existing space within the Google Workspace organization might already use
-  // this display name.
+  // Optional. The space's display name. Required when [creating a
+  // space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create)
+  // with a `spaceType` of `SPACE`. If you receive the error message
+  // `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a
+  // different `displayName`. An existing space within the Google Workspace
+  // organization might already use this display name.
   //
   // For direct messages, this field might be empty.
   //
   // Supports up to 128 characters.
-  string display_name = 3;
+  string display_name = 3 [(google.api.field_behavior) = OPTIONAL];
 
-  // Immutable. Whether this space permits any Google Chat user as a member.
-  // Input when creating a space in a Google Workspace organization. Omit this
-  // field when creating spaces in the following conditions:
+  // Optional. Immutable. Whether this space permits any Google Chat user as a
+  // member. Input when creating a space in a Google Workspace organization.
+  // Omit this field when creating spaces in the following conditions:
   //
   //   * The authenticated user uses a consumer account (unmanaged user
   //     account). By default, a space created by a consumer account permits any
   //     Google Chat user.
   //
-  //   * The space is used to [import data to Google Chat]
-  //     (https://developers.google.com/chat/api/guides/import-data-overview)
-  //     because import mode spaces must only permit members from the same
-  //     Google Workspace organization. However, as part of the [Google
-  //     Workspace Developer Preview
-  //     Program](https://developers.google.com/workspace/preview), import mode
-  //     spaces can permit any Google Chat user so this field can then be set
-  //     for import mode spaces.
-  //
   // For existing spaces, this field is output only.
-  bool external_user_allowed = 8 [(google.api.field_behavior) = IMMUTABLE];
+  bool external_user_allowed = 8 [
+    (google.api.field_behavior) = IMMUTABLE,
+    (google.api.field_behavior) = OPTIONAL
+  ];
 
   // Output only. The threading state in the Chat space.
   SpaceThreadingState space_threading_state = 9
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Details about the space including description and rules.
-  SpaceDetails space_details = 11;
+  // Optional. Details about the space including description and rules.
+  SpaceDetails space_details = 11 [(google.api.field_behavior) = OPTIONAL];
 
-  // The message history state for messages and threads in this space.
-  HistoryState space_history_state = 13;
+  // Optional. The message history state for messages and threads in this space.
+  HistoryState space_history_state = 13
+      [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Whether this space is created in `Import Mode` as part of a data
   // migration into Google Workspace. While spaces are being imported, they
   // aren't visible to users until the import is complete.
+  //
+  // Creating a space in `Import Mode`requires [user
+  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   bool import_mode = 16 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Immutable. For spaces created in Chat, the time the space was
@@ -253,17 +352,52 @@ message Space {
 
   // Output only. The URI for a user to access the space.
   string space_uri = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Represents the [permission settings]
+  // (https://support.google.com/chat/answer/13340792) of a space. Only
+  // populated when the `space_type` is `SPACE`.
+  //
+  // Requires [user
+  // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  oneof space_permission_settings {
+    // Optional. Input only. Predefined space permission settings, input only
+    // when creating a space. If the field is not set, a collaboration space is
+    // created. After you create the space, settings are populated in the
+    // `PermissionSettings` field.
+    PredefinedPermissionSettings predefined_permission_settings = 26 [
+      (google.api.field_behavior) = INPUT_ONLY,
+      (google.api.field_behavior) = OPTIONAL
+    ];
+
+    // Optional. Space permission settings for existing spaces. Input for
+    // updating exact space permission settings, where existing permission
+    // settings are replaced. Output lists current permission settings.
+    PermissionSettings permission_settings = 27
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Output only. The time when the space will be automatically deleted by the
+  // system if it remains in import mode.
+  //
+  // Each space created in import mode must exit this mode before this expire
+  // time using `spaces.completeImport`.
+  //
+  // This field is only populated for spaces that were created with import mode.
+  google.protobuf.Timestamp import_mode_expire_time = 28
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
-// A request to create a named space.
+// A request to create a named space with no members.
 message CreateSpaceRequest {
   // Required. The `displayName` and `spaceType` fields must be populated.  Only
-  // `SpaceType.SPACE` is supported.
+  // `SpaceType.SPACE`  and `SpaceType.GROUP_CHAT` are supported.
+  // `SpaceType.GROUP_CHAT` can only be used if `importMode` is set to true.
   //
-  // If you receive the error message `ALREADY_EXISTS` when creating a space,
+  // If you receive the error message `ALREADY_EXISTS`,
   // try a different `displayName`. An existing space within the Google
   // Workspace organization might already use this display name.
   //
+  //
   // The space `name` is assigned on the server so anything specified in this
   // field will be ignored.
   Space space = 1 [(google.api.field_behavior) = REQUIRED];
@@ -322,6 +456,8 @@ message ListSpacesRequest {
 // The response for a list spaces request.
 message ListSpacesResponse {
   // List of spaces in the requested (or first) page.
+  // Note: The `permissionSettings` field is not returned in the Space
+  // object for list requests.
   repeated Space spaces = 1;
 
   // You can send a token as `pageToken` to retrieve the next page of
@@ -339,7 +475,7 @@ message GetSpaceRequest {
     (google.api.resource_reference) = { type: "chat.googleapis.com/Space" }
   ];
 
-  // When `true`, the method runs using the user's Google Workspace
+  // Optional. When `true`, the method runs using the user's Google Workspace
   // administrator privileges.
   //
   // The calling user must be a Google Workspace administrator with the
@@ -348,7 +484,7 @@ message GetSpaceRequest {
   //
   // Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0
   // scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
-  bool use_admin_access = 2;
+  bool use_admin_access = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // A request to get direct message space based on the user resource.
@@ -379,57 +515,68 @@ message UpdateSpaceRequest {
   // Required. The updated field paths, comma separated if there are
   // multiple.
   //
-  // Currently supported field paths:
+  // You can update the following fields for a space:
   //
-  // - `display_name` (Only supports changing the display name of a space with
-  // the `SPACE` type, or when also including the `space_type` mask to change a
-  // `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a
-  // `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument
-  // error. If you receive the error message `ALREADY_EXISTS` when updating the
-  // `displayName`, try a different `displayName`. An existing space within the
-  // Google Workspace organization might already use this display name.)
+  // `space_details`: Updates the space's description. Supports up to 150
+  // characters.
   //
-  // - `space_type` (Only supports changing a `GROUP_CHAT` space type to
+  // `display_name`: Only supports updating the display name for spaces where
+  // `spaceType` field is `SPACE`.
+  //  If you receive the error message `ALREADY_EXISTS`, try a different
+  //  value. An existing space within the
+  // Google Workspace organization might already use this display name.
+  //
+  // `space_type`: Only supports changing a `GROUP_CHAT` space type to
   // `SPACE`. Include `display_name` together
   // with `space_type` in the update mask and ensure that the specified space
   // has a non-empty display name and the `SPACE` space type. Including the
   // `space_type` mask and the `SPACE` type in the specified space when updating
   // the display name is optional if the existing space already has the `SPACE`
   // type. Trying to update the space type in other ways results in an invalid
-  // argument error).
-  // `space_type` is not supported with admin access.
-  //
-  // - `space_details`
+  // argument error.
+  // `space_type` is not supported with `useAdminAccess`.
   //
-  // - `space_history_state` (Supports [turning history on or off for the
-  // space](https://support.google.com/chat/answer/7664687) if [the organization
-  // 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.
+  // `space_history_state`: Updates [space history
+  // settings](https://support.google.com/chat/answer/7664687) by turning
+  // history on or off for the space. Only supported if history settings are
+  // enabled for the Google Workspace organization. To update the
+  // space history state, you must omit all other field masks in your request.
+  // `space_history_state` is not supported with `useAdminAccess`.
   //
-  // - `access_settings.audience` (Supports changing the [access
+  // `access_settings.audience`: Updates the [access
   // setting](https://support.google.com/chat/answer/11971020) of who can
-  // discover the space, join the space, and preview the messages in 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: 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;
-
-  // When `true`, the method runs using the user's Google Workspace
+  // discover the space, join the space, and preview the messages in named space
+  // where `spaceType` field is `SPACE`. If the existing space has a
+  // target audience, you can remove the audience and restrict space access by
+  // omitting a value for this field mask. To update access settings for a
+  // space, the authenticating user must be a space manager and omit all other
+  // field masks in your request. You can't update this field if the space is in
+  // [import
+  // mode](https://developers.google.com/workspace/chat/import-data-overview).
+  // To learn more, see [Make a space discoverable to specific
+  // users](https://developers.google.com/workspace/chat/space-target-audience).
+  // `access_settings.audience` is not supported with `useAdminAccess`.
+  //
+  // `permission_settings`: Supports changing the
+  // [permission settings](https://support.google.com/chat/answer/13340792)
+  // of a space.
+  // When updating permission settings, you can only specify
+  // `permissionSettings` field masks; you cannot update other field masks
+  // at the same time. `permissionSettings` is not supported with
+  // `useAdminAccess`.
+  // The supported field masks include:
+  //
+  // - `permission_settings.manageMembersAndGroups`
+  // - `permission_settings.modifySpaceDetails`
+  // - `permission_settings.toggleHistory`
+  // - `permission_settings.useAtMentionAll`
+  // - `permission_settings.manageApps`
+  // - `permission_settings.manageWebhooks`
+  // - `permission_settings.replyMessages`
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. When `true`, the method runs using the user's Google Workspace
   // administrator privileges.
   //
   // The calling user must be a Google Workspace administrator with the
@@ -441,7 +588,7 @@ message UpdateSpaceRequest {
   //
   // Some `FieldMask` values are not supported using admin access. For details,
   // see the description of `update_mask`.
-  bool use_admin_access = 3;
+  bool use_admin_access = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request to search for a list of spaces based on a query.
@@ -599,7 +746,7 @@ message DeleteSpaceRequest {
     (google.api.resource_reference) = { type: "chat.googleapis.com/Space" }
   ];
 
-  // When `true`, the method runs using the user's Google Workspace
+  // Optional. When `true`, the method runs using the user's Google Workspace
   // administrator privileges.
   //
   // The calling user must be a Google Workspace administrator with the
@@ -608,7 +755,7 @@ message DeleteSpaceRequest {
   //
   // Requires the `chat.admin.delete` [OAuth 2.0
   // scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
-  bool use_admin_access = 2;
+  bool use_admin_access = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request message for completing the import process for a space.

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

@@ -216,15 +216,15 @@ message ListSpaceEventsRequest {
   // return fewer than this value.
   //
   // Negative values return an `INVALID_ARGUMENT` error.
-  int32 page_size = 5;
+  int32 page_size = 5 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous list space events call. Provide this
-  // to retrieve the subsequent page.
+  // Optional. A page token, received from a previous list space events call.
+  // Provide this to retrieve the subsequent page.
   //
   // When paginating, all other parameters provided to list space events must
   // match the call that provided the page token. Passing different values to
   // the other parameters might lead to unexpected results.
-  string page_token = 6;
+  string page_token = 6 [(google.api.field_behavior) = OPTIONAL];
 
   // Required. A query filter.
   //
@@ -284,6 +284,8 @@ message ListSpaceEventsRequest {
 // Response message for listing space events.
 message ListSpaceEventsResponse {
   // Results are returned in chronological order (oldest event first).
+  // Note: The `permissionSettings` field is not returned in the Space
+  // object for list requests.
   repeated SpaceEvent space_events = 1;
 
   // Continuation token used to fetch more events.