google-apis-fcm_v1 0.37.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f47128bcb01bc7d6b0366648a95f4d3010db13ba7d4663766a946076800f6b3
-  data.tar.gz: b0be34164823aadd689ca663e6a0d20dea0dfbe0e7ba9c21be5ee209d0e0bf88
+  metadata.gz: e12dbcd50309620c34b59e525f671a0bc116fa4eca4e92984d9c18280e2ce267
+  data.tar.gz: edbfbd11262253827aa56f62fe12702c11b9306dd756238dcf531653954bc2d2
 SHA512:
-  metadata.gz: 3d0a68426c49df20a5226543c74b2688623a335338911d5f2150fa426be9dccaf137614dafc798a0ed93ed9e525cb0d1aab68c8723bce92afdd86e761ecfa6a5
-  data.tar.gz: be709f742d58ad0c6cb1f11cb34bf2f9b2f385144fb06153808cbdf38656d27c08e2427c4272afc8167c2e080ccfd5b1e220da3fdcfce3d8d9e98379fe5ef249
+  metadata.gz: 62a9f21c5ce097be7885f43abbfb055b70de61803e233a8302b7635f3ff7104c7be303a51b04bdc33b3b08a8948fda083f8238a1ab35da0016fb714979e60d00
+  data.tar.gz: f8113555814bc5de8dbe519e1c035a6e0a3ff5525a11aa6c19d3e708ac96b20c2128f6774c30197efafa844909e583f3e9a957eee1bdb197b17153306e5829a6

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-fcm_v1
 
+### v0.38.0 (2026-09-20)
+
+* Regenerated from discovery document revision 20260911
+
 ### v0.37.0 (2026-06-28)
 
 * Regenerated from discovery document revision 20260619

data/lib/google/apis/fcm_v1/classes.rb

@@ -570,6 +570,22 @@ module Google
         end
       end
       
+      # A generic empty message that you can re-use to avoid defining duplicated empty
+      # messages in your APIs. A typical example is to use it as the request or the
+      # response type of an API method. For instance: service Foo ` rpc Bar(google.
+      # protobuf.Empty) returns (google.protobuf.Empty); `
+      class Empty
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Platform independent options for features provided by the FCM SDKs.
       class FcmOptions
         include Google::Apis::Core::Hashable
@@ -668,6 +684,32 @@ module Google
         end
       end
       
+      # Response message for ListTopicSubscriptions.
+      class ListTopicSubscriptionsResponse
+        include Google::Apis::Core::Hashable
+      
+        # A token, which can be sent as `page_token` to retrieve the next page. If this
+        # field is omitted, there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # The topic subscriptions for the instance.
+        # Corresponds to the JSON property `topicSubscriptions`
+        # @return [Array<Google::Apis::FcmV1::TopicSubscription>]
+        attr_accessor :topic_subscriptions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @topic_subscriptions = args[:topic_subscriptions] if args.key?(:topic_subscriptions)
+        end
+      end
+      
       # Message to send by Firebase Cloud Messaging Service.
       class Message
         include Google::Apis::Core::Hashable
@@ -703,7 +745,8 @@ module Google
         # @return [Google::Apis::FcmV1::FcmOptions]
         attr_accessor :fcm_options
       
-        # Firebase Installation ID to send a message to.
+        # [Firebase Installation ID (FID)](/docs/cloud-messaging/android/get-started#
+        # access-firebase-installation-id) to send a message to.
         # Corresponds to the JSON property `fid`
         # @return [String]
         attr_accessor :fid
@@ -719,9 +762,9 @@ module Google
         # @return [Google::Apis::FcmV1::Notification]
         attr_accessor :notification
       
-        # Deprecated: Use `fid` instead. Registration token to send a message to. During
-        # the transition period, this field also accepts a Firebase Installation ID (FID)
-        # .
+        # Deprecated: Use `fid` instead. During the transition period, this field also
+        # accepts a Firebase Installation ID (FID). Registration token to send a message
+        # to.
         # Corresponds to the JSON property `token`
         # @return [String]
         attr_accessor :token
@@ -819,6 +862,41 @@ module Google
         end
       end
       
