algolia 3.0.0.alpha.14 → 3.0.0.alpha.16

data/lib/algolia/models/analytics/top_searches_response.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class TopSearchesResponse
-      # Top searches with their hits count.
+      # Most popular searches and their number of search results (hits).
       attr_accessor :searches
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class TopSearchesResponseWithAnalytics
-      # Top searches with their hits count and analytics.
+      # Most popular searches and their associated click and conversion metrics.
       attr_accessor :searches
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb

@@ -0,0 +1,201 @@
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require 'date'
+require 'time'
+
+module Algolia
+  module Analytics
+    class TopSearchesResponseWithRevenueAnalytics
+      # Most popular searches, including their click and revenue metrics.
+      attr_accessor :searches
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :searches => :searches
+        }
+      end
+
+      # Returns all the JSON keys this model knows about
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :searches => :'Array<TopSearchWithRevenueAnalytics>'
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([])
+      end
+
+      # Initializes the object
+      # @param [Hash] attributes Model attributes in the form of hash
+      def initialize(attributes = {})
+        unless attributes.is_a?(Hash)
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::TopSearchesResponseWithRevenueAnalytics` initialize method"
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) do |(k, v), h|
+          unless self.class.attribute_map.key?(k.to_sym)
+            raise ArgumentError,
+                  "`#{k}` is not a valid attribute in `Algolia::TopSearchesResponseWithRevenueAnalytics`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          end
+
+          h[k.to_sym] = v
+        end
+
+        if attributes.key?(:searches)
+          if (value = attributes[:searches]).is_a?(Array)
+            self.searches = value
+          end
+        else
+          self.searches = nil
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          searches == other.searches
+      end
+
+      # @see the `==` method
+      # @param [Object] Object to be compared
+      def eql?(other)
+        self == other
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Integer] Hash code
+      def hash
+        [searches].hash
+      end
+
+      # Builds the object from hash
+      # @param [Hash] attributes Model attributes in the form of hash
+      # @return [Object] Returns the model itself
+      def self.build_from_hash(attributes)
+        return nil unless attributes.is_a?(Hash)
+
+        attributes = attributes.transform_keys(&:to_sym)
+        transformed_hash = {}
+        types_mapping.each_pair do |key, type|
+          if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = nil
+          elsif type =~ /\AArray<(.*)>/i
+            # check to ensure the input is an array given that the attribute
+            # is documented as an array but the input is not
+            if attributes[attribute_map[key]].is_a?(Array)
+              transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
+            end
+          elsif !attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
+          end
+        end
+        new(transformed_hash)
+      end
+
+      # Deserializes the data based on type
+      # @param string type Data type
+      # @param string value Value to be deserialized
+      # @return [Object] Deserialized data
+      def self._deserialize(type, value)
+        case type.to_sym
+        when :Time
+          Time.parse(value)
+        when :Date
+          Date.parse(value)
+        when :String
+          value.to_s
+        when :Integer
+          value.to_i
+        when :Float
+          value.to_f
+        when :Boolean
+          if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+            true
+          else
+            false
+          end
+        when :Object
+          # generic object (usually a Hash), return directly
+          value
+        when /\AArray<(?<inner_type>.+)>\z/
+          inner_type = Regexp.last_match[:inner_type]
+          value.map { |v| _deserialize(inner_type, v) }
+        when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+          k_type = Regexp.last_match[:k_type]
+          v_type = Regexp.last_match[:v_type]
+          {}.tap do |hash|
+            value.each do |k, v|
+              hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+            end
+          end
+        else # model
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::Analytics.const_get(type)
+          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        end
+      end
+
+      # Returns the string representation of the object
+      # @return [String] String presentation of the object
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility)
+      # @return [Hash] Returns the object in the form of hash
+      def to_body
+        to_hash
+      end
+
+      def to_json(*_args)
+        to_hash.to_json
+      end
+
+      # Returns the object in the form of hash
+      # @return [Hash] Returns the object in the form of hash
+      def to_hash
+        hash = {}
+        self.class.attribute_map.each_pair do |attr, param|
+          value = send(attr)
+          if value.nil?
+            is_nullable = self.class.openapi_nullable.include?(attr)
+            next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+          end
+
+          hash[param] = _to_hash(value)
+        end
+        hash
+      end
+
+      # Outputs non-array value in the form of hash
+      # For object, use to_hash. Otherwise, just return the value
+      # @param [Object] value Any valid value
+      # @return [Hash] Returns the value in the form of hash
+      def _to_hash(value)
+        if value.is_a?(Array)
+          value.compact.map { |v| _to_hash(v) }
+        elsif value.is_a?(Hash)
+          {}.tap do |hash|
+            value.each { |k, v| hash[k] = _to_hash(v) }
+          end
+        elsif value.respond_to? :to_hash
+          value.to_hash
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/algolia/models/ingestion/auth_algolia.rb

