google-api-client 0.8.7 → 0.9.pre1

data/generated/google/apis/urlshortener_v1.rb

@@ -0,0 +1,34 @@
+# Copyright 2015 Google Inc.
+#
+# 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/urlshortener_v1/service.rb'
+require 'google/apis/urlshortener_v1/classes.rb'
+require 'google/apis/urlshortener_v1/representations.rb'
+
+module Google
+  module Apis
+    # URL Shortener API
+    #
+    # Lets you create, inspect, and manage goo.gl short URLs
+    #
+    # @see https://developers.google.com/url-shortener/v1/getting_started
+    module UrlshortenerV1
+      VERSION = 'V1'
+      REVISION = '20150519'
+
+      # Manage your goo.gl short URLs
+      AUTH_URLSHORTENER = 'https://www.googleapis.com/auth/urlshortener'
+    end
+  end
+end

data/generated/google/apis/urlshortener_v1/classes.rb

@@ -0,0 +1,246 @@
+# Copyright 2015 Google Inc.
+#
+# 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 UrlshortenerV1
+      
+      # 
+      class AnalyticsSnapshot
+        include Google::Apis::Core::Hashable
+      
+        # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present
+        # if this data is available.
+        # Corresponds to the JSON property `browsers`
+        # @return [Array<Google::Apis::UrlshortenerV1::StringCount>]
+        attr_accessor :browsers
+      
+        # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (
+        # descending) click counts. Only present if this data is available.
+        # Corresponds to the JSON property `countries`
+        # @return [Array<Google::Apis::UrlshortenerV1::StringCount>]
+        attr_accessor :countries
+      
+        # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        # Corresponds to the JSON property `longUrlClicks`
+        # @return [String]
+        attr_accessor :long_url_clicks
+      
+        # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts.
+        # Only present if this data is available.
+        # Corresponds to the JSON property `platforms`
+        # @return [Array<Google::Apis::UrlshortenerV1::StringCount>]
+        attr_accessor :platforms
+      
+        # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click
+        # counts. Only present if this data is available.
+        # Corresponds to the JSON property `referrers`
+        # @return [Array<Google::Apis::UrlshortenerV1::StringCount>]
+        attr_accessor :referrers
+      
+        # Number of clicks on this short URL.
+        # Corresponds to the JSON property `shortUrlClicks`
+        # @return [String]
+        attr_accessor :short_url_clicks
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @browsers = args[:browsers] unless args[:browsers].nil?
+          @countries = args[:countries] unless args[:countries].nil?
+          @long_url_clicks = args[:long_url_clicks] unless args[:long_url_clicks].nil?
+          @platforms = args[:platforms] unless args[:platforms].nil?
+          @referrers = args[:referrers] unless args[:referrers].nil?
+          @short_url_clicks = args[:short_url_clicks] unless args[:short_url_clicks].nil?
+        end
+      end
+      
+      # 
+      class AnalyticsSummary
+        include Google::Apis::Core::Hashable
+      
+        # Click analytics over all time.
+        # Corresponds to the JSON property `allTime`
+        # @return [Google::Apis::UrlshortenerV1::AnalyticsSnapshot]
+        attr_accessor :all_time
+      
+        # Click analytics over the last day.
+        # Corresponds to the JSON property `day`
+        # @return [Google::Apis::UrlshortenerV1::AnalyticsSnapshot]
+        attr_accessor :day
+      
+        # Click analytics over the last month.
+        # Corresponds to the JSON property `month`
+        # @return [Google::Apis::UrlshortenerV1::AnalyticsSnapshot]
+        attr_accessor :month
+      
+        # Click analytics over the last two hours.
+        # Corresponds to the JSON property `twoHours`
+        # @return [Google::Apis::UrlshortenerV1::AnalyticsSnapshot]
+        attr_accessor :two_hours
+      
+        # Click analytics over the last week.
+        # Corresponds to the JSON property `week`
+        # @return [Google::Apis::UrlshortenerV1::AnalyticsSnapshot]
+        attr_accessor :week
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @all_time = args[:all_time] unless args[:all_time].nil?
+          @day = args[:day] unless args[:day].nil?
+          @month = args[:month] unless args[:month].nil?
+          @two_hours = args[:two_hours] unless args[:two_hours].nil?
+          @week = args[:week] unless args[:week].nil?
+        end
+      end
+      
+      # 
+      class StringCount
+        include Google::Apis::Core::Hashable
+      
+        # Number of clicks for this top entry, e.g. for this particular country or
+        # browser.
+        # Corresponds to the JSON property `count`
+        # @return [String]
+        attr_accessor :count
+      
+        # Label assigned to this top entry, e.g. "US" or "Chrome".
+        # Corresponds to the JSON property `id`
+        # @return [String]
+        attr_accessor :id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @count = args[:count] unless args[:count].nil?
+          @id = args[:id] unless args[:id].nil?
+        end
+      end
+      
+      # 
+      class Url
+        include Google::Apis::Core::Hashable
+      
+        # A summary of the click analytics for the short and long URL. Might not be
+        # present if not requested or currently unavailable.
+        # Corresponds to the JSON property `analytics`
+        # @return [Google::Apis::UrlshortenerV1::AnalyticsSummary]
+        attr_accessor :analytics
+      
+        # Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'
+        # HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00".
+        # Corresponds to the JSON property `created`
+        # @return [String]
+        attr_accessor :created
+      
+        # Short URL, e.g. "http://goo.gl/l6MS".
+        # Corresponds to the JSON property `id`
+        # @return [String]
+        attr_accessor :id
+      
+        # The fixed string "urlshortener#url".
+        # Corresponds to the JSON property `kind`
+        # @return [String]
+        attr_accessor :kind
+      
+        # Long URL, e.g. "http://www.google.com/". Might not be present if the status is
+        # "REMOVED".
+        # Corresponds to the JSON property `longUrl`
+        # @return [String]
+        attr_accessor :long_url
+      
+        # Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "
+        # REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for
+        # example.
+        # Corresponds to the JSON property `status`
+        # @return [String]
+        attr_accessor :status
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @analytics = args[:analytics] unless args[:analytics].nil?
+          @created = args[:created] unless args[:created].nil?
+          @id = args[:id] unless args[:id].nil?
+          @kind = args[:kind] unless args[:kind].nil?
+          @long_url = args[:long_url] unless args[:long_url].nil?
+          @status = args[:status] unless args[:status].nil?
+        end
+      end
+      
+      # 
+      class UrlHistory
+        include Google::Apis::Core::Hashable
+      
+        # A list of URL resources.
+        # Corresponds to the JSON property `items`
+        # @return [Array<Google::Apis::UrlshortenerV1::Url>]
+        attr_accessor :items
+      
+        # Number of items returned with each full "page" of results. Note that the last
+        # page could have fewer items than the "itemsPerPage" value.
+        # Corresponds to the JSON property `itemsPerPage`
+        # @return [Fixnum]
+        attr_accessor :items_per_page
+      
+        # The fixed string "urlshortener#urlHistory".
+        # Corresponds to the JSON property `kind`
+        # @return [String]
+        attr_accessor :kind
+      
+        # A token to provide to get the next page of results.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # Total number of short URLs associated with this user (may be approximate).
+        # Corresponds to the JSON property `totalItems`
+        # @return [Fixnum]
+        attr_accessor :total_items
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @items = args[:items] unless args[:items].nil?
+          @items_per_page = args[:items_per_page] unless args[:items_per_page].nil?
+          @kind = args[:kind] unless args[:kind].nil?
+          @next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
+          @total_items = args[:total_items] unless args[:total_items].nil?
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/urlshortener_v1/representations.rb

