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

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Ingestion
     class Source
-      # The source UUID.
+      # Universally uniqud identifier (UUID) of a source.
       attr_accessor :source_id
 
       attr_accessor :type
@@ -15,13 +15,13 @@ module Algolia
 
       attr_accessor :input
 
-      # The authentication UUID.
+      # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
-      # 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/source_big_commerce.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Ingestion
     class SourceBigCommerce
-      # The store hash identifying the store the shopper is signing in to.
+      # Store hash identifying your BigCommerce store.
       attr_accessor :store_hash
 
       attr_accessor :channel

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

@@ -6,24 +6,24 @@ require 'time'
 module Algolia
   module Ingestion
     class SourceBigQuery
-      # Project ID of the BigQuery Source.
+      # Project ID of the BigQuery source.
       attr_accessor :project_id
 
-      # Dataset ID of the BigQuery Source.
+      # Dataset ID of the BigQuery source.
       attr_accessor :dataset_id
 
       attr_accessor :data_type
 
-      # Table name (for default BQ).
+      # Table name for the BigQuery export.
       attr_accessor :table
 
-      # Table prefix (for Google Analytics).
+      # Table prefix for a Google Analytics 4 data export to BigQuery.
       attr_accessor :table_prefix
 
       # Custom SQL request to extract data from the BigQuery table.
       attr_accessor :custom_sql_request
 
-      # The name of the column that contains the unique ID, used as `objectID` in Algolia.
+      # Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
       attr_accessor :unique_id_column
 
       class EnumAttributeValidator

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

@@ -8,14 +8,14 @@ module Algolia
     class SourceCommercetools
       attr_accessor :store_keys
 
-      # Array of locales that must match the following pattern: ^[a-z]{2}(-[A-Z]{2})?$. For example [\"fr-FR\", \"en\"].
+      # Locales for your commercetools stores.
       attr_accessor :locales
 
       attr_accessor :url
 
       attr_accessor :project_key
 
-      # Determines the value that will be stored in the Algolia record if there's no inventory information on the product.
+      # Whether a fallback value is stored in the Algolia record if there's no inventory information about the product.
       attr_accessor :fallback_is_in_stock_value
 
       attr_accessor :custom_fields

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

@@ -8,11 +8,12 @@ module Algolia
     class SourceCreate
       attr_accessor :type
 
+      # Descriptive name of the source.
       attr_accessor :name
 
       attr_accessor :input
 
-      # The authentication UUID.
+      # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
       class EnumAttributeValidator

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

@@ -6,12 +6,13 @@ require 'time'
 module Algolia
   module Ingestion
     class SourceCreateResponse
-      # The source UUID.
+      # Universally uniqud identifier (UUID) of a source.
       attr_accessor :source_id
 
+      # Descriptive name of the source.
       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/source_csv.rb

@@ -6,13 +6,13 @@ require 'time'
 module Algolia
   module Ingestion
     class SourceCSV
-      # The URL of the file.
+      # URL of the file.
       attr_accessor :url
 
-      # The name of the column that contains the unique ID, used as `objectID` in Algolia.
+      # Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
       attr_accessor :unique_id_column
 
-      # Mapping of type for every column. For example {\"myColumn\": \"boolean\", \"myOtherColumn\": \"json\"}.
+      # Key-value pairs of column names and their expected types.
       attr_accessor :mapping
 
       attr_accessor :method

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

@@ -10,13 +10,13 @@ module Algolia
 
       attr_accessor :registry
 
-      # The name of the image to pull.
+      # Docker image name.
       attr_accessor :image
 
-      # The version of the image, defaults to `latest`.
+      # Docker image version.
       attr_accessor :version
 
-      # The configuration of the spec.
+      # Configuration of the spec.
       attr_accessor :configuration
 
       class EnumAttributeValidator

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

@@ -6,13 +6,13 @@ require 'time'
 module Algolia
   module Ingestion
     class SourceGA4BigQueryExport
-      # GCP project ID that the BigQuery Export writes to.
+      # GCP project ID that the BigQuery export writes to.
       attr_accessor :project_id
 
-      # BigQuery dataset ID that the BigQuery Export writes to.
+      # BigQuery dataset ID that the BigQuery export writes to.
       attr_accessor :dataset_id
 
