// 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.

import Foundation
import GoogleCloudWkt

/// The event being assessed.
public struct Event: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Optional. The user response token provided by the reCAPTCHA Enterprise
  /// client-side integration on your site.
  public var token: Swift.String = Swift.String()

  /// Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
  /// site and generate the token.
  public var siteKey: Swift.String = Swift.String()

  /// Optional. The user agent present in the request from the user's device
  /// related to this event.
  public var userAgent: Swift.String = Swift.String()

  /// Optional. The IP address in the request from the user's device related to
  /// this event.
  public var userIpAddress: Swift.String = Swift.String()

  /// Optional. The expected action for this type of event. This should be the
  /// same action provided at token generation time on client-side platforms
  /// already integrated with recaptcha enterprise.
  public var expectedAction: Swift.String = Swift.String()

  /// Optional. Deprecated: use `user_info.account_id` instead.
  /// Unique stable hashed user identifier for the request. The identifier must
  /// be hashed using hmac-sha256 with stable secret.
  @available(*, deprecated)
  public var hashedAccountId: Foundation.Data = Foundation.Data()

  /// Optional. Flag for a reCAPTCHA express request for an assessment without a
  /// token. If enabled, `site_key` must reference an Express site key.
  public var express: Swift.Bool = Swift.Bool()

  /// Optional. The URI resource the user requested that triggered an assessment.
  public var requestedUri: Swift.String = Swift.String()

  /// Optional. Flag for running Web Application Firewall (WAF) token assessment.
  /// If enabled, the token must be specified, and have been created by a
  /// WAF-enabled key.
  public var wafTokenAssessment: Swift.Bool = Swift.Bool()

  /// Optional. JA3 fingerprint for SSL clients. To learn how to compute this
  /// fingerprint, please refer to https://github.com/salesforce/ja3.
  public var ja3: Swift.String = Swift.String()

  /// Optional. JA4 fingerprint for SSL clients. To learn how to compute this
  /// fingerprint, please refer to https://github.com/FoxIO-LLC/ja4.
  public var ja4: Swift.String = Swift.String()

  /// Optional. HTTP header information about the request.
  public var headers: [Swift.String] = []

  /// Optional. Flag for enabling firewall policy config assessment.
  /// If this flag is enabled, the firewall policy is evaluated and a
  /// suggested firewall action is returned in the response.
  public var firewallPolicyEvaluation: Swift.Bool = Swift.Bool()

  /// Optional. Data describing a payment transaction to be assessed. Sending
  /// this data enables reCAPTCHA Enterprise Fraud Prevention and the
  /// FraudPreventionAssessment component in the response.
  public var transactionData: TransactionData? = nil

  /// Optional. Information about the user that generates this event, when they
  /// can be identified. They are often identified through the use of an account
  /// for logged-in requests or login/registration requests, or by providing user
  /// identifiers for guest actions like checkout.
  public var userInfo: UserInfo? = nil

  /// Optional. The Fraud Prevention setting for this assessment.
  public var fraudPrevention: Event.FraudPrevention = Event.FraudPrevention()

  /// Initialize a new instance of `Event`.
  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 = Event().with { $0.token = ... }
  /// ```
  public func with(_ config: (inout Self) throws -> Swift.Void) rethrows -> Self {
    var copy = self
    try config(&copy)
    return copy
  }

  /// Setting that controls Fraud Prevention assessments.
  /// Ensure that applications can handle values not explicitly listed.
  public enum FraudPrevention: Codable, Equatable, Sendable {
    /// Default, unspecified setting. `fraud_prevention_assessment` is returned
    /// if `transaction_data` is present in `Event` and Fraud Prevention is
    /// enabled in the Google Cloud console.
    case unspecified
    /// Enable Fraud Prevention for this assessment, if Fraud Prevention is
    /// enabled in the Google Cloud console.
    case enabled
    /// Disable Fraud Prevention for this assessment, regardless of the Google
    /// Cloud console settings.
    case disabled
    /// 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 .enabled: return 1
      case .disabled: return 2
      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 "FRAUD_PREVENTION_UNSPECIFIED"
      case .enabled: return "ENABLED"
      case .disabled: return "DISABLED"
      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:FraudPrevention/unknownStringValue(_:)).
    public init(stringValue: Swift.String) {
      switch stringValue {
      case "FRAUD_PREVENTION_UNSPECIFIED": self = .unspecified
      case "ENABLED": self = .enabled
      case "DISABLED": self = .disabled
      default: self = .unknownStringValue(stringValue)
      }
    }

    /// Initialize from an integer value.
    ///
    /// If the value is unknown, this initializes to [`unknownIntValue`](doc:FraudPrevention/unknownIntValue(_:)).
    public init(intValue: Int) {
      switch intValue {
      case 0: self = .unspecified
      case 1: self = .enabled
      case 2: self = .disabled
      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 .enabled: return try container.encode(1)
      case .disabled: return try container.encode(2)
      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.recaptchaenterprise.v1.Event"
  }
  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)
  }
}
