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

algolia/api-clients-automation#4931

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

packages/client_search/lib/algolia_client_search.dart

@@ -59,6 +59,9 @@ export 'src/model/dictionary_type.dart';
 export 'src/model/edit.dart';
 export 'src/model/edit_type.dart';
 export 'src/model/error_base.dart';
+export 'src/model/event.dart';
+export 'src/model/event_status.dart';
+export 'src/model/event_type.dart';
 export 'src/model/exact_on_single_word_query.dart';
 export 'src/model/exhaustive.dart';
 export 'src/model/facet_hits.dart';
@@ -159,6 +162,7 @@ export 'src/model/user_highlight_result.dart';
 export 'src/model/user_hit.dart';
 export 'src/model/user_id.dart';
 export 'src/model/value.dart';
+export 'src/model/watch_response.dart';
 export 'src/model/widgets.dart';
 export 'src/model/with_primary.dart';
 

packages/client_search/lib/src/deserialize.dart

@@ -52,6 +52,9 @@ import 'package:algolia_client_search/src/model/dictionary_type.dart';
 import 'package:algolia_client_search/src/model/edit.dart';
 import 'package:algolia_client_search/src/model/edit_type.dart';
 import 'package:algolia_client_search/src/model/error_base.dart';
+import 'package:algolia_client_search/src/model/event.dart';
+import 'package:algolia_client_search/src/model/event_status.dart';
+import 'package:algolia_client_search/src/model/event_type.dart';
 import 'package:algolia_client_search/src/model/exact_on_single_word_query.dart';
 import 'package:algolia_client_search/src/model/exhaustive.dart';
 import 'package:algolia_client_search/src/model/facet_hits.dart';
@@ -152,6 +155,7 @@ 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';
 import 'package:algolia_client_search/src/model/value.dart';
+import 'package:algolia_client_search/src/model/watch_response.dart';
 import 'package:algolia_client_search/src/model/widgets.dart';
 import 'package:algolia_client_search/src/model/with_primary.dart';
 
@@ -311,6 +315,12 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
       return EditType.fromJson(value) as ReturnType;
     case 'ErrorBase':
       return ErrorBase.fromJson(value as Map<String, dynamic>) as ReturnType;
+    case 'Event':
+      return Event.fromJson(value as Map<String, dynamic>) as ReturnType;
+    case 'EventStatus':
+      return EventStatus.fromJson(value) as ReturnType;
+    case 'EventType':
+      return EventType.fromJson(value) as ReturnType;
     case 'ExactOnSingleWordQuery':
       return ExactOnSingleWordQuery.fromJson(value) as ReturnType;
     case 'Exhaustive':
@@ -573,6 +583,9 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
       return UserId.fromJson(value as Map<String, dynamic>) as ReturnType;
     case 'Value':
       return Value.fromJson(value as Map<String, dynamic>) as ReturnType;
+    case 'WatchResponse':
+      return WatchResponse.fromJson(value as Map<String, dynamic>)
+          as ReturnType;
     case 'Widgets':
       return Widgets.fromJson(value as Map<String, dynamic>) as ReturnType;
     case 'WithPrimary':

packages/client_search/lib/src/model/event.dart

@@ -0,0 +1,79 @@
+// 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.
+// ignore_for_file: unused_element
+import 'package:algolia_client_search/src/model/event_status.dart';
+import 'package:algolia_client_search/src/model/event_type.dart';
+
+import 'package:json_annotation/json_annotation.dart';
+
+part 'event.g.dart';
+
+@JsonSerializable()
+final class Event {
+  /// Returns a new [Event] instance.
+  const Event({
+    required this.eventID,
+    required this.runID,
+    required this.status,
+    required this.type,
+    required this.batchSize,
+    this.data,
+    required this.publishedAt,
+  });
+
+  /// Universally unique identifier (UUID) of an event.
+  @JsonKey(name: r'eventID')
+  final String eventID;
+
+  /// Universally unique identifier (UUID) of a task run.
+  @JsonKey(name: r'runID')
+  final String runID;
+
+  @JsonKey(name: r'status')
+  final EventStatus? status;
+
+  @JsonKey(name: r'type')
+  final EventType type;
+
+  /// The extracted record batch size.
+  // minimum: 0
+  @JsonKey(name: r'batchSize')
+  final int batchSize;
+
+  @JsonKey(name: r'data')
+  final Map<String, Object>? data;
+
+  /// Date of publish RFC 3339 format.
+  @JsonKey(name: r'publishedAt')
+  final String publishedAt;
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is Event &&
+          other.eventID == eventID &&
+          other.runID == runID &&
+          other.status == status &&
+          other.type == type &&
+          other.batchSize == batchSize &&
+          other.data == data &&
+          other.publishedAt == publishedAt;
+
+  @override
+  int get hashCode =>
+      eventID.hashCode +
+      runID.hashCode +
+      (status == null ? 0 : status.hashCode) +
+      type.hashCode +
+      batchSize.hashCode +
+      (data == null ? 0 : data.hashCode) +
+      publishedAt.hashCode;
+
+  factory Event.fromJson(Map<String, dynamic> json) => _$EventFromJson(json);
+
+  Map<String, dynamic> toJson() => _$EventToJson(this);
+
+  @override
+  String toString() {
+    return toJson().toString();
+  }
+}

