@google-apps/chat 0.31.0 → 0.32.0

package/build/protos/protos.json

@@ -3914,7 +3914,7 @@
                 "ChatService": {
                   "options": {
                     "(google.api.default_host)": "chat.googleapis.com",
-                    "(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.app.all.memberships.readonly,https://www.googleapis.com/auth/chat.app.all.messages.readonly,https://www.googleapis.com/auth/chat.app.all.spaces.readonly,https://www.googleapis.com/auth/chat.app.delete,https://www.googleapis.com/auth/chat.app.memberships,https://www.googleapis.com/auth/chat.app.memberships.readonly,https://www.googleapis.com/auth/chat.app.messages.readonly,https://www.googleapis.com/auth/chat.app.spaces,https://www.googleapis.com/auth/chat.app.spaces.create,https://www.googleapis.com/auth/chat.app.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,https://www.googleapis.com/auth/chat.memberships.app,https://www.googleapis.com/auth/chat.memberships.readonly,https://www.googleapis.com/auth/chat.messages,https://www.googleapis.com/auth/chat.messages.create,https://www.googleapis.com/auth/chat.messages.reactions,https://www.googleapis.com/auth/chat.messages.reactions.create,https://www.googleapis.com/auth/chat.messages.reactions.readonly,https://www.googleapis.com/auth/chat.messages.readonly,https://www.googleapis.com/auth/chat.spaces,https://www.googleapis.com/auth/chat.spaces.create,https://www.googleapis.com/auth/chat.spaces.readonly,https://www.googleapis.com/auth/chat.users.availability,https://www.googleapis.com/auth/chat.users.availability.readonly,https://www.googleapis.com/auth/chat.users.readstate,https://www.googleapis.com/auth/chat.users.readstate.readonly,https://www.googleapis.com/auth/chat.users.sections,https://www.googleapis.com/auth/chat.users.sections.readonly,https://www.googleapis.com/auth/chat.users.spacesettings"
+                    "(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.app.all.memberships.readonly,https://www.googleapis.com/auth/chat.app.all.messages.readonly,https://www.googleapis.com/auth/chat.app.all.spaces.readonly,https://www.googleapis.com/auth/chat.app.delete,https://www.googleapis.com/auth/chat.app.memberships,https://www.googleapis.com/auth/chat.app.memberships.readonly,https://www.googleapis.com/auth/chat.app.messages.readonly,https://www.googleapis.com/auth/chat.app.spaces,https://www.googleapis.com/auth/chat.app.spaces.create,https://www.googleapis.com/auth/chat.app.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,https://www.googleapis.com/auth/chat.memberships.app,https://www.googleapis.com/auth/chat.memberships.readonly,https://www.googleapis.com/auth/chat.messages,https://www.googleapis.com/auth/chat.messages.create,https://www.googleapis.com/auth/chat.messages.reactions,https://www.googleapis.com/auth/chat.messages.reactions.create,https://www.googleapis.com/auth/chat.messages.reactions.readonly,https://www.googleapis.com/auth/chat.messages.readonly,https://www.googleapis.com/auth/chat.spaces,https://www.googleapis.com/auth/chat.spaces.create,https://www.googleapis.com/auth/chat.spaces.pins,https://www.googleapis.com/auth/chat.spaces.pins.readonly,https://www.googleapis.com/auth/chat.spaces.readonly,https://www.googleapis.com/auth/chat.users.availability,https://www.googleapis.com/auth/chat.users.availability.readonly,https://www.googleapis.com/auth/chat.users.readstate,https://www.googleapis.com/auth/chat.users.readstate.readonly,https://www.googleapis.com/auth/chat.users.sections,https://www.googleapis.com/auth/chat.users.sections.readonly,https://www.googleapis.com/auth/chat.users.spacesettings"
                   },
                   "methods": {
                     "CreateMessage": {
@@ -4393,6 +4393,62 @@
                         }
                       ]
                     },
