algolia 3.0.0.alpha.15 → 3.0.0.alpha.16

data/lib/algolia/api/monitoring_client.rb

@@ -200,7 +200,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # List known incidents for selected clusters.
+    # Retrieves known incidents for the selected clusters.
 
     # @param clusters [String] Subset of clusters, separated by comma. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -230,7 +230,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # List known incidents for selected clusters.
+    # Retrieves known incidents for the selected clusters.
 
     # @param clusters [String] Subset of clusters, separated by comma. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -240,7 +240,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::IncidentsResponse')
     end
 
-    # Report whether a cluster is operational.
+    # Retrieves the status of selected clusters.
 
     # @param clusters [String] Subset of clusters, separated by comma. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -270,7 +270,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Report whether a cluster is operational.
+    # Retrieves the status of selected clusters.
 
     # @param clusters [String] Subset of clusters, separated by comma. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -280,7 +280,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::StatusResponse')
     end
 
-    # List known incidents for all clusters.
+    # Retrieves known incidents for all clusters.
 
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -304,7 +304,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # List known incidents for all clusters.
+    # Retrieves known incidents for all clusters.
 
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [IncidentsResponse]
@@ -313,7 +313,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::IncidentsResponse')
     end
 
-    # List the average times for indexing operations for selected clusters.
+    # Retrieves average times for indexing operations for selected clusters.
 
     # @param clusters [String] Subset of clusters, separated by comma. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -343,7 +343,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # List the average times for indexing operations for selected clusters.
+    # Retrieves average times for indexing operations for selected clusters.
 
     # @param clusters [String] Subset of clusters, separated by comma. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -353,40 +353,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::IndexingTimeResponse')
     end
 
-    # List the servers belonging to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application's cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
-
-    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [Http::Response] the response
-    def get_inventory_with_http_info(request_options = {})
-      path = '/1/inventory/servers'
-      query_params = {}
-      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
-      header_params = {}
-      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
-
-      post_body = request_options[:debug_body]
-
-      new_options = request_options.merge(
-        :operation => :'MonitoringClient.get_inventory',
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :use_read_transporter => false
-      )
-
-      @api_client.call_api(:GET, path, new_options)
-    end
-
-    # List the servers belonging to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application's cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
-
-    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [InventoryResponse]
-    def get_inventory(request_options = {})
-      response = get_inventory_with_http_info(request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::InventoryResponse')
-    end
-
-    # List the average latency for search requests for selected clusters.
+    # Retrieves the average latency for search requests for selected clusters.
 
     # @param clusters [String] Subset of clusters, separated by comma. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -416,7 +383,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # List the average latency for search requests for selected clusters.
+    # Retrieves the average latency for search requests for selected clusters.
 
     # @param clusters [String] Subset of clusters, separated by comma. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -426,9 +393,9 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::LatencyResponse')
     end
 
-    # Report the aggregate value of a metric for a selected period of time.
+    # Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.  Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).
 
-    # @param metric [Metric] Metric to report.  For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter.  (required)
+    # @param metric [Metric] Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.  (required)
     # @param period [Period] Period over which to aggregate the metrics:  - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day.  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -461,9 +428,9 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Report the aggregate value of a metric for a selected period of time.
+    # Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.  Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).
 
-    # @param metric [Metric] Metric to report.  For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter.  (required)
+    # @param metric [Metric] Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.  (required)
     # @param period [Period] Period over which to aggregate the metrics:  - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day.  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [InfrastructureResponse]
@@ -512,7 +479,40 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::Hash<String, Hash>')
     end
 
-    # Report whether clusters are operational.  The response depends on whether you authenticate your API request.  - With authentication, the response includes the status of the cluster assigned to your Algolia application.  - Without authentication, the response lists the statuses of all public Algolia clusters.
+    # Retrieves the servers that belong to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application&#39;s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
+
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [Http::Response] the response
+    def get_servers_with_http_info(request_options = {})
+      path = '/1/inventory/servers'
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :'MonitoringClient.get_servers',
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:GET, path, new_options)
+    end
+
+    # Retrieves the servers that belong to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application's cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
+
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [InventoryResponse]
+    def get_servers(request_options = {})
+      response = get_servers_with_http_info(request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Monitoring::InventoryResponse')
+    end
+
+    # Retrieves the status of all Algolia clusters and instances.
 
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -536,7 +536,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Report whether clusters are operational.  The response depends on whether you authenticate your API request.  - With authentication, the response includes the status of the cluster assigned to your Algolia application.  - Without authentication, the response lists the statuses of all public Algolia clusters.
+    # Retrieves the status of all Algolia clusters and instances.
 
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [StatusResponse]

data/lib/algolia/api/query_suggestions_client.rb

@@ -33,7 +33,7 @@ module Algolia
       new(config)
     end
 
-    # Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
+    # Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -65,7 +65,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
+    # Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -253,7 +253,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
     end
 
-    # Delete a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.
+    # Deletes a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation.
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -285,7 +285,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # Delete a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.
+    # Deletes a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation.
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -297,7 +297,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::BaseResponse')
     end
 
-    # List all Query Suggestions configurations of your Algolia application.
+    # Retrieves all Query Suggestions configurations of your Algolia application.
     #
     # Required API Key ACLs:
     #   - settings
@@ -323,7 +323,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # List all Query Suggestions configurations of your Algolia application.
+    # Retrieves all Query Suggestions configurations of your Algolia application.
     #
     # Required API Key ACLs:
     #   - settings
@@ -334,7 +334,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<QuerySuggestions::QuerySuggestionsConfigurationResponse>')
     end
 
-    # Get a single Query Suggestions configuration.
+    # Retrieves a single Query Suggestions configuration by its index name.
     #
     # Required API Key ACLs:
     #   - settings
@@ -366,7 +366,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get a single Query Suggestions configuration.
+    # Retrieves a single Query Suggestions configuration by its index name.
     #
     # Required API Key ACLs:
     #   - settings
@@ -378,7 +378,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::QuerySuggestionsConfigurationResponse')
     end
 
-    # Report the status of a Query Suggestions index.
+    # Reports the status of a Query Suggestions index.
     #
     # Required API Key ACLs:
     #   - settings
@@ -410,7 +410,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Report the status of a Query Suggestions index.
+    # Reports the status of a Query Suggestions index.
     #
     # Required API Key ACLs:
     #   - settings
@@ -422,7 +422,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetConfigStatus200Response')
     end
 
-    # Get the logs for a single Query Suggestions index.
+    # Retrieves the logs for a single Query Suggestions index.
     #
     # Required API Key ACLs:
     #   - settings
@@ -454,7 +454,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Get the logs for a single Query Suggestions index.
+    # Retrieves the logs for a single Query Suggestions index.
     #
     # Required API Key ACLs:
     #   - settings
@@ -466,7 +466,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || 'QuerySuggestions::GetLogFile200Response')
     end
 
-    # Update a QuerySuggestions configuration.
+    # Updates a QuerySuggestions configuration.
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -503,7 +503,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # Update a QuerySuggestions configuration.
+    # Updates a QuerySuggestions configuration.
     #
     # Required API Key ACLs:
     #   - editSettings

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.