sdk/lib/model/openai_usage.dart

//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.18

// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars

part of hanzoai.cloud;

class OpenaiUsage {
  /// Returns a new [OpenaiUsage] instance.
  OpenaiUsage({
    this.completionTokens,
    this.completionTokensDetails,
    this.promptTokens,
    this.promptTokensDetails,
    this.totalTokens,
  });
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  int? completionTokens;

  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  OpenaiCompletionTokensDetails? completionTokensDetails;

  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  int? promptTokens;

  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  OpenaiPromptTokensDetails? promptTokensDetails;

  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  int? totalTokens;

  @override
  bool operator ==(Object other) => identical(this, other) || other is OpenaiUsage &&
    other.completionTokens == completionTokens &&
    other.completionTokensDetails == completionTokensDetails &&
    other.promptTokens == promptTokens &&
    other.promptTokensDetails == promptTokensDetails &&
    other.totalTokens == totalTokens;

  @override
  int get hashCode =>
    // ignore: unnecessary_parenthesis
    (completionTokens == null ? 0 : completionTokens!.hashCode) +
    (completionTokensDetails == null ? 0 : completionTokensDetails!.hashCode) +
    (promptTokens == null ? 0 : promptTokens!.hashCode) +
    (promptTokensDetails == null ? 0 : promptTokensDetails!.hashCode) +
    (totalTokens == null ? 0 : totalTokens!.hashCode);

  @override
  String toString() => 'OpenaiUsage[completionTokens=$completionTokens, completionTokensDetails=$completionTokensDetails, promptTokens=$promptTokens, promptTokensDetails=$promptTokensDetails, totalTokens=$totalTokens]';

  Map<String, dynamic> toJson() {
    final json = <String, dynamic>{};
    if (this.completionTokens != null) {
      json[r'completion_tokens'] = this.completionTokens;
    } else {
      json[r'completion_tokens'] = null;
    }
    if (this.completionTokensDetails != null) {
      json[r'completion_tokens_details'] = this.completionTokensDetails;
    } else {
      json[r'completion_tokens_details'] = null;
    }
    if (this.promptTokens != null) {
      json[r'prompt_tokens'] = this.promptTokens;
    } else {
      json[r'prompt_tokens'] = null;
    }
    if (this.promptTokensDetails != null) {
      json[r'prompt_tokens_details'] = this.promptTokensDetails;
    } else {
      json[r'prompt_tokens_details'] = null;
    }
    if (this.totalTokens != null) {
      json[r'total_tokens'] = this.totalTokens;
    } else {
      json[r'total_tokens'] = null;
    }
    return json;
  }

  /// Returns a new [OpenaiUsage] instance and imports its values from
  /// [value] if it's a [Map], null otherwise.
  // ignore: prefer_constructors_over_static_methods
  static OpenaiUsage? fromJson(dynamic value) {
    if (value is Map) {
      final json = value.cast<String, dynamic>();

      // Ensure that the map contains the required keys.
      // Note 1: the values aren't checked for validity beyond being non-null.
      // Note 2: this code is stripped in release mode!
      assert(() {
        requiredKeys.forEach((key) {
          assert(json.containsKey(key), 'Required key "OpenaiUsage[$key]" is missing from JSON.');
          assert(json[key] != null, 'Required key "OpenaiUsage[$key]" has a null value in JSON.');
        });
        return true;
      }());

      return OpenaiUsage(
        completionTokens: mapValueOfType<int>(json, r'completion_tokens'),
        completionTokensDetails: OpenaiCompletionTokensDetails.fromJson(json[r'completion_tokens_details']),
        promptTokens: mapValueOfType<int>(json, r'prompt_tokens'),
        promptTokensDetails: OpenaiPromptTokensDetails.fromJson(json[r'prompt_tokens_details']),
        totalTokens: mapValueOfType<int>(json, r'total_tokens'),
      );
    }
    return null;
  }

  static List<OpenaiUsage> listFromJson(dynamic json, {bool growable = false,}) {
    final result = <OpenaiUsage>[];
    if (json is List && json.isNotEmpty) {
      for (final row in json) {
        final value = OpenaiUsage.fromJson(row);
        if (value != null) {
          result.add(value);
        }
      }
    }
    return result.toList(growable: growable);
  }

  static Map<String, OpenaiUsage> mapFromJson(dynamic json) {
    final map = <String, OpenaiUsage>{};
    if (json is Map && json.isNotEmpty) {
      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
      for (final entry in json.entries) {
        final value = OpenaiUsage.fromJson(entry.value);
        if (value != null) {
          map[entry.key] = value;
        }
      }
    }
    return map;
  }

  // maps a json object with a list of OpenaiUsage-objects as value to a dart map
  static Map<String, List<OpenaiUsage>> mapListFromJson(dynamic json, {bool growable = false,}) {
    final map = <String, List<OpenaiUsage>>{};
    if (json is Map && json.isNotEmpty) {
      // ignore: parameter_assignments
      json = json.cast<String, dynamic>();
      for (final entry in json.entries) {
        map[entry.key] = OpenaiUsage.listFromJson(entry.value, growable: growable,);
      }
    }
    return map;
  }

  /// The list of required keys that must be present in a JSON.
  static const requiredKeys = <String>{
  };
}