@@ -5,11 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
+    # Credentials for authenticating with Algolia.
     class AuthAlgolia
-      # Algolia Application ID.
+      # Algolia application ID.
       attr_accessor :app_id
 
-      # Algolia API Key, with the correct rights to push to an index and change settings.
+      # Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response.
       attr_accessor :api_key
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/auth_algolia_partial.rb

@@ -5,11 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
+    # Credentials for authenticating with Algolia.
     class AuthAlgoliaPartial
-      # Algolia Application ID.
+      # Algolia application ID.
       attr_accessor :app_id
 
-      # Algolia API Key, with the correct rights to push to an index and change settings.
+      # Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response.
       attr_accessor :api_key
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/auth_api_key.rb

@@ -5,8 +5,9 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Authentication input used for token credentials.
+    # Credentials for authenticating with an API key.
     class AuthAPIKey
+      # API key. This field is `null` in the API response.
       attr_accessor :key
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/auth_api_key_partial.rb

@@ -5,8 +5,9 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Authentication input used for token credentials.
+    # Credentials for authenticating with an API key.
     class AuthAPIKeyPartial
+      # API key. This field is `null` in the API response.
       attr_accessor :key
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/auth_basic.rb

@@ -5,10 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Authentication input for Basic login with username and password.
+    # Credentials for authenticating with user name and password.
     class AuthBasic
+      # Username.
       attr_accessor :username
 
+      # Password. This field is `null` in the API response.
       attr_accessor :password
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/auth_basic_partial.rb

@@ -5,10 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Authentication input for Basic login with username and password.
+    # Credentials for authenticating with user name and password.
     class AuthBasicPartial
+      # Username.
       attr_accessor :username
 
+      # Password. This field is `null` in the API response.
       attr_accessor :password
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/auth_google_service_account.rb

@@ -5,12 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Authentication input to connect to a Google service (e.g. BigQuery).
+    # Credentials for authenticating with a Google service account, such as BigQuery.
     class AuthGoogleServiceAccount
-      # Email address of the Service Account.
+      # Email address of the Google service account.
       attr_accessor :client_email
 
-      # Private key of the Service Account.
+      # Private key of the Google service account. This field is `null` in the API response.
       attr_accessor :private_key
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb

@@ -5,12 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Authentication input to connect to a Google service (e.g. BigQuery).
+    # Credentials for authenticating with a Google service account, such as BigQuery.
     class AuthGoogleServiceAccountPartial
-      # Email address of the Service Account.
+      # Email address of the Google service account.
       attr_accessor :client_email
 
-      # Private key of the Service Account.
+      # Private key of the Google service account. This field is `null` in the API response.
       attr_accessor :private_key
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/auth_o_auth.rb

@@ -5,23 +5,27 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Authentication input for OAuth login.
+    # Credentials for authenticating with OAuth 2.0.
     class AuthOAuth
-      # The OAuth endpoint URL.
+      # URL for the OAuth endpoint.
       attr_accessor :url
 
-      # The clientID.
+      # Client ID.
       attr_accessor :client_id
 
-      # The secret.
+      # Client secret. This field is `null` in the API response.
       attr_accessor :client_secret
 
+      # OAuth scope.
+      attr_accessor :scope
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :url => :url,
           :client_id => :client_id,
-          :client_secret => :client_secret
+          :client_secret => :client_secret,
+          :scope => :scope
         }
       end
 
@@ -35,7 +39,8 @@ module Algolia
         {
           :url => :String,
           :client_id => :String,
-          :client_secret => :String
+          :client_secret => :String,
+          :scope => :String
         }
       end
 
@@ -78,6 +83,10 @@ module Algolia
         else
           self.client_secret = nil
         end
+
+        if attributes.key?(:scope)
+          self.scope = attributes[:scope]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -88,7 +97,8 @@ module Algolia
         self.class == other.class &&
           url == other.url &&
           client_id == other.client_id &&
-          client_secret == other.client_secret
+          client_secret == other.client_secret &&
+          scope == other.scope
       end
 
       # @see the `==` method
@@ -100,7 +110,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [url, client_id, client_secret].hash
+        [url, client_id, client_secret, scope].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/auth_o_auth_partial.rb

@@ -5,23 +5,27 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Authentication input for OAuth login.
+    # Credentials for authenticating with OAuth 2.0.
     class AuthOAuthPartial
-      # The OAuth endpoint URL.
+      # URL for the OAuth endpoint.
       attr_accessor :url
 
-      # The clientID.
+      # Client ID.
       attr_accessor :client_id
 
-      # The secret.
+      # Client secret. This field is `null` in the API response.
       attr_accessor :client_secret
 
+      # OAuth scope.
+      attr_accessor :scope
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :url => :url,
           :client_id => :client_id,
-          :client_secret => :client_secret
+          :client_secret => :client_secret,
+          :scope => :scope
         }
       end
 