+      # Represents a subscription of a single app instance to a single FCM topic.
+      class TopicSubscription
+        include Google::Apis::Core::Hashable
+      
+        # Output only. Time when the subscription was created.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Identifier. The resource name of the subscription. Format: projects/`project`/
+        # registrations/`registration`/topicSubscriptions/`topicSubscription` The `
+        # registration` part contains the registration ID (e.g., FID).
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Output only. The ID of the TopicSubscription, which is the topic name. This
+        # corresponds to the `topicSubscription` segment in the resource name. Topic
+        # names match the pattern of "[a-zA-Z0-9-_.~%]`1,900`".
+        # Corresponds to the JSON property `topicName`
+        # @return [String]
+        attr_accessor :topic_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @name = args[:name] if args.key?(:name)
+          @topic_name = args[:topic_name] if args.key?(:topic_name)
+        end
+      end
+      
       # [Webpush protocol](https://tools.ietf.org/html/rfc8030) options.
       class WebpushConfig
         include Google::Apis::Core::Hashable

data/lib/google/apis/fcm_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FcmV1
       # Version of the google-apis-fcm_v1 gem
-      GEM_VERSION = "0.37.0"
+      GEM_VERSION = "0.38.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.19.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20260619"
+      REVISION = "20260911"
     end
   end
 end

data/lib/google/apis/fcm_v1/representations.rb

@@ -58,6 +58,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Empty
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class FcmOptions
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -70,6 +76,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ListTopicSubscriptionsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Message
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -88,6 +100,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class TopicSubscription
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class WebpushConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -188,6 +206,12 @@ module Google
         end
       end
       
+      class Empty
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class FcmOptions
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -205,6 +229,15 @@ module Google
         end
       end
       
+      class ListTopicSubscriptionsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :next_page_token, as: 'nextPageToken'
+          collection :topic_subscriptions, as: 'topicSubscriptions', class: Google::Apis::FcmV1::TopicSubscription, decorator: Google::Apis::FcmV1::TopicSubscription::Representation
+      
+        end
+      end
+      
       class Message
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -245,6 +278,15 @@ module Google
         end
       end
       
+      class TopicSubscription
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :name, as: 'name'
+          property :topic_name, as: 'topicName'
+        end
+      end
+      
       class WebpushConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/fcm_v1/service.rb

@@ -52,7 +52,9 @@ module Google
           @batch_path = 'batch'
         end
         
-        # Send a message to specified target (a registration token, topic or condition).
+        # Send a message to specified target (a [Firebase Installation ID (FID)](/docs/
+        # cloud-messaging/android/get-started#access-firebase-installation-id),
+        # registration token, topic, or condition).
         # @param [String] parent
         #   Required. It contains the Firebase project id (i.e. the unique identifier for
         #   your Firebase project), in the format of `projects/`project_id``. The numeric
