Merge branch 'main' into feat/add-chopper-requester-package

Author: techouse

.github/workflows/check.yml

@@ -41,7 +41,7 @@ jobs:
     runs-on: ubuntu-22.04
     timeout-minutes: 10
     env:
-      CACHE_VERSION: 1.12 # bump this to run all clients on the CI.
+      CACHE_VERSION: 1.13 # bump this to run all clients on the CI.
     steps:
       - name: debugging - dump GitHub context
         env:
@@ -219,7 +219,7 @@ jobs:
         run: cd clients/algoliasearch-client-javascript && YARN_ENABLE_HARDENED_MODE=0 YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install
 
       - name: Build clients
-        run: ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).buildCommand }}
+        run: cd clients/algoliasearch-client-javascript && yarn build
 
       - name: Build the playground
         run: yarn cli build playground javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
@@ -334,6 +334,8 @@ jobs:
       - name: Generate clients
         run: yarn cli generate ${{ matrix.client.language }} ${{ matrix.client.toRun }}
 
+      # no need to build the clients here, it will be done in the Run CTS step anyway.
+
       - name: Update composer.lock
         if: ${{ matrix.client.language == 'php' && startsWith(github.head_ref, 'chore/renovateBaseBranch')  && matrix.client.isMainVersion }}
         run: cd ${{ matrix.client.path }} && composer update
@@ -346,9 +348,6 @@ jobs:
           find Sources  -type f | rev | cut -d '/' -f1 | rev | sort | uniq -d
           [ $(find Sources  -type f | rev | cut -d '/' -f1 | rev | sort | uniq -d | wc -l) -gt 0 ] && echo "Duplicates found" && exit 1 || echo "No duplicate found"
 
-      - name: Build clients
-        run: ${{ matrix.client.buildCommand }}
-
       - name: Build the playground
         run: yarn cli build playground ${{ matrix.client.language }}
 
@@ -419,7 +418,8 @@ jobs:
     runs-on: macos-latest
     needs:
       - setup
-      - client_gen
+      - specs
+      - scripts
     if: |
       always() &&
       needs.setup.outputs.RUN_GEN == 'true' &&
@@ -432,18 +432,19 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Download artifacts
+      - name: Download specs artifacts
         uses: ./scripts/ci/actions/restore-artifacts
         with:
-          type: languages
-          languages: |
-            kotlin
+          type: specs
 
       - name: Setup
         uses: ./.github/actions/setup
         with:
-          type: minimal
           language: kotlin
+          version: ${{ fromJSON(needs.setup.outputs.KOTLIN_DATA).version }}
+
+      - name: Generate clients
+        run: yarn cli generate kotlin ${{ fromJSON(needs.setup.outputs.KOTLIN_DATA).toRun }}
 
       - name: Build clients for macOS
         id: build
@@ -463,7 +464,8 @@ jobs:
     runs-on: macos-latest
     needs:
       - setup
-      - client_gen
+      - specs
+      - scripts
     if: |
       always() &&
       needs.setup.outputs.RUN_GEN == 'true' &&
@@ -481,22 +483,24 @@ jobs:
       - uses: actions/checkout@v4
         if: ${{ env.ALGOLIA_APPLICATION_ID != '' }}
 
-      - name: Download artifacts
+      - name: Download specs artifacts
         uses: ./scripts/ci/actions/restore-artifacts
-        if: ${{ env.ALGOLIA_APPLICATION_ID != '' }}
         with:
-          type: languages
-          languages: |
-            swift
+          type: specs
 
       - name: Setup
         uses: ./.github/actions/setup
         if: ${{ env.ALGOLIA_APPLICATION_ID != '' }}
         with:
-          type: minimal
           language: swift
           version: ${{ fromJSON(needs.setup.outputs.SWIFT_DATA).version }}
 
+      - name: Generate clients
+        run: yarn cli generate swift ${{ fromJSON(needs.setup.outputs.SWIFT_DATA).toRun }}
+
+      - name: Generate tests
+        run: yarn cli cts generate swift ${{ fromJSON(needs.setup.outputs.SWIFT_DATA).toRun }}
+
       - name: Run tests on macOS
         id: run-test
         if: ${{ env.ALGOLIA_APPLICATION_ID != '' }}

clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs

@@ -1494,8 +1494,8 @@ public partial interface ISearchClient
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
-  /// <returns>Task of UpdatedRuleResponse</returns>
-  Task<UpdatedRuleResponse> SaveRuleAsync(string indexName, string objectID, Rule rule, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
+  /// <returns>Task of UpdatedAtResponse</returns>
+  Task<UpdatedAtResponse> SaveRuleAsync(string indexName, string objectID, Rule rule, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
   /// If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced.  To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).  (Synchronous version)
@@ -1512,8 +1512,8 @@ public partial interface ISearchClient
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
-  /// <returns>UpdatedRuleResponse</returns>
-  UpdatedRuleResponse SaveRule(string indexName, string objectID, Rule rule, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
+  /// <returns>UpdatedAtResponse</returns>
+  UpdatedAtResponse SaveRule(string indexName, string objectID, Rule rule, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
   /// Create or update multiple rules.  If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced.  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia). 
@@ -3032,7 +3032,7 @@ public SaveObjectResponse SaveObject(string indexName, object body, RequestOptio
 
 
   /// <inheritdoc />
-  public async Task<UpdatedRuleResponse> SaveRuleAsync(string indexName, string objectID, Rule rule, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default)
+  public async Task<UpdatedAtResponse> SaveRuleAsync(string indexName, string objectID, Rule rule, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default)
   {
 
     if (indexName == null)
@@ -3053,12 +3053,12 @@ public async Task<UpdatedRuleResponse> SaveRuleAsync(string indexName, string ob
 
     requestOptions.AddQueryParameter("forwardToReplicas", forwardToReplicas);
     requestOptions.Data = rule;
-    return await _transport.ExecuteRequestAsync<UpdatedRuleResponse>(new HttpMethod("PUT"), "/1/indexes/{indexName}/rules/{objectID}", requestOptions, cancellationToken).ConfigureAwait(false);
+    return await _transport.ExecuteRequestAsync<UpdatedAtResponse>(new HttpMethod("PUT"), "/1/indexes/{indexName}/rules/{objectID}", requestOptions, cancellationToken).ConfigureAwait(false);
   }
 
 
   /// <inheritdoc />
-  public UpdatedRuleResponse SaveRule(string indexName, string objectID, Rule rule, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
+  public UpdatedAtResponse SaveRule(string indexName, string objectID, Rule rule, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
     AsyncHelper.RunSync(() => SaveRuleAsync(indexName, objectID, rule, forwardToReplicas, options, cancellationToken));
 
 

clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Rule.cs

@@ -25,9 +25,11 @@ public Rule() { }
   /// Initializes a new instance of the Rule class.
   /// </summary>
   /// <param name="objectID">Unique identifier of a rule object. (required).</param>
-  public Rule(string objectID)
+  /// <param name="consequence">consequence (required).</param>
+  public Rule(string objectID, Consequence consequence)
   {
     ObjectID = objectID ?? throw new ArgumentNullException(nameof(objectID));
+    Consequence = consequence ?? throw new ArgumentNullException(nameof(consequence));
   }
 
   /// <summary>

clients/algoliasearch-client-csharp/algoliasearch/Models/Search/UpdatedRuleResponse.cs

@@ -155,7 +155,6 @@ export 'src/model/typo_tolerance_enum.dart';
 export 'src/model/update_api_key_response.dart';
 export 'src/model/updated_at_response.dart';
 export 'src/model/updated_at_with_object_id_response.dart';
-export 'src/model/updated_rule_response.dart';
 export 'src/model/user_highlight_result.dart';
 export 'src/model/user_hit.dart';
 export 'src/model/user_id.dart';

clients/algoliasearch-client-dart/packages/client_search/lib/algolia_client_search.dart

@@ -62,7 +62,6 @@ import 'package:algolia_client_search/src/model/synonym_hit.dart';
 import 'package:algolia_client_search/src/model/update_api_key_response.dart';
 import 'package:algolia_client_search/src/model/updated_at_response.dart';
 import 'package:algolia_client_search/src/model/updated_at_with_object_id_response.dart';
-import 'package:algolia_client_search/src/model/updated_rule_response.dart';
 import 'package:algolia_client_search/src/model/user_id.dart';
 
 final class SearchClient implements ApiClient {
@@ -1770,7 +1769,7 @@ final class SearchClient implements ApiClient {
   /// * [rule]
   /// * [forwardToReplicas] Whether changes are applied to replica indices.
   /// * [requestOptions] additional request configuration.
-  Future<UpdatedRuleResponse> saveRule({
+  Future<UpdatedAtResponse> saveRule({
     required String indexName,
     required String objectID,
     required Rule rule,
@@ -1801,9 +1800,9 @@ final class SearchClient implements ApiClient {
       request: request,
       options: requestOptions,
     );
-    return deserialize<UpdatedRuleResponse, UpdatedRuleResponse>(
+    return deserialize<UpdatedAtResponse, UpdatedAtResponse>(
       response,
-      'UpdatedRuleResponse',
+      'UpdatedAtResponse',
       growable: true,
     );
   }

clients/algoliasearch-client-dart/packages/client_search/lib/src/api/search_client.dart

@@ -148,7 +148,6 @@ import 'package:algolia_client_search/src/model/typo_tolerance_enum.dart';
 import 'package:algolia_client_search/src/model/update_api_key_response.dart';
 import 'package:algolia_client_search/src/model/updated_at_response.dart';
 import 'package:algolia_client_search/src/model/updated_at_with_object_id_response.dart';
-import 'package:algolia_client_search/src/model/updated_rule_response.dart';
 import 'package:algolia_client_search/src/model/user_highlight_result.dart';
 import 'package:algolia_client_search/src/model/user_hit.dart';
 import 'package:algolia_client_search/src/model/user_id.dart';
@@ -565,9 +564,6 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
     case 'UpdatedAtWithObjectIdResponse':
       return UpdatedAtWithObjectIdResponse.fromJson(
           value as Map<String, dynamic>) as ReturnType;
-    case 'UpdatedRuleResponse':
-      return UpdatedRuleResponse.fromJson(value as Map<String, dynamic>)
-          as ReturnType;
     case 'UserHighlightResult':
       return UserHighlightResult.fromJson(value as Map<String, dynamic>)
           as ReturnType;

clients/algoliasearch-client-dart/packages/client_search/lib/src/deserialize.dart

@@ -14,7 +14,7 @@ final class Rule {
   const Rule({
     required this.objectID,
     this.conditions,
-    this.consequence,
+    required this.consequence,
     this.description,
     this.enabled,
     this.validity,
@@ -29,7 +29,7 @@ final class Rule {
   final List<Condition>? conditions;
 
   @JsonKey(name: r'consequence')
-  final Consequence? consequence;
+  final Consequence consequence;
 
   /// Description of the rule's purpose to help you distinguish between different rules.
   @JsonKey(name: r'description')