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

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

@@ -5,25 +5,25 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # A destination describe how the data is indexed on the Algolia side.
+    # Destinations are Algolia resources like indices or event streams.
     class Destination
-      # The destination UUID.
+      # Universally unique identifier (UUID) of a destination resource.
       attr_accessor :destination_id
 
       attr_accessor :type
 
-      # An human readable name describing the object.
+      # Descriptive name for the resource.
       attr_accessor :name
 
       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
 
-      # The authentication UUID.
+      # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
       class EnumAttributeValidator

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

@@ -5,16 +5,16 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The payload when creating a destination.
+    # API request body for creating a new destination.
     class DestinationCreate
       attr_accessor :type
 
-      # An human readable name describing the object.
+      # Descriptive name for the resource.
       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/destination_create_response.rb

@@ -5,15 +5,15 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Response from the API when the Destination is successfully created.
+    # API response for creating a new destination.
     class DestinationCreateResponse
-      # The destination UUID.
+      # Universally unique identifier (UUID) of a destination resource.
       attr_accessor :destination_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/destination_index_name.rb

@@ -6,12 +6,12 @@ require 'time'
 module Algolia
   module Ingestion
     class DestinationIndexName
-      # The index name to store data in.
+      # Algolia index name.
       attr_accessor :index_name
 
       attr_accessor :record_type
 
-      # Determines the attributes to exclude from an Algolia record. To remove nested element, you can separate the path to the element with dots (`.`):   - \"foo.bar\": will remove `bar` from `foo`. To remove elements from an array, you can use the following:   - \"foo.[0].bar\": will only remove `bar` from the first element of `foo`.   - \"foo.[*].bar\": will remove `bar` from every elements of `foo`.
+      # Attributes from your source to exclude from Algolia records.  Not all your data attributes will be useful for searching. Keeping your Algolia records small increases indexing and search performance.  - Exclude nested attributes with `.` notation. For example, `foo.bar` indexes the `foo` attribute and all its children **except** the `bar` attribute. - Exclude attributes from arrays with `[i]`, where `i` is the index of the array element.   For example, `foo.[0].bar` only excludes the `bar` attribute from the first element of the `foo` array, but indexes the complete `foo` attribute for all other elements.   Use `*` as wildcard: `foo.[*].bar` excludes `bar` from all elements of the `foo` array.
       attr_accessor :attributes_to_exclude
 
       class EnumAttributeValidator

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Ingestion
     class DestinationIndexPrefix
-      # The prefix of the final index name.
+      # String added to the beginning of all indices created by this destination.
       attr_accessor :index_prefix
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Payload to search for multiple destinations, based on the given `destinationIDs`.
+    # API request body for searching destinations.
     class DestinationSearch
       attr_accessor :destination_ids
 

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

@@ -8,10 +8,9 @@ module Algolia
     class DestinationType
       SEARCH = "search".freeze
       INSIGHTS = "insights".freeze
-      FLOW = "flow".freeze
 
       def self.all_vars
-        @all_vars ||= [SEARCH, INSIGHTS, FLOW].freeze
+        @all_vars ||= [SEARCH, INSIGHTS].freeze
       end
 
       # Builds the enum from string

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

@@ -5,16 +5,16 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Payload to partially update a Destination.
+    # API request body for updating a destination.
     class DestinationUpdate
       attr_accessor :type
 
-      # An human readable name describing the object.
+      # Descriptive name for the resource.
       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/destination_update_response.rb

@@ -5,15 +5,15 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Response from the API when the Destination is successfully updated.
+    # API response for updating a destination.
     class DestinationUpdateResponse
-      # The destination UUID.
+      # Universally unique identifier (UUID) of a destination resource.
       attr_accessor :destination_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/docker_source_discover.rb

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Ingestion
     class DockerSourceDiscover
-      # The run UUID.
+      # Universally unique identifier (UUID) of a task run.
       attr_accessor :run_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/event.rb

@@ -7,10 +7,10 @@ module Algolia
   module Ingestion
     # An event describe a step of the task execution flow..
     class Event
-      # The event UUID.
+      # Universally unique identifier (UUID) of an event.
       attr_accessor :event_id
 
-      # The run UUID.
+      # Universally unique identifier (UUID) of a task run.
       attr_accessor :run_id
 
       # The parent event, the cause of this event.
