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

/// Request message for
/// [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory]
/// method.
///
/// [google.cloud.retail.v2.ProductService.SetInventory]: <doc:ProductService/setInventory(request:)>
public struct SetInventoryRequest: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Required. The inventory information to update. The allowable fields to
  /// update are:
  ///
  /// * [Product.price_info][google.cloud.retail.v2.Product.price_info]
  /// * [Product.availability][google.cloud.retail.v2.Product.availability]
  /// * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
  /// * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
  /// The updated inventory fields must be specified in
  /// [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask].
  ///
  /// If
  /// [SetInventoryRequest.inventory.name][google.cloud.retail.v2.Product.name]
  /// is empty or invalid, an INVALID_ARGUMENT error is returned.
  ///
  /// If the caller does not have permission to update the
  /// [Product][google.cloud.retail.v2.Product] named in
  /// [Product.name][google.cloud.retail.v2.Product.name], regardless of whether
  /// or not it exists, a PERMISSION_DENIED error is returned.
  ///
  /// If the [Product][google.cloud.retail.v2.Product] to update does not have
  /// existing inventory information, the provided inventory information will be
  /// inserted.
  ///
  /// If the [Product][google.cloud.retail.v2.Product] to update has existing
  /// inventory information, the provided inventory information will be merged
  /// while respecting the last update time for each inventory field, using the
  /// provided or default value for
  /// [SetInventoryRequest.set_time][google.cloud.retail.v2.SetInventoryRequest.set_time].
  ///
  /// The caller can replace place IDs for a subset of fulfillment types in the
  /// following ways:
  ///
  /// * Adds "fulfillment_info" in
  /// [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask]
  /// * Specifies only the desired fulfillment types and corresponding place IDs
  /// to update in
  /// [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
  ///
  /// The caller can clear all place IDs from a subset of fulfillment types in
  /// the following ways:
  ///
  /// * Adds "fulfillment_info" in
  /// [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask]
  /// * Specifies only the desired fulfillment types to clear in
  /// [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
  /// * Checks that only the desired fulfillment info types have empty
  /// [SetInventoryRequest.inventory.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
  ///
  /// The last update time is recorded for the following inventory fields:
  /// * [Product.price_info][google.cloud.retail.v2.Product.price_info]
  /// * [Product.availability][google.cloud.retail.v2.Product.availability]
  /// * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
  /// * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
  ///
  /// If a full overwrite of inventory information while ignoring timestamps is
  /// needed,
  /// [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
  /// should be invoked instead.
  ///
  /// [google.cloud.retail.v2.FulfillmentInfo.place_ids]: <doc:FulfillmentInfo/placeIds>
  /// [google.cloud.retail.v2.Product]: <doc:Product>
  /// [google.cloud.retail.v2.Product.availability]: <doc:Product/availability>
  /// [google.cloud.retail.v2.Product.available_quantity]: <doc:Product/availableQuantity>
  /// [google.cloud.retail.v2.Product.fulfillment_info]: <doc:Product/fulfillmentInfo>
  /// [google.cloud.retail.v2.Product.name]: <doc:Product/name>
  /// [google.cloud.retail.v2.Product.price_info]: <doc:Product/priceInfo>
  /// [google.cloud.retail.v2.ProductService.UpdateProduct]: <doc:ProductService/updateProduct(request:)>
  /// [google.cloud.retail.v2.SetInventoryRequest.set_mask]: <doc:SetInventoryRequest/setMask>
  /// [google.cloud.retail.v2.SetInventoryRequest.set_time]: <doc:SetInventoryRequest/setTime>
  public var inventory: Product? = nil

  /// Indicates which inventory fields in the provided
  /// [Product][google.cloud.retail.v2.Product] to update.
  ///
  /// At least one field must be provided.
  ///
  /// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
  /// is returned and the entire update will be ignored.
  ///
  /// [google.cloud.retail.v2.Product]: <doc:Product>
  public var setMask: GoogleCloudWkt.FieldMask? = nil

  /// The time when the request is issued, used to prevent
  /// out-of-order updates on inventory fields with the last update time
  /// recorded. If not provided, the internal system time will be used.
  public var setTime: GoogleCloudWkt.Timestamp? = nil

  /// If set to true, and the [Product][google.cloud.retail.v2.Product] with name
  /// [Product.name][google.cloud.retail.v2.Product.name] is not found, the
  /// inventory update will still be processed and retained for at most 1 day
  /// until the [Product][google.cloud.retail.v2.Product] is created. If set to
  /// false, a NOT_FOUND error is returned if the
  /// [Product][google.cloud.retail.v2.Product] is not found.
  ///
  /// [google.cloud.retail.v2.Product]: <doc:Product>
  /// [google.cloud.retail.v2.Product.name]: <doc:Product/name>
  public var allowMissing: Swift.Bool = Swift.Bool()

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

  public static var _anyTypeUrl: Swift.String {
    return "type.googleapis.com/google.cloud.retail.v2.SetInventoryRequest"
  }
  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)
  }
}