@@ -0,0 +1,111 @@
+# Copyright 2015 Google Inc.
+#
+# 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 UrlshortenerV1
+      
+      class AnalyticsSnapshot
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      end
+      
+      class AnalyticsSummary
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      end
+      
+      class StringCount
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      end
+      
+      class Url
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      end
+      
+      class UrlHistory
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      end
+      
+      class AnalyticsSnapshot
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :browsers, as: 'browsers', class: Google::Apis::UrlshortenerV1::StringCount, decorator: Google::Apis::UrlshortenerV1::StringCount::Representation
+      
+          collection :countries, as: 'countries', class: Google::Apis::UrlshortenerV1::StringCount, decorator: Google::Apis::UrlshortenerV1::StringCount::Representation
+      
+          property :long_url_clicks, as: 'longUrlClicks'
+          collection :platforms, as: 'platforms', class: Google::Apis::UrlshortenerV1::StringCount, decorator: Google::Apis::UrlshortenerV1::StringCount::Representation
+      
+          collection :referrers, as: 'referrers', class: Google::Apis::UrlshortenerV1::StringCount, decorator: Google::Apis::UrlshortenerV1::StringCount::Representation
+      
+          property :short_url_clicks, as: 'shortUrlClicks'
+        end
+      end
+      
+      class AnalyticsSummary
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :all_time, as: 'allTime', class: Google::Apis::UrlshortenerV1::AnalyticsSnapshot, decorator: Google::Apis::UrlshortenerV1::AnalyticsSnapshot::Representation
+      
+          property :day, as: 'day', class: Google::Apis::UrlshortenerV1::AnalyticsSnapshot, decorator: Google::Apis::UrlshortenerV1::AnalyticsSnapshot::Representation
+      
+          property :month, as: 'month', class: Google::Apis::UrlshortenerV1::AnalyticsSnapshot, decorator: Google::Apis::UrlshortenerV1::AnalyticsSnapshot::Representation
+      
+          property :two_hours, as: 'twoHours', class: Google::Apis::UrlshortenerV1::AnalyticsSnapshot, decorator: Google::Apis::UrlshortenerV1::AnalyticsSnapshot::Representation
+      
+          property :week, as: 'week', class: Google::Apis::UrlshortenerV1::AnalyticsSnapshot, decorator: Google::Apis::UrlshortenerV1::AnalyticsSnapshot::Representation
+      
+        end
+      end
+      
+      class StringCount
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :count, as: 'count'
+          property :id, as: 'id'
+        end
+      end
+      
+      class Url
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :analytics, as: 'analytics', class: Google::Apis::UrlshortenerV1::AnalyticsSummary, decorator: Google::Apis::UrlshortenerV1::AnalyticsSummary::Representation
+      
+          property :created, as: 'created'
+          property :id, as: 'id'
+          property :kind, as: 'kind'
+          property :long_url, as: 'longUrl'
+          property :status, as: 'status'
+        end
+      end
+      
+      class UrlHistory
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :items, as: 'items', class: Google::Apis::UrlshortenerV1::Url, decorator: Google::Apis::UrlshortenerV1::Url::Representation
+      
+          property :items_per_page, as: 'itemsPerPage'
+          property :kind, as: 'kind'
+          property :next_page_token, as: 'nextPageToken'
+          property :total_items, as: 'totalItems'
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/urlshortener_v1/service.rb