@@ -25,7 +25,7 @@ module Algolia
 
       attr_accessor :data
 
-      # Date of publish (RFC3339 format).
+      # Date of publish RFC3339 format.
       attr_accessor :published_at
 
       class EnumAttributeValidator

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # A list of tasks with pagination details.
+    # Configured tasks and pagination information.
     class ListTasksResponse
       attr_accessor :tasks
 

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

@@ -0,0 +1,32 @@
+# 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 Ingestion
+    class MappingFormatSchema
+      MAPPINGKIT_V1 = "mappingkit/v1".freeze
+
+      def self.all_vars
+        @all_vars ||= [MAPPINGKIT_V1].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if MappingFormatSchema.all_vars.include?(value)
+
+        raise "Invalid ENUM value #{value} for class #MappingFormatSchema"
+      end
+    end
+  end
+end

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

@@ -5,13 +5,34 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # Transformations to apply to source, serialized as a JSON string.
+    # Transformations to apply to the source, serialized as a JSON string.
     class MappingInput
-      # Name of the mapping format schema, `mappingkit/v1` is currently the only supported format.
       attr_accessor :format
 
       attr_accessor :actions
 
+      class EnumAttributeValidator
+        attr_reader :datatype
+        attr_reader :allowable_values
+
+        def initialize(datatype, allowable_values)
+          @allowable_values = allowable_values.map do |value|
+            case datatype.to_s
+            when /Integer/i
+              value.to_i
+            when /Float/i
+              value.to_f
+            else
+              value
+            end
+          end
+        end
+
+        def valid?(value)
+          !value || allowable_values.include?(value)
+        end
+      end
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -28,7 +49,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :format => :String,
+          :format => :MappingFormatSchema,
           :actions => :'Array<MappingKitAction>'
         }
       end

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

@@ -5,12 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The input for an `onDemand` task whose source is of type `bigquery` and for which extracted data spans a given time range.
+    # Input for a manually-triggered task whose source is of type `bigquery` and for which extracted data spans a given time range.
     class OnDemandDateUtilsInput
-      # The start date of the extraction (RFC3339 format).
+      # Earliest date in RFC3339 format of the extracted data from Big Query.
       attr_accessor :start_date
 
-      # The end date of the extraction (RFC3339 format).
+      # Latest date in RFC3339 format of the extracted data from Big Query.
       attr_accessor :end_date
 
       attr_accessor :mapping

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

@@ -5,11 +5,11 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The trigger information of a task of type `onDemand`.
+    # Trigger information for manually-triggered tasks.
     class OnDemandTrigger
       attr_accessor :type
 
-      # The last time the scheduled task ran (RFC3339 format).
+      # The last time the scheduled task ran in RFC3339 format.
       attr_accessor :last_run
 
       class EnumAttributeValidator

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The trigger information of a task of type `onDemand`.
+    # Trigger information for manually-triggered tasks.
     class OnDemandTriggerInput
       attr_accessor :type
 

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

@@ -5,13 +5,18 @@ require 'time'
 
 module Algolia
   module Ingestion
+    # Paginated API response.
     class Pagination
+      # Number of pages in the API response.
       attr_accessor :nb_pages
 
+      # Page of the API response to retrieve.
       attr_accessor :page
 
+      # Number of items in the API response.
       attr_accessor :nb_items
 
+      # Number of items per page.
       attr_accessor :items_per_page
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -86,6 +91,66 @@ module Algolia
         end
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] nb_pages Value to be assigned
+      def nb_pages=(nb_pages)
+        if nb_pages.nil?
+          raise ArgumentError, 'nb_pages cannot be nil'
+        end
+
+        if nb_pages < 1
+          raise ArgumentError, 'invalid value for "nb_pages", must be greater than or equal to 1.'
+        end
+
+        @nb_pages = nb_pages
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] page Value to be assigned
+      def page=(page)
+        if page.nil?
+          raise ArgumentError, 'page cannot be nil'
+        end
+
+        if page < 1
+          raise ArgumentError, 'invalid value for "page", must be greater than or equal to 1.'
+        end
+
+        @page = page
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] nb_items Value to be assigned
+      def nb_items=(nb_items)
+        if nb_items.nil?
+          raise ArgumentError, 'nb_items cannot be nil'
+        end
+
+        if nb_items < 0
+          raise ArgumentError, 'invalid value for "nb_items", must be greater than or equal to 0.'
+        end
+
+        @nb_items = nb_items
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] items_per_page Value to be assigned
+      def items_per_page=(items_per_page)
+        if items_per_page.nil?
+          raise ArgumentError, 'items_per_page cannot be nil'
+        end
+
+        if items_per_page > 100
+          raise ArgumentError, 'invalid value for "items_per_page", must be smaller than or equal to 100.'
+        end
+
+        if items_per_page < 1
+          raise ArgumentError, 'invalid value for "items_per_page", must be greater than or equal to 1.'
+        end
+
+        @items_per_page = items_per_page
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