@@ -35,7 +39,8 @@ module Algolia
         {
           :url => :String,
           :client_id => :String,
-          :client_secret => :String
+          :client_secret => :String,
+          :scope => :String
         }
       end
 
@@ -72,6 +77,10 @@ module Algolia
         if attributes.key?(:client_secret)
           self.client_secret = attributes[:client_secret]
         end
+
+        if attributes.key?(:scope)
+          self.scope = attributes[:scope]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -82,7 +91,8 @@ module Algolia
         self.class == other.class &&
           url == other.url &&
           client_id == other.client_id &&
-          client_secret == other.client_secret
+          client_secret == other.client_secret &&
+          scope == other.scope
       end
 
       # @see the `==` method
@@ -94,7 +104,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [url, client_id, client_secret].hash
+        [url, client_id, client_secret, scope].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/authentication.rb

@@ -5,24 +5,24 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # An authentication is used to login into a Source or a Destination, with obfuscated input.
+    # Resource representing the information required to authenticate with a source or a destination.
     class Authentication
-      # The authentication UUID.
+      # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
       attr_accessor :type
 
-      # An human readable name describing the object.
+      # Descriptive name for the resource.
       attr_accessor :name
 
       attr_accessor :platform
 
       attr_accessor :input
 
-      # Date of creation (RFC3339 format).
+      # Date of creation in RFC3339 format.
       attr_accessor :created_at
 
-      # Date of last update (RFC3339 format).
+      # Date of last update in RFC3339 format.
       attr_accessor :updated_at
 
       class EnumAttributeValidator

data/lib/algolia/models/ingestion/authentication_create.rb

@@ -5,11 +5,11 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The payload when creating an authentication.
+    # Request body for creating a new authentication resource.
     class AuthenticationCreate
       attr_accessor :type
 
-      # An human readable name describing the object.
+      # Descriptive name for the resource.
       attr_accessor :name
 
       attr_accessor :platform

data/lib/algolia/models/ingestion/authentication_create_response.rb

@@ -5,15 +5,15 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Response from the API when the Authentication is successfully created.
+    # API response for the successful creation of an authentication resource.
     class AuthenticationCreateResponse
-      # The authentication UUID.
+      # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
-      # An human readable name describing the object.
+      # Descriptive name for the resource.
       attr_accessor :name
 
-      # Date of creation (RFC3339 format).
+      # Date of creation in RFC3339 format.
       attr_accessor :created_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/authentication_search.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Payload to search for multiple authentications, based on the given `authenticationIDs`.
+    # Request body for searching for authentication resources.
     class AuthenticationSearch
       attr_accessor :authentication_ids
 

data/lib/algolia/models/ingestion/authentication_update.rb

@@ -5,11 +5,11 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Payload to partially update an Authentication.
+    # Request body for updating an authentication resource.
     class AuthenticationUpdate
       attr_accessor :type
 
-      # An human readable name describing the object.
+      # Descriptive name for the resource.
       attr_accessor :name
 
       attr_accessor :platform

data/lib/algolia/models/ingestion/authentication_update_response.rb

@@ -5,15 +5,15 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Response from the API when the Authentication is successfully updated.
+    # API response for a successful update of an authentication resource.
     class AuthenticationUpdateResponse
-      # The authentication UUID.
+      # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
-      # An human readable name describing the object.
+      # Descriptive name for the resource.
       attr_accessor :name
 
-      # Date of last update (RFC3339 format).
+      # Date of last update in RFC3339 format.
       attr_accessor :updated_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/big_commerce_channel.rb

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Ingestion
     class BigCommerceChannel
-      # The ID of the bigcommerce channel.
+      # ID of the BigCommerce channel.
       attr_accessor :id
 
-      # An array of currencies for the given channel `ID`, a currency is a trigram string that represents the currency code.
+      # Currencies for the given channel.
       attr_accessor :currencies
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/big_commerce_metafield.rb

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Ingestion
     class BigCommerceMetafield
-      # The namespace of the metafield.
+      # Namespace of the metafield.
       attr_accessor :namespace
 
-      # The key identifier of the metafield.
+      # Key identifier of the metafield.
       attr_accessor :key
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/ingestion/commercetools_custom_fields.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Custom fields from Commercetools to index in the records (see https://docs.commercetools.com/tutorials/custom-types).
+    # Custom fields from commercetools to add to the records.  For more information, see [Using Custom Types and Custom Fields](https://docs.commercetools.com/tutorials/custom-types).
     class CommercetoolsCustomFields
       # Inventory custom fields.
       attr_accessor :inventory

data/lib/algolia/models/ingestion/delete_response.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Ingestion
     class DeleteResponse
-      # Date of deletion (RFC3339 format).
+      # Date of deletion in RFC3339 format.
       attr_accessor :deleted_at
 
       # Attribute mapping from ruby-style variable name to JSON key.