algolia 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 404b7dfdccd5dd7e5fdc335e2a9aa51df6e25db69090bfab3d26d78de2d5627b
-  data.tar.gz: 6d12601db49e7a0c3148699c91e2b529532ecb7b2dd7accd5acc73b7b7281d8a
+  metadata.gz: 6967c1e0fee7827a095a00ec10e11f811a36f7aa0c5ba89a3126e12cd5f15cd2
+  data.tar.gz: 0362216040d62edf5d8f62e8fb0975ad4834ec0c29080e5c7f311ad5ee8b4524
 SHA512:
-  metadata.gz: 1e9a195272c834ace42d3afc0d432dff8c231f3bfd0bd72fec215ca2869ece8c288e227ee5e31fc17b450569d5a35dd131fefde1feb11643744d523ee19a3057
-  data.tar.gz: aa37dd5dec384ece1fbbb04a6e584eeecc6b3b48e2815be424c5920aec116717559a8b3313f061a73e70a1d3292c5466e3d8783ad6d1d37424cd150aa25c5d4c
+  metadata.gz: 77792993a5628aac7de7e17979860282b645bbb0b04fd25dd57084a91618db3603c6cdebc0a2e920ae0a151e58b5fae16293e398f95a5e6237f37b3c956db16c
+  data.tar.gz: 1c347a72f02b6e0f8eb203876ff5a78f856e0b90c4bb175a73f714561708ee257d23bcc8cb818c42ca4bd97071dcc27e21461b3e2bf4233f168df6ddea43a739

data/.github/ISSUE_TEMPLATE/Bug_report.yml