+                    "ListMessagePins": {
+                      "requestType": "ListMessagePinsRequest",
+                      "responseType": "ListMessagePinsResponse",
+                      "options": {
+                        "(google.api.http).get": "/v1/{parent=spaces/*}/messagePins",
+                        "(google.api.method_signature)": "parent"
+                      },
+                      "parsedOptions": [
+                        {
+                          "(google.api.http)": {
+                            "get": "/v1/{parent=spaces/*}/messagePins"
+                          }
+                        },
+                        {
+                          "(google.api.method_signature)": "parent"
+                        }
+                      ]
+                    },
+                    "CreateMessagePin": {
+                      "requestType": "CreateMessagePinRequest",
+                      "responseType": "MessagePin",
+                      "options": {
+                        "(google.api.http).post": "/v1/{parent=spaces/*}/messagePins",
+                        "(google.api.http).body": "message_pin",
+                        "(google.api.method_signature)": "parent,message_pin"
+                      },
+                      "parsedOptions": [
+                        {
+                          "(google.api.http)": {
+                            "post": "/v1/{parent=spaces/*}/messagePins",
+                            "body": "message_pin"
+                          }
+                        },
+                        {
+                          "(google.api.method_signature)": "parent,message_pin"
+                        }
+                      ]
+                    },
+                    "DeleteMessagePin": {
+                      "requestType": "DeleteMessagePinRequest",
+                      "responseType": "google.protobuf.Empty",
+                      "options": {
+                        "(google.api.http).delete": "/v1/{name=spaces/*/messagePins/*}",
+                        "(google.api.method_signature)": "name"
+                      },
+                      "parsedOptions": [
+                        {
+                          "(google.api.http)": {
+                            "delete": "/v1/{name=spaces/*/messagePins/*}"
+                          }
+                        },
+                        {
+                          "(google.api.method_signature)": "name"
+                        }
+                      ]
+                    },
                     "CreateCustomEmoji": {
                       "requestType": "CreateCustomEmojiRequest",
                       "responseType": "CustomEmoji",
@@ -7098,6 +7154,101 @@
                     }
                   }
                 },