-      # Prefix of the tables that the BigQuery Export writes to (i.e. events_intraday_ for streaming, events_ for daily).
+      # Prefix of the tables that the BigQuery Export writes to.
       attr_accessor :table_prefix
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Ingestion
     class SourceJSON
-      # The URL of the file.
+      # URL of the file.
       attr_accessor :url
 
-      # The name of the column that contains the unique ID, used as `objectID` in Algolia.
+      # Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
       attr_accessor :unique_id_column
 
       attr_accessor :method

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

@@ -7,15 +7,17 @@ module Algolia
   module Ingestion
     class SourceType
       BIGCOMMERCE = "bigcommerce".freeze
+      BIGQUERY = "bigquery".freeze
       COMMERCETOOLS = "commercetools".freeze
-      JSON = "json".freeze
       CSV = "csv".freeze
-      BIGQUERY = "bigquery".freeze
       DOCKER = "docker".freeze
       GA4_BIGQUERY_EXPORT = "ga4BigqueryExport".freeze
+      JSON = "json".freeze
+      SHOPIFY = "shopify".freeze
+      SFCC = "sfcc".freeze
 
       def self.all_vars
-        @all_vars ||= [BIGCOMMERCE, COMMERCETOOLS, JSON, CSV, BIGQUERY, DOCKER, GA4_BIGQUERY_EXPORT].freeze
+        @all_vars ||= [BIGCOMMERCE, BIGQUERY, COMMERCETOOLS, CSV, DOCKER, GA4_BIGQUERY_EXPORT, JSON, SHOPIFY, SFCC].freeze
       end
 
       # Builds the enum from string

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

@@ -6,11 +6,12 @@ require 'time'
 module Algolia
   module Ingestion
     class SourceUpdate
+      # Descriptive name of the source.
       attr_accessor :name
 
       attr_accessor :input
 
-      # The authentication UUID.
+      # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,15 +6,14 @@ require 'time'
 module Algolia
   module Ingestion
     class SourceUpdateCommercetools
-      # Unique and immutable key of the referenced Store.
       attr_accessor :store_keys
 
-      # Array of locales that must match the following pattern: ^[a-z]{2}(-[A-Z]{2})?$. For example [\"fr-FR\", \"en\"].
+      # Locales for your commercetools stores.
       attr_accessor :locales
 
       attr_accessor :url
 
-      # Determines the value that will be stored in the Algolia record if there's no inventory information on the product.
+      # Whether a fallback value is stored in the Algolia record if there's no inventory information about the product.
       attr_accessor :fallback_is_in_stock_value
 
       attr_accessor :custom_fields

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

@@ -8,13 +8,13 @@ module Algolia
     class SourceUpdateDocker
       attr_accessor :registry
 
-      # The name of the image to pull.
+      # Docker image name.
       attr_accessor :image
 
-      # The version of the image, defaults to `latest`.
+      # Docker image version.
       attr_accessor :version
 
-      # The configuration of the spec.
+      # Configuration of the spec.
       attr_accessor :configuration
 
       class EnumAttributeValidator

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

@@ -6,12 +6,13 @@ require 'time'
 module Algolia
   module Ingestion
     class SourceUpdateResponse
-      # The source UUID.
+      # Universally uniqud identifier (UUID) of a source.
       attr_accessor :source_id
 
+      # Descriptive name of the source.
       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/streaming_trigger.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The trigger input for a task of type 'streaming'.
+    # Trigger input for continuously running tasks.
     class StreamingTrigger
       attr_accessor :type
 

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
+    # Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
     class StreamingUtilsInput
       attr_accessor :mapping
 

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The trigger input for a task of type 'subscription'.
+    # Trigger input for subscription tasks.
     class SubscriptionTrigger
       attr_accessor :type
 

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

@@ -6,31 +6,31 @@ require 'time'
 module Algolia
   module Ingestion
     class Task
-      # The task UUID.
+      # Universally unique identifier (UUID) of a task.
       attr_accessor :task_id
 
-      # The source UUID.
+      # Universally uniqud identifier (UUID) of a source.
       attr_accessor :source_id
 
-      # The destination UUID.
+      # Universally unique identifier (UUID) of a destination resource.
       attr_accessor :destination_id
 
       attr_accessor :trigger
 
       attr_accessor :input
 
