@google-apps/chat 0.31.0 → 0.32.0

package/build/src/v1/chat_service_client.js

@@ -172,6 +172,7 @@ class ChatServiceClient {
             customEmojiPathTemplate: new this._gaxModule.PathTemplate('customEmojis/{custom_emoji}'),
             membershipPathTemplate: new this._gaxModule.PathTemplate('spaces/{space}/members/{member}'),
             messagePathTemplate: new this._gaxModule.PathTemplate('spaces/{space}/messages/{message}'),
+            messagePinPathTemplate: new this._gaxModule.PathTemplate('spaces/{space}/messagePins/{message_pin}'),
             quotedMessageMetadataPathTemplate: new this._gaxModule.PathTemplate('spaces/{space}/messages/{message}/quotedMessageMetadata/{quoted_message_metadata}'),
             reactionPathTemplate: new this._gaxModule.PathTemplate('spaces/{space}/messages/{message}/reactions/{reaction}'),
             sectionPathTemplate: new this._gaxModule.PathTemplate('users/{user}/sections/{section}'),
@@ -194,6 +195,7 @@ class ChatServiceClient {
             searchSpaces: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'spaces'),
             findGroupChats: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'spaces'),
             listReactions: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'reactions'),
+            listMessagePins: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'messagePins'),
             listCustomEmojis: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'customEmojis'),
             listSpaceEvents: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'spaceEvents'),
             listSections: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'sections'),
@@ -259,6 +261,9 @@ class ChatServiceClient {
             'createReaction',
             'listReactions',
             'deleteReaction',
+            'listMessagePins',
+            'createMessagePin',
+            'deleteMessagePin',
             'createCustomEmoji',
             'getCustomEmoji',
             'listCustomEmojis',
@@ -378,6 +383,8 @@ class ChatServiceClient {
             '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',
@@ -1204,6 +1211,92 @@ class ChatServiceClient {
             throw error;
         });
     }
+    createMessagePin(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: request.parent ?? '',
+            });
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('createMessagePin request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('createMessagePin response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .createMessagePin(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('createMessagePin response %j', response);
+            return [response, options, rawResponse];
+        })
+            .catch((error) => {
+            if (error &&
+                'statusDetails' in error &&
+                error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
+        });
+    }
+    deleteMessagePin(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                name: request.name ?? '',
+            });
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('deleteMessagePin request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('deleteMessagePin response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .deleteMessagePin(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('deleteMessagePin response %j', response);
+            return [response, options, rawResponse];
+        })
+            .catch((error) => {
+            if (error &&
+                'statusDetails' in error &&
+                error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
+        });
+    }
     createCustomEmoji(request, optionsOrCallback, callback) {
         request = request || {};
         let options;
@@ -3940,6 +4033,139 @@ class ChatServiceClient {
         this._log.info('listReactions iterate %j', request);
         return this.descriptors.page.listReactions.asyncIterate(this.innerApiCalls['listReactions'], request, callSettings);
     }
+    listMessagePins(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: request.parent ?? '',
+            });
+        this.initialize().catch(err => {
+            throw err;
+        });
+        const wrappedCallback = callback
+            ? (error, values, nextPageRequest, rawResponse) => {
+                this._log.info('listMessagePins values %j', values);
+                callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        this._log.info('listMessagePins request %j', request);
+        return this.innerApiCalls
+            .listMessagePins(request, options, wrappedCallback)
+            ?.then(([response, input, output]) => {
+            this._log.info('listMessagePins values %j', response);
+            return [response, input, output];
+        });
+    }
+    /**
+     * 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, options) {
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: request.parent ?? '',
+            });
+        const defaultCallSettings = this._defaults['listMessagePins'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('listMessagePins stream %j', request);
+        return this.descriptors.page.listMessagePins.createStream(this.innerApiCalls.listMessagePins, request, callSettings);
+    }
+    /**
+     * 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, options) {
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: request.parent ?? '',
+            });
+        const defaultCallSettings = this._defaults['listMessagePins'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('listMessagePins iterate %j', request);
+        return this.descriptors.page.listMessagePins.asyncIterate(this.innerApiCalls['listMessagePins'], request, callSettings);
+    }
     listCustomEmojis(request, optionsOrCallback, callback) {
         request = request || {};
         let options;
@@ -4819,6 +5045,41 @@ class ChatServiceClient {
     matchMessageFromMessageName(messageName) {
         return this.pathTemplates.messagePathTemplate.match(messageName).message;
     }
+    /**
+     * Return a fully-qualified messagePin resource name string.
+     *
+     * @param {string} space
+     * @param {string} message_pin
+     * @returns {string} Resource name string.
+     */
+    messagePinPath(space, messagePin) {
+        return this.pathTemplates.messagePinPathTemplate.render({
+            space: space,
+            message_pin: messagePin,
+        });
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.messagePinPathTemplate.match(messagePinName)
+            .space;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.messagePinPathTemplate.match(messagePinName)
+            .message_pin;
+    }
     /**
      * Return a fully-qualified quotedMessageMetadata resource name string.
      *