+                "MessagePin": {
+                  "options": {
+                    "(google.api.resource).type": "chat.googleapis.com/MessagePin",
+                    "(google.api.resource).pattern": "spaces/{space}/messagePins/{message_pin}",
+                    "(google.api.resource).plural": "messagePins",
+                    "(google.api.resource).singular": "messagePin"
+                  },
+                  "fields": {
+                    "name": {
+                      "type": "string",
+                      "id": 1,
+                      "options": {
+                        "(google.api.field_behavior)": "IDENTIFIER"
+                      }
+                    },
+                    "message": {
+                      "type": "string",
+                      "id": 2,
+                      "options": {
+                        "(google.api.field_behavior)": "REQUIRED",
+                        "(google.api.resource_reference).type": "chat.googleapis.com/Message"
+                      }
+                    }
+                  }
+                },
+                "ListMessagePinsRequest": {
+                  "fields": {
+                    "parent": {
+                      "type": "string",
+                      "id": 1,
+                      "options": {
+                        "(google.api.field_behavior)": "REQUIRED",
+                        "(google.api.resource_reference).child_type": "chat.googleapis.com/MessagePin"
+                      }
+                    },
+                    "pageSize": {
+                      "type": "int32",
+                      "id": 2,
+                      "options": {
+                        "(google.api.field_behavior)": "OPTIONAL"
+                      }
+                    },
+                    "pageToken": {
+                      "type": "string",
+                      "id": 3,
+                      "options": {
+                        "(google.api.field_behavior)": "OPTIONAL"
+                      }
+                    }
+                  }
+                },
+                "ListMessagePinsResponse": {
+                  "fields": {
+                    "messagePins": {
+                      "rule": "repeated",
+                      "type": "MessagePin",
+                      "id": 1
+                    },
+                    "nextPageToken": {
+                      "type": "string",
+                      "id": 2
+                    }
+                  }
+                },
+                "CreateMessagePinRequest": {
+                  "fields": {
+                    "parent": {
+                      "type": "string",
+                      "id": 1,
+                      "options": {
+                        "(google.api.field_behavior)": "REQUIRED",
+                        "(google.api.resource_reference).type": "chat.googleapis.com/Space"
+                      }
+                    },
+                    "messagePin": {
+                      "type": "MessagePin",
+                      "id": 2,
+                      "options": {
+                        "(google.api.field_behavior)": "REQUIRED"
+                      }
+                    }
+                  }
+                },
+                "DeleteMessagePinRequest": {
+                  "fields": {
+                    "name": {
+                      "type": "string",
+                      "id": 1,
+                      "options": {
+                        "(google.api.field_behavior)": "REQUIRED",
+                        "(google.api.resource_reference).type": "chat.googleapis.com/MessagePin"
+                      }
+                    }
+                  }
+                },
                 "Section": {
                   "options": {
                     "(google.api.resource).type": "chat.googleapis.com/Section",

package/build/src/v1/chat_service_client.d.ts

@@ -1504,6 +1504,72 @@ export declare class ChatServiceClient {
     ]>;
     deleteReaction(request: protos.google.chat.v1.IDeleteReactionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteReactionRequest | null | undefined, {} | null | undefined>): void;
     deleteReaction(request: protos.google.chat.v1.IDeleteReactionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteReactionRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Creates a message pin.
+     *
+     * Requires [user
+     * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
+     * with one of the following [authorization
+     * scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
+     *
+     *   - `https://www.googleapis.com/auth/chat.spaces.pins`
+     *   - `https://www.googleapis.com/auth/chat.spaces`
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent space in which to create the message pin.
+     *   Format: spaces/{space}
+     * @param {google.chat.v1.MessagePin} request.messagePin
+     *   Required. The MessagePin to create.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.chat.v1.MessagePin|MessagePin}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/chat_service.create_message_pin.js</caption>
+     * region_tag:chat_v1_generated_ChatService_CreateMessagePin_async
+     */
+    createMessagePin(request?: protos.google.chat.v1.ICreateMessagePinRequest, options?: CallOptions): Promise<[
+        protos.google.chat.v1.IMessagePin,
+        protos.google.chat.v1.ICreateMessagePinRequest | undefined,
+        {} | undefined
+    ]>;
+    createMessagePin(request: protos.google.chat.v1.ICreateMessagePinRequest, options: CallOptions, callback: Callback<protos.google.chat.v1.IMessagePin, protos.google.chat.v1.ICreateMessagePinRequest | null | undefined, {} | null | undefined>): void;
+    createMessagePin(request: protos.google.chat.v1.ICreateMessagePinRequest, callback: Callback<protos.google.chat.v1.IMessagePin, protos.google.chat.v1.ICreateMessagePinRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Deletes a message pin.
+     *
+     * Requires [user
+     * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
+     * with one of the following [authorization
+     * scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
+     *
+     *   - `https://www.googleapis.com/auth/chat.spaces.pins`
+     *   - `https://www.googleapis.com/auth/chat.spaces`
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. The resource name of the message pin to remove.
+     *   Format: spaces/{space}/messagePins/{message_pin}
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/chat_service.delete_message_pin.js</caption>
+     * region_tag:chat_v1_generated_ChatService_DeleteMessagePin_async
+     */
+    deleteMessagePin(request?: protos.google.chat.v1.IDeleteMessagePinRequest, options?: CallOptions): Promise<[
+        protos.google.protobuf.IEmpty,
+        protos.google.chat.v1.IDeleteMessagePinRequest | undefined,
+        {} | undefined
+    ]>;
+    deleteMessagePin(request: protos.google.chat.v1.IDeleteMessagePinRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteMessagePinRequest | null | undefined, {} | null | undefined>): void;
+    deleteMessagePin(request: protos.google.chat.v1.IDeleteMessagePinRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.chat.v1.IDeleteMessagePinRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Creates a custom emoji.
      *
@@ -4801,6 +4867,125 @@ export declare class ChatServiceClient {
      * region_tag:chat_v1_generated_ChatService_ListReactions_async
      */
     listReactionsAsync(request?: protos.google.chat.v1.IListReactionsRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.IReaction>;
+    /**
+     * Lists message pins in a space. Users can pin important messages in spaces
+     * for easy access. For more information, see [Pin or unpin a conversation in
+     * Google Chat](https://support.google.com/chat/answer/15622437).
+     *
+     * Requires [user
+     * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
+     * with one of the following [authorization
+     * scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):
+     *
+     *   - `https://www.googleapis.com/auth/chat.spaces.pins.readonly`
+     *   - `https://www.googleapis.com/auth/chat.spaces.pins`
+     *   - `https://www.googleapis.com/auth/chat.spaces.readonly`
+     *   - `https://www.googleapis.com/auth/chat.spaces`
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent space which owns the collection of pinned items
+     *   Format: `spaces/{space}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of message pins returned. The service might
+     *   return fewer messages than this value. The maximum value is 100. If you use
+     *   a value more than 100, it's automatically changed to 100. If unspecified,
+     *   at most 100 message pins will be returned. Negative values return an
+     *   `INVALID_ARGUMENT` error.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token received from a previous list message pins call.
+     *   Provide this parameter 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
+     *   might lead to unexpected results.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of {@link protos.google.chat.v1.MessagePin|MessagePin}.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   Note that it can affect your quota.
+     *   We recommend using `listMessagePinsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    listMessagePins(request?: protos.google.chat.v1.IListMessagePinsRequest, options?: CallOptions): Promise<[
+        protos.google.chat.v1.IMessagePin[],
+        protos.google.chat.v1.IListMessagePinsRequest | null,
+        protos.google.chat.v1.IListMessagePinsResponse
+    ]>;
+    listMessagePins(request: protos.google.chat.v1.IListMessagePinsRequest, options: CallOptions, callback: PaginationCallback<protos.google.chat.v1.IListMessagePinsRequest, protos.google.chat.v1.IListMessagePinsResponse | null | undefined, protos.google.chat.v1.IMessagePin>): void;
+    listMessagePins(request: protos.google.chat.v1.IListMessagePinsRequest, callback: PaginationCallback<protos.google.chat.v1.IListMessagePinsRequest, protos.google.chat.v1.IListMessagePinsResponse | null | undefined, protos.google.chat.v1.IMessagePin>): void;
+    /**
+     * Equivalent to `listMessagePins`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent space which owns the collection of pinned items
+     *   Format: `spaces/{space}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of message pins returned. The service might
+     *   return fewer messages than this value. The maximum value is 100. If you use
+     *   a value more than 100, it's automatically changed to 100. If unspecified,
+     *   at most 100 message pins will be returned. Negative values return an
+     *   `INVALID_ARGUMENT` error.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token received from a previous list message pins call.
+     *   Provide this parameter 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
+     *   might lead to unexpected results.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.chat.v1.MessagePin|MessagePin} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `listMessagePinsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    listMessagePinsStream(request?: protos.google.chat.v1.IListMessagePinsRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listMessagePins`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent space which owns the collection of pinned items
+     *   Format: `spaces/{space}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of message pins returned. The service might
+     *   return fewer messages than this value. The maximum value is 100. If you use
+     *   a value more than 100, it's automatically changed to 100. If unspecified,
+     *   at most 100 message pins will be returned. Negative values return an
+     *   `INVALID_ARGUMENT` error.
+     * @param {string} [request.pageToken]
+     *   Optional. A page token received from a previous list message pins call.
+     *   Provide this parameter 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
+     *   might lead to unexpected results.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.chat.v1.MessagePin|MessagePin}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/chat_service.list_message_pins.js</caption>
+     * region_tag:chat_v1_generated_ChatService_ListMessagePins_async
+     */
+    listMessagePinsAsync(request?: protos.google.chat.v1.IListMessagePinsRequest, options?: CallOptions): AsyncIterable<protos.google.chat.v1.IMessagePin>;
     /**
      * Lists custom emojis visible to the authenticated user.
      *
@@ -5712,6 +5897,30 @@ export declare class ChatServiceClient {
      * @returns {string} A string representing the message.
      */
     matchMessageFromMessageName(messageName: string): string | number;
+    /**
+     * Return a fully-qualified messagePin resource name string.
+     *
+     * @param {string} space
+     * @param {string} message_pin
+     * @returns {string} Resource name string.
+     */
+    messagePinPath(space: string, messagePin: string): string;
+    /**
+     * Parse the space from MessagePin resource.
+     *
+     * @param {string} messagePinName
+     *   A fully-qualified path representing MessagePin resource.
+     * @returns {string} A string representing the space.
+     */
+    matchSpaceFromMessagePinName(messagePinName: string): string | number;
+    /**
+     * Parse the message_pin from MessagePin resource.
+     *
+     * @param {string} messagePinName
+     *   A fully-qualified path representing MessagePin resource.
+     * @returns {string} A string representing the message_pin.
+     */
+    matchMessagePinFromMessagePinName(messagePinName: string): string | number;
     /**
      * Return a fully-qualified quotedMessageMetadata resource name string.
      *