-      # Whether the task is enabled or not.
+      # Whether the task is enabled.
       attr_accessor :enabled
 
-      # A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+      # Maximum accepted percentage of failures for a task run to finish successfully.
       attr_accessor :failure_threshold
 
       attr_accessor :action
 
-      # 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/task_create.rb

@@ -5,22 +5,22 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The payload for a task creation.
+    # API request body for creating a task.
     class TaskCreate
-      # The source UUID.
+      # Universally uniqud identifier (UUID) of a source.
       attr_accessor :source_id
 
-      # The destination UUID.
+      # Universally unique identifier (UUID) of a destination resource.
       attr_accessor :destination_id
 
       attr_accessor :trigger
 
       attr_accessor :action
 
-      # Whether the task is enabled or not.
+      # Whether the task is enabled.
       attr_accessor :enabled
 
-      # A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+      # Maximum accepted percentage of failures for a task run to finish successfully.
       attr_accessor :failure_threshold
 
       attr_accessor :input

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

@@ -5,12 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The response from the API after a task creation.
+    # API response for creating a task.
     class TaskCreateResponse
-      # The task UUID.
+      # Universally unique identifier (UUID) of a task.
       attr_accessor :task_id
 
-      # 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/task_input.rb

@@ -5,6 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
+    # Configuration of the task, depending on its type.
     module TaskInput
       class << self
         # List of class defined in oneOf (OpenAPI v3)

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

@@ -5,19 +5,19 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The payload for a task update.
+    # API request body for updating a task.
     class TaskUpdate
-      # The destination UUID.
+      # Universally unique identifier (UUID) of a destination resource.
       attr_accessor :destination_id
 
       attr_accessor :trigger
 
       attr_accessor :input
 
-      # Whether the task is enabled or not.
+      # Whether the task is enabled.
       attr_accessor :enabled
 
-      # A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+      # Maximum accepted percentage of failures for a task run to finish successfully.
       attr_accessor :failure_threshold
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -5,12 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The response from the API after a task update.
+    # API response for updating a task.
     class TaskUpdateResponse
-      # The task UUID.
+      # Universally unique identifier (UUID) of a task.
       attr_accessor :task_id
 
-      # 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/trigger.rb

@@ -5,6 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
+    # Trigger that runs the task.
     module Trigger
       class << self
         # List of class defined in oneOf (OpenAPI v3)

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

@@ -5,9 +5,9 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The trigger input for a task update.
+    # Trigger for a task update.
     class TriggerUpdateInput
-      # A cron expression that represent at which regularity the task should run.
+      # Cron expression for the task's schedule.
       attr_accessor :cron
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -5,12 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The window parameter represents the holds the dates used to query the Observability data from the database in a given window.
+    # Time window by which to filter the observability data.
     class Window
-      # A date in format RFC3339 representing the oldest possible data in query window.
+      # Date in RFC3339 format representing the oldest data in the time window.
       attr_accessor :start_date
 
-      # A date in format RFC3339 representing the newest possible data in query window.
+      # Date in RFC3339 format representing the newest data in the time window.
       attr_accessor :end_date
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/insights/purchased_object_ids_after_search.rb

@@ -170,6 +170,8 @@ module Algolia
           if (value = attributes[:object_data]).is_a?(Array)
             self.object_data = value
           end
+        else
+          self.object_data = nil
         end
 
         if attributes.key?(:timestamp)

data/lib/algolia/models/monitoring/{get_inventory403_response.rb → get_servers403_response.rb}

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Monitoring
-    class GetInventory403Response
+    class GetServers403Response
       attr_accessor :reason
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -36,14 +36,14 @@ module Algolia
       # @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::GetInventory403Response` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::GetServers403Response` 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::GetInventory403Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+                  "`#{k}` is not a valid attribute in `Algolia::GetServers403Response`. 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

data/lib/algolia/models/monitoring/server.rb

@@ -11,10 +11,10 @@ module Algolia
 
       attr_accessor :region
 
-      # Included to support legacy applications. Do not rely on this attribute being present in the response. Use `is_replica` instead.
+      # Included to support legacy applications. Use `is_replica` instead.
       attr_accessor :is_slave
 
-      # Indicates whether this server is a replica of another server.
+      # Whether this server is a replica of another server.
       attr_accessor :is_replica
 
       # Name of the cluster to which this server belongs.