feat(specs): add with transformation helpers (generated)

algolia/api-clients-automation#4931

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>

Author: algolia-bot

client/src/commonMain/kotlin/com/algolia/client/model/ingestion/WatchResponse.kt

@@ -9,9 +9,9 @@ import kotlinx.serialization.json.*
  *
  * @param runID Universally unique identifier (UUID) of a task run.
  * @param eventID Universally unique identifier (UUID) of an event.
- * @param `data` when used with discovering or validating sources, the sampled data of your source is returned.
- * @param events in case of error, observability events will be added to the response, if any.
- * @param message a message describing the outcome of a validate run.
+ * @param `data` This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.
+ * @param events in case of error, observability events will be added to the response.
+ * @param message a message describing the outcome of the operation that has been ran (push, discover or validate) run.
  * @param createdAt Date of creation in RFC 3339 format.
  */
 @Serializable
@@ -23,13 +23,13 @@ public data class WatchResponse(
   /** Universally unique identifier (UUID) of an event. */
   @SerialName(value = "eventID") val eventID: String? = null,
 
-  /** when used with discovering or validating sources, the sampled data of your source is returned. */
+  /** This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.  */
   @SerialName(value = "data") val `data`: List<JsonObject>? = null,
 
-  /** in case of error, observability events will be added to the response, if any. */
+  /** in case of error, observability events will be added to the response. */
   @SerialName(value = "events") val events: List<Event>? = null,
 
-  /** a message describing the outcome of a validate run. */
+  /** a message describing the outcome of the operation that has been ran (push, discover or validate) run. */
   @SerialName(value = "message") val message: String? = null,
 
   /** Date of creation in RFC 3339 format. */

client/src/commonMain/kotlin/com/algolia/client/model/search/Event.kt

@@ -0,0 +1,38 @@
+/** 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. */
+package com.algolia.client.model.search
+
+import kotlinx.serialization.*
+import kotlinx.serialization.json.*
+
+/**
+ * An event describe a step of the task execution flow..
+ *
+ * @param eventID Universally unique identifier (UUID) of an event.
+ * @param runID Universally unique identifier (UUID) of a task run.
+ * @param status
+ * @param type
+ * @param batchSize The extracted record batch size.
+ * @param publishedAt Date of publish RFC 3339 format.
+ * @param `data`
+ */
+@Serializable
+public data class Event(
+
+  /** Universally unique identifier (UUID) of an event. */
+  @SerialName(value = "eventID") val eventID: String,
+
+  /** Universally unique identifier (UUID) of a task run. */
+  @SerialName(value = "runID") val runID: String,
+
+  @SerialName(value = "status") val status: EventStatus,
+
+  @SerialName(value = "type") val type: EventType,
+
+  /** The extracted record batch size. */
+  @SerialName(value = "batchSize") val batchSize: Int,
+
+  /** Date of publish RFC 3339 format. */
+  @SerialName(value = "publishedAt") val publishedAt: String,
+
+  @SerialName(value = "data") val `data`: JsonObject? = null,
+)

client/src/commonMain/kotlin/com/algolia/client/model/search/EventStatus.kt

@@ -0,0 +1,28 @@
+/** 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. */
+package com.algolia.client.model.search
+
+import kotlinx.serialization.*
+
+@Serializable
+public enum class EventStatus(public val value: kotlin.String) {
+
+  @SerialName(value = "created")
+  Created("created"),
+
+  @SerialName(value = "started")
+  Started("started"),
+
+  @SerialName(value = "retried")
+  Retried("retried"),
+
+  @SerialName(value = "failed")
+  Failed("failed"),
+
+  @SerialName(value = "succeeded")
+  Succeeded("succeeded"),
+
+  @SerialName(value = "critical")
+  Critical("critical");
+
+  override fun toString(): kotlin.String = value
+}

client/src/commonMain/kotlin/com/algolia/client/model/search/EventType.kt

@@ -0,0 +1,22 @@
+/** 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. */
+package com.algolia.client.model.search
+
+import kotlinx.serialization.*
+
+@Serializable
+public enum class EventType(public val value: kotlin.String) {
+
+  @SerialName(value = "fetch")
+  Fetch("fetch"),
+
+  @SerialName(value = "record")
+  Record("record"),
+
+  @SerialName(value = "log")
+  Log("log"),
+
+  @SerialName(value = "transform")
+  Transform("transform");
+
+  override fun toString(): kotlin.String = value
+}

client/src/commonMain/kotlin/com/algolia/client/model/search/WatchResponse.kt

@@ -0,0 +1,37 @@
+/** 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. */
+package com.algolia.client.model.search
+
+import kotlinx.serialization.*
+import kotlinx.serialization.json.*
+
+/**
+ * WatchResponse
+ *
+ * @param runID Universally unique identifier (UUID) of a task run.
+ * @param eventID Universally unique identifier (UUID) of an event.
+ * @param `data` This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.
+ * @param events in case of error, observability events will be added to the response.
+ * @param message a message describing the outcome of the operation that has been ran (push, discover or validate) run.
+ * @param createdAt Date of creation in RFC 3339 format.
+ */
+@Serializable
+public data class WatchResponse(
+
+  /** Universally unique identifier (UUID) of a task run. */
+  @SerialName(value = "runID") val runID: String,
+
+  /** Universally unique identifier (UUID) of an event. */
+  @SerialName(value = "eventID") val eventID: String? = null,
+
+  /** This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.  */
+  @SerialName(value = "data") val `data`: List<JsonObject>? = null,
+
+  /** in case of error, observability events will be added to the response. */
+  @SerialName(value = "events") val events: List<Event>? = null,
+
+  /** a message describing the outcome of the operation that has been ran (push, discover or validate) run. */
+  @SerialName(value = "message") val message: String? = null,
+
+  /** Date of creation in RFC 3339 format. */
+  @SerialName(value = "createdAt") val createdAt: String? = null,
+)