@google-apps/chat 0.10.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
@@ -131,6 +132,9 @@ message Space {
       // 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;
     }
 
@@ -150,8 +154,23 @@ message Space {
     // 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];
   }
 
@@ -178,42 +197,50 @@ message Space {
   // To set permission settings when creating a space, specify the
   // `PredefinedPermissionSettings` field in your request.
   message PermissionSettings {
-    // Setting for managing members and groups in a space.
-    optional PermissionSetting manage_members_and_groups = 1;
+    // Optional. Setting for managing members and groups in a space.
+    optional PermissionSetting manage_members_and_groups = 1
+        [(google.api.field_behavior) = OPTIONAL];
 
-    // Setting for updating space name, avatar, description and guidelines.
-    optional PermissionSetting modify_space_details = 2;
+    // Optional. Setting for updating space name, avatar, description and
+    // guidelines.
+    optional PermissionSetting modify_space_details = 2
+        [(google.api.field_behavior) = OPTIONAL];
 
-    // Setting for toggling space history on and off.
-    optional PermissionSetting toggle_history = 3;
+    // Optional. Setting for toggling space history on and off.
+    optional PermissionSetting toggle_history = 3
+        [(google.api.field_behavior) = OPTIONAL];
 
-    // Setting for using @all in a space.
-    optional PermissionSetting use_at_mention_all = 4;
+    // Optional. Setting for using @all in a space.
+    optional PermissionSetting use_at_mention_all = 4
+        [(google.api.field_behavior) = OPTIONAL];
 
-    // Setting for managing apps in a space.
-    optional PermissionSetting manage_apps = 5;
+    // Optional. Setting for managing apps in a space.
+    optional PermissionSetting manage_apps = 5
+        [(google.api.field_behavior) = OPTIONAL];
 
-    // Setting for managing webhooks in a space.
-    optional PermissionSetting manage_webhooks = 6;
+    // 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];
 
-    // Setting for replying to messages in a space.
-    optional PermissionSetting reply_messages = 8;
+    // 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 {
-    // Whether spaces managers have this permission.
-    bool managers_allowed = 1;
+    // Optional. Whether spaces managers have this permission.
+    bool managers_allowed = 1 [(google.api.field_behavior) = OPTIONAL];
 
-    // Whether non-manager members have this permission.
-    bool members_allowed = 2;
+    // Optional. Whether non-manager members have this permission.
+    bool members_allowed = 2 [(google.api.field_behavior) = OPTIONAL];
   }
 
-  // Resource name of the space.
+  // Identifier. Resource name of the space.
   //
   // Format: `spaces/{space}`
   //
@@ -223,15 +250,15 @@ message Space {
   // 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;
+  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.
@@ -242,7 +269,7 @@ message Space {
   bool threaded = 5
       [deprecated = true, (google.api.field_behavior) = OUTPUT_ONLY];
 
-  // The space's display name. Required when [creating a
+  // 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
@@ -252,32 +279,39 @@ message Space {
   // 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.
   //
   // 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
@@ -322,6 +356,9 @@ message Space {
   // 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
@@ -338,20 +375,28 @@ message Space {
     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 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`,
   // try a different `displayName`. An existing space within the Google
   // Workspace organization might already use this display name.
   //
-  // If you're a member of the [Developer Preview
-  // program](https://developers.google.com/workspace/preview),
-  // `SpaceType.GROUP_CHAT` can be used if `importMode` is set to true.
   //
   // The space `name` is assigned on the server so anything specified in this
   // field will be ignored.
@@ -430,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
@@ -439,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.
@@ -528,9 +573,10 @@ message UpdateSpaceRequest {
   // - `permission_settings.manageApps`
   // - `permission_settings.manageWebhooks`
   // - `permission_settings.replyMessages`
-  google.protobuf.FieldMask update_mask = 2;
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
 
-  // 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
@@ -542,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.
@@ -700,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
@@ -709,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.
   //

package/build/protos/protos.d.ts

@@ -3062,6 +3062,9 @@ export namespace google {
 
             /** FieldOptions .google.api.fieldBehavior */
             ".google.api.fieldBehavior"?: (google.api.FieldBehavior[]|null);
+
+            /** FieldOptions .google.api.fieldInfo */
+            ".google.api.fieldInfo"?: (google.api.IFieldInfo|null);
         }
 
         /** Represents a FieldOptions. */
@@ -17790,6 +17793,9 @@ export namespace google {
 
                 /** Space permissionSettings */
                 permissionSettings?: (google.chat.v1.Space.IPermissionSettings|null);
+
+                /** Space importModeExpireTime */
+                importModeExpireTime?: (google.protobuf.ITimestamp|null);
             }
 
             /** Represents a Space. */
@@ -17858,6 +17864,9 @@ export namespace google {
                 /** Space permissionSettings. */
                 public permissionSettings?: (google.chat.v1.Space.IPermissionSettings|null);
 
+                /** Space importModeExpireTime. */
+                public importModeExpireTime?: (google.protobuf.ITimestamp|null);
+
                 /** Space spacePermissionSettings. */
                 public spacePermissionSettings?: ("predefinedPermissionSettings"|"permissionSettings");
 
@@ -24749,5 +24758,114 @@ export namespace google {
             GA = 4,
             DEPRECATED = 5
         }
+
+        /** Properties of a FieldInfo. */
+        interface IFieldInfo {
+
+            /** FieldInfo format */
+            format?: (google.api.FieldInfo.Format|keyof typeof google.api.FieldInfo.Format|null);
+        }
+
+        /** Represents a FieldInfo. */
+        class FieldInfo implements IFieldInfo {
+
+            /**
+             * Constructs a new FieldInfo.
+             * @param [properties] Properties to set
+             */
+            constructor(properties?: google.api.IFieldInfo);
+
+            /** FieldInfo format. */
+            public format: (google.api.FieldInfo.Format|keyof typeof google.api.FieldInfo.Format);
+
+            /**
+             * Creates a new FieldInfo instance using the specified properties.
+             * @param [properties] Properties to set
+             * @returns FieldInfo instance
+             */
+            public static create(properties?: google.api.IFieldInfo): google.api.FieldInfo;
+
+            /**
+             * Encodes the specified FieldInfo message. Does not implicitly {@link google.api.FieldInfo.verify|verify} messages.
+             * @param message FieldInfo message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encode(message: google.api.IFieldInfo, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Encodes the specified FieldInfo message, length delimited. Does not implicitly {@link google.api.FieldInfo.verify|verify} messages.
+             * @param message FieldInfo message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encodeDelimited(message: google.api.IFieldInfo, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Decodes a FieldInfo message from the specified reader or buffer.
+             * @param reader Reader or buffer to decode from
+             * @param [length] Message length if known beforehand
+             * @returns FieldInfo
+             * @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.api.FieldInfo;
+
+            /**
+             * Decodes a FieldInfo message from the specified reader or buffer, length delimited.
+             * @param reader Reader or buffer to decode from
+             * @returns FieldInfo
+             * @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.api.FieldInfo;
+
+            /**
+             * Verifies a FieldInfo 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 a FieldInfo message from a plain object. Also converts values to their respective internal types.
+             * @param object Plain object
+             * @returns FieldInfo
+             */
+            public static fromObject(object: { [k: string]: any }): google.api.FieldInfo;
+
+            /**
+             * Creates a plain object from a FieldInfo message. Also converts values to other types if specified.
+             * @param message FieldInfo
+             * @param [options] Conversion options
+             * @returns Plain object
+             */
+            public static toObject(message: google.api.FieldInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+            /**
+             * Converts this FieldInfo to JSON.
+             * @returns JSON object
+             */
+            public toJSON(): { [k: string]: any };
+
+            /**
+             * Gets the default type url for FieldInfo
+             * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+             * @returns The default type url
+             */
+            public static getTypeUrl(typeUrlPrefix?: string): string;
+        }
+
+        namespace FieldInfo {
+
+            /** Format enum. */
+            enum Format {
+                FORMAT_UNSPECIFIED = 0,
+                UUID4 = 1,
+                IPV4 = 2,
+                IPV6 = 3,
+                IPV4_OR_IPV6 = 4
+            }
+        }
     }
 }