google-apis-fcm_v1 0.1.0

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

@@ -0,0 +1,28 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Apis
+    module FcmV1
+      # Version of the google-apis-fcm_v1 gem
+      GEM_VERSION = "0.1.0"
+
+      # Version of the code generator used to generate this client
+      GENERATOR_VERSION = "0.1.1"
+
+      # Revision of the discovery document this client was generated from
+      REVISION = "20200720"
+    end
+  end
+end

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

@@ -0,0 +1,262 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module FcmV1
+      
+      class AndroidConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class AndroidFcmOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class AndroidNotification
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ApnsConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ApnsFcmOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Color
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class FcmOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class LightSettings
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Message
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Notification
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class SendMessageRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class WebpushConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class WebpushFcmOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class AndroidConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :collapse_key, as: 'collapseKey'
+          hash :data, as: 'data'
+          property :direct_boot_ok, as: 'directBootOk'
+          property :fcm_options, as: 'fcmOptions', class: Google::Apis::FcmV1::AndroidFcmOptions, decorator: Google::Apis::FcmV1::AndroidFcmOptions::Representation
+      
+          property :notification, as: 'notification', class: Google::Apis::FcmV1::AndroidNotification, decorator: Google::Apis::FcmV1::AndroidNotification::Representation
+      
+          property :priority, as: 'priority'
+          property :restricted_package_name, as: 'restrictedPackageName'
+          property :ttl, as: 'ttl'
+        end
+      end
+      
+      class AndroidFcmOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :analytics_label, as: 'analyticsLabel'
+        end
+      end
+      
+      class AndroidNotification
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :body, as: 'body'
+          collection :body_loc_args, as: 'bodyLocArgs'
+          property :body_loc_key, as: 'bodyLocKey'
+          property :channel_id, as: 'channelId'
+          property :click_action, as: 'clickAction'
+          property :color, as: 'color'
+          property :default_light_settings, as: 'defaultLightSettings'
+          property :default_sound, as: 'defaultSound'
+          property :default_vibrate_timings, as: 'defaultVibrateTimings'
+          property :event_time, as: 'eventTime'
+          property :icon, as: 'icon'
+          property :image, as: 'image'
+          property :light_settings, as: 'lightSettings', class: Google::Apis::FcmV1::LightSettings, decorator: Google::Apis::FcmV1::LightSettings::Representation
+      
+          property :local_only, as: 'localOnly'
+          property :notification_count, as: 'notificationCount'
+          property :notification_priority, as: 'notificationPriority'
+          property :sound, as: 'sound'
+          property :sticky, as: 'sticky'
+          property :tag, as: 'tag'
+          property :ticker, as: 'ticker'
+          property :title, as: 'title'
+          collection :title_loc_args, as: 'titleLocArgs'
+          property :title_loc_key, as: 'titleLocKey'
+          collection :vibrate_timings, as: 'vibrateTimings'
+          property :visibility, as: 'visibility'
+        end
+      end
+      
+      class ApnsConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :fcm_options, as: 'fcmOptions', class: Google::Apis::FcmV1::ApnsFcmOptions, decorator: Google::Apis::FcmV1::ApnsFcmOptions::Representation
+      
+          hash :headers, as: 'headers'
+          hash :payload, as: 'payload'
+        end
+      end
+      
+      class ApnsFcmOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :analytics_label, as: 'analyticsLabel'
+          property :image, as: 'image'
+        end
+      end
+      
+      class Color
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :alpha, as: 'alpha'
+          property :blue, as: 'blue'
+          property :green, as: 'green'
+          property :red, as: 'red'
+        end
+      end
+      
+      class FcmOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :analytics_label, as: 'analyticsLabel'
+        end
+      end
+      
+      class LightSettings
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :color, as: 'color', class: Google::Apis::FcmV1::Color, decorator: Google::Apis::FcmV1::Color::Representation
+      
+          property :light_off_duration, as: 'lightOffDuration'
+          property :light_on_duration, as: 'lightOnDuration'
+        end
+      end
+      
+      class Message
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :android, as: 'android', class: Google::Apis::FcmV1::AndroidConfig, decorator: Google::Apis::FcmV1::AndroidConfig::Representation
+      
+          property :apns, as: 'apns', class: Google::Apis::FcmV1::ApnsConfig, decorator: Google::Apis::FcmV1::ApnsConfig::Representation
+      
+          property :condition, as: 'condition'
+          hash :data, as: 'data'
+          property :fcm_options, as: 'fcmOptions', class: Google::Apis::FcmV1::FcmOptions, decorator: Google::Apis::FcmV1::FcmOptions::Representation
+      
+          property :name, as: 'name'
+          property :notification, as: 'notification', class: Google::Apis::FcmV1::Notification, decorator: Google::Apis::FcmV1::Notification::Representation
+      
+          property :token, as: 'token'
+          property :topic, as: 'topic'
+          property :webpush, as: 'webpush', class: Google::Apis::FcmV1::WebpushConfig, decorator: Google::Apis::FcmV1::WebpushConfig::Representation
+      
+        end
+      end
+      
+      class Notification
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :body, as: 'body'
+          property :image, as: 'image'
+          property :title, as: 'title'
+        end
+      end
+      
+      class SendMessageRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :message, as: 'message', class: Google::Apis::FcmV1::Message, decorator: Google::Apis::FcmV1::Message::Representation
+      
+          property :validate_only, as: 'validateOnly'
+        end
+      end
+      
+      class WebpushConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :data, as: 'data'
+          property :fcm_options, as: 'fcmOptions', class: Google::Apis::FcmV1::WebpushFcmOptions, decorator: Google::Apis::FcmV1::WebpushFcmOptions::Representation
+      
+          hash :headers, as: 'headers'
+          hash :notification, as: 'notification'
+        end
+      end
+      
+      class WebpushFcmOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :analytics_label, as: 'analyticsLabel'
+          property :link, as: 'link'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module FcmV1
+      # Firebase Cloud Messaging API
+      #
+      # FCM send API that provides a cross-platform messaging solution to reliably
+      #  deliver messages at no cost.
+      #
+      # @example
+      #    require 'google/apis/fcm_v1'
+      #
+      #    Fcm = Google::Apis::FcmV1 # Alias the module
+      #    service = Fcm::FirebaseCloudMessagingService.new
+      #
+      # @see https://firebase.google.com/docs/cloud-messaging
+      class FirebaseCloudMessagingService < Google::Apis::Core::BaseService
+        # @return [String]
+        #  API key. Your API key identifies your project and provides you with API access,
+        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
+        attr_accessor :key
+
+        # @return [String]
+        #  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.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://fcm.googleapis.com/', '',
+                client_name: 'google-apis-fcm_v1',
+                client_version: Google::Apis::FcmV1::GEM_VERSION)
+          @batch_path = 'batch'
+        end
+        
+        # Send a message to specified target (a 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``. For legacy
+        #   support, the numeric project number with no padding is also supported in the
+        #   format of `projects/`project_number``.
+        # @param [Google::Apis::FcmV1::SendMessageRequest] send_message_request_object
+        # @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::Message] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FcmV1::Message]
+        #
+        # @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 send_message(parent, send_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+parent}/messages:send', options)
+          command.request_representation = Google::Apis::FcmV1::SendMessageRequest::Representation
+          command.request_object = send_message_request_object
+          command.response_representation = Google::Apis::FcmV1::Message::Representation
+          command.response_class = Google::Apis::FcmV1::Message
+          command.params['parent'] = parent unless parent.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
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: google-apis-fcm_v1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Google LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-apis-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: This is the simple REST client for Firebase Cloud Messaging API V1. Simple
+  REST clients are Ruby client libraries that provide access to Google services via
+  their HTTP REST API endpoints. These libraries are generated and updated automatically
+  based on the discovery documents published by the service, and they handle most
+  concerns such as authentication, pagination, retry, timeouts, and logging. You can
+  use this client to access the Firebase Cloud Messaging API, but note that some services
+  may provide a separate modern client that is easier to use.
+email: googleapis-packages@google.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.md
+- OVERVIEW.md
+- lib/google-apis-fcm_v1.rb
+- lib/google/apis/fcm_v1.rb
+- lib/google/apis/fcm_v1/classes.rb
+- lib/google/apis/fcm_v1/gem_version.rb
+- lib/google/apis/fcm_v1/representations.rb
+- lib/google/apis/fcm_v1/service.rb
+homepage: https://github.com/google/google-api-ruby-client
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
+  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-fcm_v1/CHANGELOG.md
+  documentation_uri: https://googleapis.dev/ruby/google-apis-fcm_v1/v0.1.0
+  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-fcm_v1
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Simple REST client for Firebase Cloud Messaging API V1
+test_files: []