# Copyright 2019 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.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.Retail.V2.Model.GoogleCloudRetailV2Rating do
  @moduledoc """
  The rating of a Product.

  ## Attributes

  *   `averageRating` (*type:* `number()`, *default:* `nil`) - The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.
  *   `ratingCount` (*type:* `integer()`, *default:* `nil`) - The total number of ratings. This value is independent of the value of rating_histogram. This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.
  *   `ratingHistogram` (*type:* `list(integer())`, *default:* `nil`) - List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :averageRating => number() | nil,
          :ratingCount => integer() | nil,
          :ratingHistogram => list(integer()) | nil
        }

  field(:averageRating)
  field(:ratingCount)
  field(:ratingHistogram, type: :list)
end

defimpl Poison.Decoder, for: GoogleApi.Retail.V2.Model.GoogleCloudRetailV2Rating do
  def decode(value, options) do
    GoogleApi.Retail.V2.Model.GoogleCloudRetailV2Rating.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.Retail.V2.Model.GoogleCloudRetailV2Rating do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end