@@ -0,0 +1,179 @@
+# Copyright 2015 Google Inc.
+#
+# 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 UrlshortenerV1
+      # URL Shortener API
+      #
+      # Lets you create, inspect, and manage goo.gl short URLs
+      #
+      # @example
+      #    require 'google/apis/urlshortener_v1'
+      #
+      #    Urlshortener = Google::Apis::UrlshortenerV1 # Alias the module
+      #    service = Urlshortener::UrlshortenerService.new
+      #
+      # @see https://developers.google.com/url-shortener/v1/getting_started
+      class UrlshortenerService < 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.
+        #  Overrides userIp if both are provided.
+        attr_accessor :quota_user
+
+        # @return [String]
+        #  IP address of the site where the request originates. Use this if you want to
+        #  enforce per-user limits.
+        attr_accessor :user_ip
+
+        def initialize
+          super('https://www.googleapis.com/', 'urlshortener/v1/')
+        end
+        
+        # Expands a short URL or gets creation time and analytics.
+        # @param [String] projection
+        #   Additional information to return.
+        # @param [String] short_url
+        #   The short URL, including the protocol.
+        # @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.
+        #   Overrides userIp if both are provided.
+        # @param [String] user_ip
+        #   IP address of the site where the request originates. Use this if you want to
+        #   enforce per-user limits.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::UrlshortenerV1::Url] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::UrlshortenerV1::Url]
+        #
+        # @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_url(projection: nil, short_url: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          path = 'url'
+          command =  make_simple_command(:get, path, options)
+          command.response_representation = Google::Apis::UrlshortenerV1::Url::Representation
+          command.response_class = Google::Apis::UrlshortenerV1::Url
+          command.query['projection'] = projection unless projection.nil?
+          command.query['shortUrl'] = short_url unless short_url.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Creates a new short URL.
+        # @param [Google::Apis::UrlshortenerV1::Url] url_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.
+        #   Overrides userIp if both are provided.
+        # @param [String] user_ip
+        #   IP address of the site where the request originates. Use this if you want to
+        #   enforce per-user limits.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::UrlshortenerV1::Url] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::UrlshortenerV1::Url]
+        #
+        # @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 insert_url(url_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          path = 'url'
+          command =  make_simple_command(:post, path, options)
+          command.request_representation = Google::Apis::UrlshortenerV1::Url::Representation
+          command.request_object = url_object
+          command.response_representation = Google::Apis::UrlshortenerV1::Url::Representation
+          command.response_class = Google::Apis::UrlshortenerV1::Url
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Retrieves a list of URLs shortened by a user.
+        # @param [String] projection
+        #   Additional information to return.
+        # @param [String] start_token
+        #   Token for requesting successive pages of results.
+        # @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.
+        #   Overrides userIp if both are provided.
+        # @param [String] user_ip
+        #   IP address of the site where the request originates. Use this if you want to
+        #   enforce per-user limits.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::UrlshortenerV1::UrlHistory] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::UrlshortenerV1::UrlHistory]
+        #
+        # @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_urls(projection: nil, start_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          path = 'url/history'
+          command =  make_simple_command(:get, path, options)
+          command.response_representation = Google::Apis::UrlshortenerV1::UrlHistory::Representation
+          command.response_class = Google::Apis::UrlshortenerV1::UrlHistory
+          command.query['projection'] = projection unless projection.nil?
+          command.query['start-token'] = start_token unless start_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['userIp'] = user_ip unless user_ip.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?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+        end
+      end
+    end
+  end
+end