// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import Foundation

/// An internal data model for `ModelStatus`.
///
/// ### Gemini Developer API
///
/// Type: `GoogleAiGenerativelanguageV1betaModelStatus`
///
/// The status of the underlying model. This is used to indicate the stage of the
/// underlying model and the retirement time if applicable.
///
/// ### Gemini Enterprise API
///
/// > Important: This type is not supported in the Gemini Enterprise API.
package struct ModelStatus: Codable, Sendable, Equatable, Hashable {
  /// The stage of the underlying model.
  ///
  /// ### Gemini Developer API
  ///
  /// The stage of the underlying model.
  ///
  /// ### Gemini Enterprise API
  ///
  /// > Important: This property is not supported in the Gemini Enterprise API.
  package let modelStage: ModelStage?

  /// The time at which the model will be retired.
  ///
  /// ### Gemini Developer API
  ///
  /// The time at which the model will be retired.
  ///
  /// ### Gemini Enterprise API
  ///
  /// > Important: This property is not supported in the Gemini Enterprise API.
  package let retirementTime: String?

  /// A message explaining the model status.
  ///
  /// ### Gemini Developer API
  ///
  /// A message explaining the model status.
  ///
  /// ### Gemini Enterprise API
  ///
  /// > Important: This property is not supported in the Gemini Enterprise API.
  package let message: String?

  /// Creates a new `ModelStatus`.
  ///
  /// - Parameters:
  ///   - modelStage: The stage of the underlying model. (Gemini Developer API only). For more details, see ``modelStage``.
  ///   - retirementTime: The time at which the model will be retired. (Gemini Developer API only). For more details, see ``retirementTime``.
  ///   - message: A message explaining the model status. (Gemini Developer API only). For more details, see ``message``.
  package init(
    modelStage: ModelStage? = nil,
    retirementTime: String? = nil,
    message: String? = nil
  ) {
    self.modelStage = modelStage
    self.retirementTime = retirementTime
    self.message = message
  }
  enum CodingKeys: String, CodingKey {
    case modelStage = "modelStage"
    case retirementTime = "retirementTime"
    case message = "message"
  }
}