@@ -8,9 +8,10 @@ module Algolia
     class Platform
       BIGCOMMERCE = "bigcommerce".freeze
       COMMERCETOOLS = "commercetools".freeze
+      SHOPIFY = "shopify".freeze
 
       def self.all_vars
-        @all_vars ||= [BIGCOMMERCE, COMMERCETOOLS].freeze
+        @all_vars ||= [BIGCOMMERCE, COMMERCETOOLS, SHOPIFY].freeze
       end
 
       # Builds the enum from string

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

@@ -6,12 +6,12 @@ require 'time'
 module Algolia
   module Ingestion
     class Run
-      # The run UUID.
+      # Universally unique identifier (UUID) of a task run.
       attr_accessor :run_id
 
       attr_accessor :app_id
 
-      # The task UUID.
+      # Universally unique identifier (UUID) of a task.
       attr_accessor :task_id
 
       attr_accessor :status
@@ -20,23 +20,23 @@ module Algolia
 
       attr_accessor :outcome
 
-      # 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
 
-      # Explains the result of outcome.
+      # More information about the task run's outcome.
       attr_accessor :reason
 
       attr_accessor :reason_code
 
       attr_accessor :type
 
-      # Date of creation (RFC3339 format).
+      # Date of creation in RFC3339 format.
       attr_accessor :created_at
 
-      # Date of start (RFC3339 format).
+      # Date of start in RFC3339 format.
       attr_accessor :started_at
 
-      # Date of finish (RFC3339 format).
+      # Date of finish in RFC3339 format.
       attr_accessor :finished_at
 
       class EnumAttributeValidator

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

@@ -5,12 +5,12 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The response from the run task API, containing an Observability Run ID and the time it was created at.
+    # API response for running a task.
     class RunResponse
-      # The run UUID.
+      # Universally unique identifier (UUID) of a task run.
       attr_accessor :run_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/schedule_date_utils_input.rb

@@ -5,9 +5,9 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The input for a `schedule` task whose source is of type `bigquery` and for which extracted data spans a fixed number of days.
+    # Input for scheduled tasks whose source is of type `bigquery` and for which extracted data spans a fixed number of days.
     class ScheduleDateUtilsInput
-      # The timeframe of the extraction, in number of days from today.
+      # Number of days in the past until the current day for which to extract Big Query data.
       attr_accessor :timeframe
 
       attr_accessor :mapping

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

@@ -5,17 +5,17 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The trigger information for a task of type 'schedule'.
+    # Trigger information for scheduled tasks.
     class ScheduleTrigger
       attr_accessor :type
 
-      # A cron expression that represent at which regularity the task should run.
+      # Cron expression for the task's schedule.
       attr_accessor :cron
 
-      # The last time the scheduled task ran (RFC3339 format).
+      # The last time the scheduled task ran in RFC3339 format.
       attr_accessor :last_run
 
-      # The next scheduled run of the task (RFC3339 format).
+      # The next scheduled run of the task in RFC3339 format.
       attr_accessor :next_run
 
       class EnumAttributeValidator

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

@@ -5,11 +5,11 @@ require 'time'
 
 module Algolia
   module Ingestion
-    # The trigger input for a task of type 'schedule'.
+    # Trigger input for scheduled tasks.
     class ScheduleTriggerInput
       attr_accessor :type
 
-      # A cron expression that represent at which regularity the task should run.
+      # Cron expression for the task's schedule.
       attr_accessor :cron
 
       class EnumAttributeValidator

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