@@ -0,0 +1,58 @@
+name: Bug Report
+description: File a bug report.
+title: '[bug]: '
+labels: ['bug', 'triage']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Please help us help you!
+
+        > [!IMPORTANT]  
+        > This repository is fully generated and all pull request will be rejected.
+        > If you wish to contribute, please refer to the [contribution guidelines](https://github.com/algolia/api-clients-automation/blob/main/CONTRIBUTING.md) on the `api-clients-automation` repository.
+
+        Before filing your issue, ask yourself:
+        - Is there an issue already opened for this bug?
+        - Can I reproduce it?
+
+        If you are not sure about the origin of the issue, or if it impacts your customer experience, please contact [our support team](https://alg.li/support).
+  - type: textarea
+    attributes:
+      label: Description
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: dropdown
+    id: client
+    attributes:
+      label: Client
+      description: Which API are you targetting?
+      options:
+        - All
+        - AB testing
+        - Analytics
+        - Ingestion
+        - Insights
+        - Monitoring
+        - Personalization
+        - Query-Suggestions
+        - Recommend
+        - Search
+        - Usage
+        - Crawler
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: The version of the client you are using.
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [3.2.2](https://github.com/algolia/algoliasearch-client-ruby/compare/3.2.1...3.2.2)
+
+- [327e08d4e](https://github.com/algolia/api-clients-automation/commit/327e08d4e) fix(specs): ingestion push task payload [skip-bc] ([#3607](https://github.com/algolia/api-clients-automation/pull/3607)) by [@shortcuts](https://github.com/shortcuts/)
+
 ## [3.2.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.2.0...3.2.1)
 
 - [41f849e41](https://github.com/algolia/api-clients-automation/commit/41f849e41) fix(specs): partial update operation ([#3486](https://github.com/algolia/api-clients-automation/pull/3486)) by [@kai687](https://github.com/kai687/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.2.1)
+    algolia (3.2.2)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)

data/lib/algolia/api/ingestion_client.rb

@@ -2354,17 +2354,17 @@ module Algolia
     #   - deleteIndex
     #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
-    # @param batch_write_params [BatchWriteParams] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)
+    # @param push_task_payload [PushTaskPayload] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (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
-    def push_task_with_http_info(task_id, batch_write_params, request_options = {})
+    def push_task_with_http_info(task_id, push_task_payload, request_options = {})
       # verify the required parameter 'task_id' is set
       if @api_client.config.client_side_validation && task_id.nil?
         raise ArgumentError, "Parameter `task_id` is required when calling `push_task`."
       end
-      # verify the required parameter 'batch_write_params' is set
-      if @api_client.config.client_side_validation && batch_write_params.nil?
-        raise ArgumentError, "Parameter `batch_write_params` is required when calling `push_task`."
+      # verify the required parameter 'push_task_payload' is set
+      if @api_client.config.client_side_validation && push_task_payload.nil?
+        raise ArgumentError, "Parameter `push_task_payload` is required when calling `push_task`."
       end
 
       path = "/2/tasks/{taskID}/push".sub("{" + "taskID" + "}", Transport.encode_uri(task_id.to_s))
@@ -2373,7 +2373,7 @@ module Algolia
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
 
-      post_body = request_options[:debug_body] || @api_client.object_to_http_body(batch_write_params)
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(push_task_payload)
 
       new_options = request_options.merge(
         :operation => :"IngestionClient.push_task",
@@ -2393,11 +2393,11 @@ module Algolia
     #   - deleteIndex
     #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
-    # @param batch_write_params [BatchWriteParams] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)
+    # @param push_task_payload [PushTaskPayload] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (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 [RunResponse]
-    def push_task(task_id, batch_write_params, request_options = {})
-      response = push_task_with_http_info(task_id, batch_write_params, request_options)
+    def push_task(task_id, push_task_payload, request_options = {})
+      response = push_task_with_http_info(task_id, push_task_payload, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunResponse")
     end
 

data/lib/algolia/models/ingestion/{batch_request.rb → push_task_payload.rb}

@@ -5,11 +5,10 @@ require "time"
 
 module Algolia
   module Ingestion
-    class BatchRequest
+    class PushTaskPayload
       attr_accessor :action
 
-      # Operation arguments (varies with specified `action`).
-      attr_accessor :body
+      attr_accessor :records
 
       class EnumAttributeValidator
         attr_reader :datatype
@@ -37,7 +36,7 @@ module Algolia
       def self.attribute_map
         {
           :action => :action,
-          :body => :body
+          :records => :records
         }
       end
 
@@ -50,7 +49,7 @@ module Algolia
       def self.types_mapping
         {
           :action => :"Action",
-          :body => :"Object"
+          :records => :"Array<PushTaskRecords>"
         }
       end
 
@@ -67,7 +66,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::BatchRequest` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::PushTaskPayload` initialize method"
           )
         end
 
@@ -76,7 +75,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::BatchRequest`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::PushTaskPayload`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -90,10 +89,12 @@ module Algolia
           self.action = nil
         end
 
-        if attributes.key?(:body)
-          self.body = attributes[:body]
+        if attributes.key?(:records)
+          if (value = attributes[:records]).is_a?(Array)
+            self.records = value
+          end
         else
-          self.body = nil
+          self.records = nil
         end
       end
 
@@ -103,7 +104,7 @@ module Algolia
         return true if self.equal?(other)
         self.class == other.class &&
           action == other.action &&
-          body == other.body
+          records == other.records
       end
 
       # @see the `==` method
@@ -115,7 +116,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [action, body].hash
+        [action, records].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/{batch_write_params.rb → push_task_records.rb}

@@ -5,14 +5,16 @@ require "time"
 
 module Algolia
   module Ingestion
-    # Batch parameters.
-    class BatchWriteParams
-      attr_accessor :requests
+    class PushTaskRecords
+      # Unique record identifier.
+      attr_accessor :object_id
+
+      attr_accessor :additional_properties
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :requests => :requests
+          :object_id => :objectID
         }
       end
 
@@ -24,7 +26,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :requests => :"Array<BatchRequest>"
+          :object_id => :"String"
         }
       end
 
@@ -41,30 +43,19 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::BatchWriteParams` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::PushTaskRecords` initialize method"
           )
         end
 
-        # check to see if the attribute exists and convert string to symbol for hash key
-        attributes = attributes.each_with_object({}) { |(k, v), h|
-          if (!self.class.attribute_map.key?(k.to_sym))
-            raise(
-              ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::BatchWriteParams`. 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
-        }
-
-        if attributes.key?(:requests)
-          if (value = attributes[:requests]).is_a?(Array)
-            self.requests = value
-          end
+        if attributes.key?(:object_id)
+          self.object_id = attributes[:object_id]
         else
-          self.requests = nil
+          self.object_id = nil
         end
+
+        # add extra attribute to additional_properties
+        self.additional_properties ||= {}
+        self.additional_properties.merge!(attributes.reject { |k, _| self.class.attribute_map.key?(k.to_sym) })
       end
 
       # Checks equality by comparing each attribute.
@@ -72,7 +63,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          requests == other.requests
+          object_id == other.object_id
       end
 
       # @see the `==` method
@@ -84,7 +75,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [requests].hash
+        [object_id].hash
       end
 
       # Builds the object from hash
@@ -110,6 +101,8 @@ module Algolia
           end
         end
 
+        # add extra attribute to transformed_hash
+        transformed_hash.merge!(attributes.reject { |k, _| attribute_map.key?(k.to_sym) })
         new(transformed_hash)
       end
 
@@ -189,6 +182,11 @@ module Algolia
           hash[param] = _to_hash(value)
         end
 
+        # also add attributes from additional_properties to hash
+        self.additional_properties&.each_pair do |k, v|
+          hash[k.to_sym] = _to_hash(v)
+        end
+
         hash
       end
 

data/lib/algolia/version.rb

@@ -1,5 +1,5 @@
 # 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.
 
 module Algolia
-  VERSION = "3.2.1".freeze
+  VERSION = "3.2.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - https://alg.li/support
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
+date: 2024-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -118,6 +118,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/Bug_report.yml"
 - ".github/workflows/issue.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
@@ -244,8 +245,6 @@ files:
 - lib/algolia/models/ingestion/authentication_type.rb
 - lib/algolia/models/ingestion/authentication_update.rb
 - lib/algolia/models/ingestion/authentication_update_response.rb
-- lib/algolia/models/ingestion/batch_request.rb
-- lib/algolia/models/ingestion/batch_write_params.rb
 - lib/algolia/models/ingestion/big_commerce_channel.rb
 - lib/algolia/models/ingestion/big_commerce_metafield.rb
 - lib/algolia/models/ingestion/big_query_data_type.rb
@@ -296,6 +295,8 @@ files:
 - lib/algolia/models/ingestion/platform.rb
 - lib/algolia/models/ingestion/platform_none.rb
 - lib/algolia/models/ingestion/platform_with_none.rb
+- lib/algolia/models/ingestion/push_task_payload.rb
+- lib/algolia/models/ingestion/push_task_records.rb
 - lib/algolia/models/ingestion/record_type.rb
 - lib/algolia/models/ingestion/run.rb
 - lib/algolia/models/ingestion/run_list_response.rb