Current section

Files

Jump to
google_api_people lib google_api people v1 model name.ex
Raw

lib/google_api/people/v1/model/name.ex

# Copyright 2017 Google Inc.
#
# 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 class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.
defmodule GoogleApi.People.V1.Model.Name do
@moduledoc """
A person's name. If the name is a mononym, the family name is empty.
## Attributes
- displayName (String.t): The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. Defaults to: `null`.
- displayNameLastFirst (String.t): The read-only display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. Defaults to: `null`.
- familyName (String.t): The family name. Defaults to: `null`.
- givenName (String.t): The given name. Defaults to: `null`.
- honorificPrefix (String.t): The honorific prefixes, such as `Mrs.` or `Dr.` Defaults to: `null`.
- honorificSuffix (String.t): The honorific suffixes, such as `Jr.` Defaults to: `null`.
- metadata (FieldMetadata): Metadata about the name. Defaults to: `null`.
- middleName (String.t): The middle name(s). Defaults to: `null`.
- phoneticFamilyName (String.t): The family name spelled as it sounds. Defaults to: `null`.
- phoneticFullName (String.t): The full name spelled as it sounds. Defaults to: `null`.
- phoneticGivenName (String.t): The given name spelled as it sounds. Defaults to: `null`.
- phoneticHonorificPrefix (String.t): The honorific prefixes spelled as they sound. Defaults to: `null`.
- phoneticHonorificSuffix (String.t): The honorific suffixes spelled as they sound. Defaults to: `null`.
- phoneticMiddleName (String.t): The middle name(s) spelled as they sound. Defaults to: `null`.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:displayName => any(),
:displayNameLastFirst => any(),
:familyName => any(),
:givenName => any(),
:honorificPrefix => any(),
:honorificSuffix => any(),
:metadata => GoogleApi.People.V1.Model.FieldMetadata.t(),
:middleName => any(),
:phoneticFamilyName => any(),
:phoneticFullName => any(),
:phoneticGivenName => any(),
:phoneticHonorificPrefix => any(),
:phoneticHonorificSuffix => any(),
:phoneticMiddleName => any()
}
field(:displayName)
field(:displayNameLastFirst)
field(:familyName)
field(:givenName)
field(:honorificPrefix)
field(:honorificSuffix)
field(:metadata, as: GoogleApi.People.V1.Model.FieldMetadata)
field(:middleName)
field(:phoneticFamilyName)
field(:phoneticFullName)
field(:phoneticGivenName)
field(:phoneticHonorificPrefix)
field(:phoneticHonorificSuffix)
field(:phoneticMiddleName)
end
defimpl Poison.Decoder, for: GoogleApi.People.V1.Model.Name do
def decode(value, options) do
GoogleApi.People.V1.Model.Name.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.People.V1.Model.Name do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end