packages/client_search/lib/src/model/event.g.dart

@@ -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.
+// ignore_for_file: unused_element
+import 'package:json_annotation/json_annotation.dart';
+
+@JsonEnum(valueField: 'raw')
+enum EventStatus {
+  created(r'created'),
+  started(r'started'),
+  retried(r'retried'),
+  failed(r'failed'),
+  succeeded(r'succeeded'),
+  critical(r'critical');
+
+  const EventStatus(this.raw);
+  final dynamic raw;
+
+  dynamic toJson() => raw;
+
+  static EventStatus fromJson(dynamic json) {
+    for (final value in values) {
+      if (value.raw == json) return value;
+    }
+    throw ArgumentError.value(json, "raw", "No enum value with that value");
+  }
+
+  @override
+  String toString() => raw.toString();
+}

packages/client_search/lib/src/model/event_status.dart

@@ -0,0 +1,26 @@
+// 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.
+// ignore_for_file: unused_element
+import 'package:json_annotation/json_annotation.dart';
+
+@JsonEnum(valueField: 'raw')
+enum EventType {
+  fetch(r'fetch'),
+  record(r'record'),
+  log(r'log'),
+  transform(r'transform');
+
+  const EventType(this.raw);
+  final dynamic raw;
+
+  dynamic toJson() => raw;
+
+  static EventType fromJson(dynamic json) {
+    for (final value in values) {
+      if (value.raw == json) return value;
+    }
+    throw ArgumentError.value(json, "raw", "No enum value with that value");
+  }
+
+  @override
+  String toString() => raw.toString();
+}

packages/client_search/lib/src/model/event_type.dart

@@ -0,0 +1,74 @@
+// 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.
+// ignore_for_file: unused_element
+import 'package:algolia_client_search/src/model/event.dart';
+
+import 'package:json_annotation/json_annotation.dart';
+
+part 'watch_response.g.dart';
+
+@JsonSerializable()
+final class WatchResponse {
+  /// Returns a new [WatchResponse] instance.
+  const WatchResponse({
+    required this.runID,
+    this.eventID,
+    this.data,
+    this.events,
+    this.message,
+    this.createdAt,
+  });
+
+  /// Universally unique identifier (UUID) of a task run.
+  @JsonKey(name: r'runID')
+  final String runID;
+
+  /// Universally unique identifier (UUID) of an event.
+  @JsonKey(name: r'eventID')
+  final String? eventID;
+
+  /// 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.
+  @JsonKey(name: r'data')
+  final List<Object>? data;
+
+  /// in case of error, observability events will be added to the response.
+  @JsonKey(name: r'events')
+  final List<Event>? events;
+
+  /// a message describing the outcome of the operation that has been ran (push, discover or validate) run.
+  @JsonKey(name: r'message')
+  final String? message;
+
+  /// Date of creation in RFC 3339 format.
+  @JsonKey(name: r'createdAt')
+  final String? createdAt;
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is WatchResponse &&
+          other.runID == runID &&
+          other.eventID == eventID &&
+          other.data == data &&
+          other.events == events &&
+          other.message == message &&
+          other.createdAt == createdAt;
+
+  @override
+  int get hashCode =>
+      runID.hashCode +
+      eventID.hashCode +
+      data.hashCode +
+      events.hashCode +
+      message.hashCode +
+      createdAt.hashCode;
+
+  factory WatchResponse.fromJson(Map<String, dynamic> json) =>
+      _$WatchResponseFromJson(json);
+
+  Map<String, dynamic> toJson() => _$WatchResponseToJson(this);
+
+  @override
+  String toString() {
+    return toJson().toString();
+  }
+}