@@ -87,6 +89,198 @@ module Google
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
+        
+        # Creates a TopicSubscription. Subscribes an app installation instance (by
+        # registration_id, either FID or FCM Token) to a topicSubscription. Returns a
+        # TopicSubscription if it is created successfully. If the subscription already
+        # exists, returns error of ALREADY_EXISTS.
+        # @param [String] parent
+        #   Required. The parent resource where this subscription will be created. Format:
+        #   projects/`project`/registrations/`registration` The `registration` part can be
+        #   an FID or an FCM Token.
+        # @param [Google::Apis::FcmV1::TopicSubscription] topic_subscription_object
+        # @param [String] topic_name
+        #   Required. The ID to use for the subscription, which is the topic name. This
+        #   will become the last segment of the TopicSubscription's resource name. Topic
+        #   names match the pattern of "[a-zA-Z0-9-_.~%]`1,900`".
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FcmV1::TopicSubscription] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FcmV1::TopicSubscription]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def create_project_registration_topic_subscription(parent, topic_subscription_object = nil, topic_name: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+parent}/topicSubscriptions', options)
+          command.request_representation = Google::Apis::FcmV1::TopicSubscription::Representation
+          command.request_object = topic_subscription_object
+          command.response_representation = Google::Apis::FcmV1::TopicSubscription::Representation
+          command.response_class = Google::Apis::FcmV1::TopicSubscription
+          command.params['parent'] = parent unless parent.nil?
+          command.query['topicName'] = topic_name unless topic_name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Deletes a TopicSubscription.
+        # @param [String] name
+        #   Required. The name of the topic subscription to delete. Format: projects/`
+        #   project`/registrations/`registration`/topicSubscriptions/`topicSubscription`
+        # @param [Boolean] allow_missing
+        #   Optional. If set to true, and the topic subscription is not found, the request
+        #   will succeed but no action will be taken on the server.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FcmV1::Empty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FcmV1::Empty]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def delete_project_registration_topic_subscription(name, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::FcmV1::Empty::Representation
+          command.response_class = Google::Apis::FcmV1::Empty
+          command.params['name'] = name unless name.nil?
+          command.query['allowMissing'] = allow_missing unless allow_missing.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Gets a TopicSubscription.
+        # @param [String] name
+        #   Required. The name of the topic subscription to retrieve. Format: projects/`
+        #   project`/registrations/`registration`/topicSubscriptions/`topicSubscription`
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FcmV1::TopicSubscription] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FcmV1::TopicSubscription]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_registration_topic_subscription(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::FcmV1::TopicSubscription::Representation
+          command.response_class = Google::Apis::FcmV1::TopicSubscription
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists TopicSubscriptions for a given app instance.
+        # @param [String] parent
+        #   Required. The parent resource, which owns this collection of subscriptions.
+        #   Format: projects/`project`/registrations/`registration` The `registration`
+        #   part can be an FID or an FCM Token.
+        # @param [Fixnum] page_size
+        #   Optional. The maximum number of subscriptions to return. The service may
+        #   return fewer than this value. If unspecified, at most 1000 subscriptions will
+        #   be returned. The maximum value is 2000; values above 2000 will be coerced to
+        #   2000.
+        # @param [String] page_token
+        #   Optional. A page token, received from a previous `ListTopicSubscriptions` call.
+        #   Provide this to retrieve the subsequent page.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FcmV1::ListTopicSubscriptionsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FcmV1::ListTopicSubscriptionsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_registration_topic_subscriptions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/topicSubscriptions', options)
+          command.response_representation = Google::Apis::FcmV1::ListTopicSubscriptionsResponse::Representation
+          command.response_class = Google::Apis::FcmV1::ListTopicSubscriptionsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Updates a TopicSubscription. Subscribes an app installation instance by
+        # registration_id, either FID or FCM Token, to a topicSubscription. Returns an
+        # existing TopicSubscription or creates a new one if it does not exist.
+        # @param [String] name
+        #   Identifier. The resource name of the subscription. Format: projects/`project`/
+        #   registrations/`registration`/topicSubscriptions/`topicSubscription` The `
+        #   registration` part contains the registration ID (e.g., FID).
+        # @param [Google::Apis::FcmV1::TopicSubscription] topic_subscription_object
+        # @param [Boolean] allow_missing
+        #   Optional. If set to true, and the topic subscription is not found, a new topic
+        #   subscription will be created.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FcmV1::TopicSubscription] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FcmV1::TopicSubscription]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def patch_project_registration_topic_subscription(name, topic_subscription_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1/{+name}', options)
+          command.request_representation = Google::Apis::FcmV1::TopicSubscription::Representation
+          command.request_object = topic_subscription_object
+          command.response_representation = Google::Apis::FcmV1::TopicSubscription::Representation
+          command.response_class = Google::Apis::FcmV1::TopicSubscription
+          command.params['name'] = name unless name.nil?
+          command.query['allowMissing'] = allow_missing unless allow_missing.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
 
         protected
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-fcm_v1
 version: !ruby/object:Gem::Version
-  version: 0.37.0
+  version: 0.38.0
 platform: ruby
 authors:
 - Google LLC
@@ -57,7 +57,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-fcm_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-fcm_v1/v0.37.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-fcm_v1/v0.38.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-fcm_v1
 rdoc_options: []
 require_paths: