Skip to content

Commit

Permalink
fix(specs): partial update operation (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3486

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
Co-authored-by: shortcuts <vannicattec@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
  • Loading branch information
4 people committed Aug 28, 2024
1 parent ab21d85 commit 50f2e6a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
21 changes: 18 additions & 3 deletions src/main/scala/algoliasearch/api/SearchClient.scala
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import algoliasearch.search.AddApiKeyResponse
import algoliasearch.search.ApiKey
import algoliasearch.search.ApiKeyOperation._
import algoliasearch.search.AssignUserIdParams
import algoliasearch.search.AttributeToUpdate
import algoliasearch.search.BatchAssignUserIdsParams
import algoliasearch.search.BatchDictionaryEntriesParams
import algoliasearch.search.BatchParams
Expand Down Expand Up @@ -1185,7 +1184,23 @@ class SearchClient(
/** Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't
* exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet,
* this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify
* a nested attribute, the engine treats it as a replacement for its first-level ancestor.
* a nested attribute, the engine treats it as a replacement for its first-level ancestor. To update an attribute
* without pushing the entire record, you can use these built-in operations. These operations can be helpful if you
* don't have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a
* numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching
* number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string
* element to an array attribute made of numbers or strings only if it's not already present - IncrementFrom:
* increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore
* the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the
* current value of the attribute is 1, the engine ignores the update. If the object doesn't exist, the engine only
* creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if
* the provided value is greater than the current value, and otherwise ignore the whole object update. For example,
* if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the
* engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet
* value that's greater than 0. You can specify an operation by providing an object with the attribute to update as
* the key and its value being an object with the following properties: - _operation: the operation to apply on the
* attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value
* to add or remove.
*
* Required API Key ACLs:
* - addObject
Expand All @@ -1202,7 +1217,7 @@ class SearchClient(
def partialUpdateObject(
indexName: String,
objectID: String,
attributesToUpdate: Map[String, AttributeToUpdate],
attributesToUpdate: Any,
createIfNotExists: Option[Boolean] = None,
requestOptions: Option[RequestOptions] = None
)(implicit ec: ExecutionContext): Future[UpdatedAtWithObjectIdResponse] = Future {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import algoliasearch.search.BuiltInOperationType._
import org.json4s._

/** AttributeToUpdate
* @deprecated
*/
sealed trait AttributeToUpdate

Expand Down

0 comments on commit 50f2e6a

Please sign in to comment.