// Code generated by sidekick. DO NOT EDIT.
//
// 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
//
//     https://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.

#if ConversationProfiles || Conversations
  import Foundation
  import GoogleCloudWkt

  /// The type of Human Agent Assistant API suggestion to perform, and the maximum
  /// number of results to return for that type. Multiple `Feature` objects can
  /// be specified in the `features` list.
  public struct SuggestionFeature: Codable, Equatable, GoogleCloudWkt._AnyPackable,
    Sendable
  {
    /// Type of Human Agent Assistant API feature to request.
    public var type: SuggestionFeature.Type_ = SuggestionFeature.Type_()

    /// Initialize a new instance of `SuggestionFeature`.
    public init() {}

    /// Use `config` to return a new instance of this object, with some fields updated.
    ///
    /// Commonly used to initialize the value, for example:
    ///
    /// ```
    /// let value = SuggestionFeature().with { $0.type = ... }
    /// ```
    public func with(_ config: (inout Self) throws -> Swift.Void) rethrows -> Self {
      var copy = self
      try config(&copy)
      return copy
    }

    /// Defines the type of Human Agent Assistant feature.
    public enum Type_: Codable, Equatable, Sendable {
      /// Unspecified feature type.
      case unspecified
      /// Run article suggestion model for chat.
      case articleSuggestion
      /// Run FAQ model for chat.
      case faq
      /// Run smart reply model for chat.
      case smartReply
      /// Run conversation summarization model for chat.
      case conversationSummarization
      /// Run knowledge search with text input from agent or text generated query.
      case knowledgeSearch
      /// Run knowledge assist with automatic query generation.
      case knowledgeAssist
      /// Encodes an unknown integer value.
      ///
      /// The most common cause for an unknown values is for the service to send
      /// a value unknown to the library. We recommend you update your library to
      /// the latest version.
      case unknownIntValue(Int)
      /// Encodes an unknown string value.
      ///
      /// The most common cause for an unknown values is for the service to send
      /// a value unknown to the library. We recommend you update your library to
      /// the latest version.
      case unknownStringValue(String)

      public init() {
        self = .unspecified
      }

      /// Returns the integer value associated with the enumeration.
      ///
      /// If the enumeration was initialized with an unknown string value, this returns `nil`.
      public var intValue: Int? {
        switch self {
        case .unspecified: return 0
        case .articleSuggestion: return 1
        case .faq: return 2
        case .smartReply: return 3
        case .conversationSummarization: return 8
        case .knowledgeSearch: return 14
        case .knowledgeAssist: return 15
        case .unknownIntValue(let v): return v
        case .unknownStringValue: return nil
        }
      }

      /// Returns the string value (or name) associated with the enumeration.
      ///
      /// If the enumeration was initialized with an unknown integer value, this returns `nil`.
      public var stringValue: Swift.String? {
        switch self {
        case .unspecified: return "TYPE_UNSPECIFIED"
        case .articleSuggestion: return "ARTICLE_SUGGESTION"
        case .faq: return "FAQ"
        case .smartReply: return "SMART_REPLY"
        case .conversationSummarization: return "CONVERSATION_SUMMARIZATION"
        case .knowledgeSearch: return "KNOWLEDGE_SEARCH"
        case .knowledgeAssist: return "KNOWLEDGE_ASSIST"
        case .unknownIntValue: return nil
        case .unknownStringValue(let v): return v
        }
      }

      /// Initialize from a string value.
      ///
      /// If the value is unknown, this initializes to [`unknownStringValue`](doc:Type_/unknownStringValue(_:)).
      public init(stringValue: Swift.String) {
        switch stringValue {
        case "TYPE_UNSPECIFIED": self = .unspecified
        case "ARTICLE_SUGGESTION": self = .articleSuggestion
        case "FAQ": self = .faq
        case "SMART_REPLY": self = .smartReply
        case "CONVERSATION_SUMMARIZATION": self = .conversationSummarization
        case "KNOWLEDGE_SEARCH": self = .knowledgeSearch
        case "KNOWLEDGE_ASSIST": self = .knowledgeAssist
        default: self = .unknownStringValue(stringValue)
        }
      }

      /// Initialize from an integer value.
      ///
      /// If the value is unknown, this initializes to [`unknownIntValue`](doc:Type_/unknownIntValue(_:)).
      public init(intValue: Int) {
        switch intValue {
        case 0: self = .unspecified
        case 1: self = .articleSuggestion
        case 2: self = .faq
        case 3: self = .smartReply
        case 8: self = .conversationSummarization
        case 14: self = .knowledgeSearch
        case 15: self = .knowledgeAssist
        default: self = .unknownIntValue(intValue)
        }
      }

      public init(from decoder: Decoder) throws {
        let container = try decoder.singleValueContainer()
        if let v = try? container.decode(Int.self) {
          self.init(intValue: v)
          return
        }
        if let s = try? container.decode(String.self) {
          if let v = Int(s) {
            self.init(intValue: v)
          } else {
            self.init(stringValue: s)
          }
          return
        }
        throw DecodingError.dataCorruptedError(
          in: container, debugDescription: "Expected enum value, must be integer or string.")
      }

      public func encode(to encoder: Encoder) throws {
        var container = encoder.singleValueContainer()
        switch self {
        case .unspecified: return try container.encode(0)
        case .articleSuggestion: return try container.encode(1)
        case .faq: return try container.encode(2)
        case .smartReply: return try container.encode(3)
        case .conversationSummarization: return try container.encode(8)
        case .knowledgeSearch: return try container.encode(14)
        case .knowledgeAssist: return try container.encode(15)
        case .unknownIntValue(let v): return try container.encode(v)
        case .unknownStringValue(let v): return try container.encode(v)
        }
      }
    }

    public static var _anyTypeUrl: Swift.String {
      return "type.googleapis.com/google.cloud.dialogflow.v2.SuggestionFeature"
    }
    public init(fromAny any: GoogleCloudWkt.`Any`) throws {
      self = try GoogleCloudWkt._slowAnyDeserialize(Self.self, from: any)
    }
    public func _pack() throws -> GoogleCloudWkt.Struct {
      return try GoogleCloudWkt._slowAnySerialize(message: self)
    }
  }
#endif
