Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- Photo
- Event
- ListConnectionsResponse
- DomainMembership
- RelationshipInterest
- BraggingRights
- Membership
- Person
- ContactGroupMembership
- Locale
- RelationshipStatus
- URL
- Address
- Relation
- GetPeopleResponse
- Birthday
- Date
- Tagline
- Residence
- Gender
- Name
- FieldMetadata
- PhoneNumber
- Occupation
- EmailAddress
- Source
- ImClient
- PersonMetadata
- Nickname
- Organization
- Interest
- PersonResponse
- Skill
- Biography
- CoverPhoto
- peopleService :: ServiceConfig
- userBirthdayReadScope :: Proxy '["https://www.googleapis.com/auth/user.birthday.read"]
- userInfoProFileScope :: Proxy '["https://www.googleapis.com/auth/userinfo.profile"]
- plusLoginScope :: Proxy '["https://www.googleapis.com/auth/plus.login"]
- userPhoneNumbersReadScope :: Proxy '["https://www.googleapis.com/auth/user.phonenumbers.read"]
- userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"]
- contactsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/contacts.readonly"]
- userAddressesReadScope :: Proxy '["https://www.googleapis.com/auth/user.addresses.read"]
- contactsScope :: Proxy '["https://www.googleapis.com/auth/contacts"]
- userEmailsReadScope :: Proxy '["https://www.googleapis.com/auth/user.emails.read"]
- data Photo
- photo :: Photo
- pURL :: Lens' Photo (Maybe Text)
- pMetadata :: Lens' Photo (Maybe FieldMetadata)
- data Event
- event :: Event
- eDate :: Lens' Event (Maybe Date)
- eMetadata :: Lens' Event (Maybe FieldMetadata)
- eType :: Lens' Event (Maybe Text)
- eFormattedType :: Lens' Event (Maybe Text)
- data ListConnectionsResponse
- listConnectionsResponse :: ListConnectionsResponse
- lcrNextPageToken :: Lens' ListConnectionsResponse (Maybe Text)
- lcrConnections :: Lens' ListConnectionsResponse [Person]
- lcrNextSyncToken :: Lens' ListConnectionsResponse (Maybe Text)
- data DomainMembership
- domainMembership :: DomainMembership
- dmInViewerDomain :: Lens' DomainMembership (Maybe Bool)
- data RelationshipInterest
- relationshipInterest :: RelationshipInterest
- riValue :: Lens' RelationshipInterest (Maybe Text)
- riMetadata :: Lens' RelationshipInterest (Maybe FieldMetadata)
- riFormattedValue :: Lens' RelationshipInterest (Maybe Text)
- data BraggingRights
- braggingRights :: BraggingRights
- brValue :: Lens' BraggingRights (Maybe Text)
- brMetadata :: Lens' BraggingRights (Maybe FieldMetadata)
- data Membership
- membership :: Membership
- mDomainMembership :: Lens' Membership (Maybe DomainMembership)
- mContactGroupMembership :: Lens' Membership (Maybe ContactGroupMembership)
- mMetadata :: Lens' Membership (Maybe FieldMetadata)
- data Person
- person :: Person
- perEmailAddresses :: Lens' Person [EmailAddress]
- perAgeRange :: Lens' Person (Maybe Text)
- perEtag :: Lens' Person (Maybe Text)
- perResidences :: Lens' Person [Residence]
- perBiographies :: Lens' Person [Biography]
- perTaglines :: Lens' Person [Tagline]
- perBraggingRights :: Lens' Person [BraggingRights]
- perBirthdays :: Lens' Person [Birthday]
- perResourceName :: Lens' Person (Maybe Text)
- perRelations :: Lens' Person [Relation]
- perURLs :: Lens' Person [URL]
- perAddresses :: Lens' Person [Address]
- perNicknames :: Lens' Person [Nickname]
- perRelationshipStatuses :: Lens' Person [RelationshipStatus]
- perImClients :: Lens' Person [ImClient]
- perPhoneNumbers :: Lens' Person [PhoneNumber]
- perOccupations :: Lens' Person [Occupation]
- perNames :: Lens' Person [Name]
- perGenders :: Lens' Person [Gender]
- perPhotos :: Lens' Person [Photo]
- perEvents :: Lens' Person [Event]
- perCoverPhotos :: Lens' Person [CoverPhoto]
- perSkills :: Lens' Person [Skill]
- perMetadata :: Lens' Person (Maybe PersonMetadata)
- perInterests :: Lens' Person [Interest]
- perOrganizations :: Lens' Person [Organization]
- perLocales :: Lens' Person [Locale]
- perMemberships :: Lens' Person [Membership]
- perRelationshipInterests :: Lens' Person [RelationshipInterest]
- data ContactGroupMembership
- contactGroupMembership :: ContactGroupMembership
- cgmContactGroupId :: Lens' ContactGroupMembership (Maybe Text)
- data Locale
- locale :: Locale
- lValue :: Lens' Locale (Maybe Text)
- lMetadata :: Lens' Locale (Maybe FieldMetadata)
- data RelationshipStatus
- relationshipStatus :: RelationshipStatus
- rsValue :: Lens' RelationshipStatus (Maybe Text)
- rsMetadata :: Lens' RelationshipStatus (Maybe FieldMetadata)
- rsFormattedValue :: Lens' RelationshipStatus (Maybe Text)
- data URL
- url :: URL
- uValue :: Lens' URL (Maybe Text)
- uMetadata :: Lens' URL (Maybe FieldMetadata)
- uType :: Lens' URL (Maybe Text)
- uFormattedType :: Lens' URL (Maybe Text)
- data Address
- address :: Address
- aStreetAddress :: Lens' Address (Maybe Text)
- aPoBox :: Lens' Address (Maybe Text)
- aCountry :: Lens' Address (Maybe Text)
- aPostalCode :: Lens' Address (Maybe Text)
- aExtendedAddress :: Lens' Address (Maybe Text)
- aCity :: Lens' Address (Maybe Text)
- aMetadata :: Lens' Address (Maybe FieldMetadata)
- aCountryCode :: Lens' Address (Maybe Text)
- aFormattedValue :: Lens' Address (Maybe Text)
- aRegion :: Lens' Address (Maybe Text)
- aType :: Lens' Address (Maybe Text)
- aFormattedType :: Lens' Address (Maybe Text)
- data Relation
- relation :: Relation
- rPerson :: Lens' Relation (Maybe Text)
- rMetadata :: Lens' Relation (Maybe FieldMetadata)
- rType :: Lens' Relation (Maybe Text)
- rFormattedType :: Lens' Relation (Maybe Text)
- data GetPeopleResponse
- getPeopleResponse :: GetPeopleResponse
- gprResponses :: Lens' GetPeopleResponse [PersonResponse]
- data Birthday
- birthday :: Birthday
- bText :: Lens' Birthday (Maybe Text)
- bDate :: Lens' Birthday (Maybe Date)
- bMetadata :: Lens' Birthday (Maybe FieldMetadata)
- data Date
- date :: Date
- dDay :: Lens' Date (Maybe Int32)
- dYear :: Lens' Date (Maybe Int32)
- dMonth :: Lens' Date (Maybe Int32)
- data Tagline
- tagline :: Tagline
- tValue :: Lens' Tagline (Maybe Text)
- tMetadata :: Lens' Tagline (Maybe FieldMetadata)
- data Residence
- residence :: Residence
- resValue :: Lens' Residence (Maybe Text)
- resCurrent :: Lens' Residence (Maybe Bool)
- resMetadata :: Lens' Residence (Maybe FieldMetadata)
- data Gender
- gender :: Gender
- gValue :: Lens' Gender (Maybe Text)
- gMetadata :: Lens' Gender (Maybe FieldMetadata)
- gFormattedValue :: Lens' Gender (Maybe Text)
- data Name
- name :: Name
- nGivenName :: Lens' Name (Maybe Text)
- nPhoneticHonorificSuffix :: Lens' Name (Maybe Text)
- nMiddleName :: Lens' Name (Maybe Text)
- nPhoneticMiddleName :: Lens' Name (Maybe Text)
- nPhoneticFamilyName :: Lens' Name (Maybe Text)
- nPhoneticHonorificPrefix :: Lens' Name (Maybe Text)
- nHonorificPrefix :: Lens' Name (Maybe Text)
- nFamilyName :: Lens' Name (Maybe Text)
- nMetadata :: Lens' Name (Maybe FieldMetadata)
- nDisplayName :: Lens' Name (Maybe Text)
- nPhoneticGivenName :: Lens' Name (Maybe Text)
- nHonorificSuffix :: Lens' Name (Maybe Text)
- data FieldMetadata
- fieldMetadata :: FieldMetadata
- fmVerified :: Lens' FieldMetadata (Maybe Bool)
- fmPrimary :: Lens' FieldMetadata (Maybe Bool)
- fmSource :: Lens' FieldMetadata (Maybe Source)
- data PhoneNumber
- phoneNumber :: PhoneNumber
- pnCanonicalForm :: Lens' PhoneNumber (Maybe Text)
- pnValue :: Lens' PhoneNumber (Maybe Text)
- pnMetadata :: Lens' PhoneNumber (Maybe FieldMetadata)
- pnType :: Lens' PhoneNumber (Maybe Text)
- pnFormattedType :: Lens' PhoneNumber (Maybe Text)
- data Occupation
- occupation :: Occupation
- oValue :: Lens' Occupation (Maybe Text)
- oMetadata :: Lens' Occupation (Maybe FieldMetadata)
- data EmailAddress
- emailAddress :: EmailAddress
- eaValue :: Lens' EmailAddress (Maybe Text)
- eaMetadata :: Lens' EmailAddress (Maybe FieldMetadata)
- eaType :: Lens' EmailAddress (Maybe Text)
- eaFormattedType :: Lens' EmailAddress (Maybe Text)
- data Source
- source :: Source
- sId :: Lens' Source (Maybe Text)
- sType :: Lens' Source (Maybe Text)
- data ImClient
- imClient :: ImClient
- icFormattedProtocol :: Lens' ImClient (Maybe Text)
- icUsername :: Lens' ImClient (Maybe Text)
- icProtocol :: Lens' ImClient (Maybe Text)
- icMetadata :: Lens' ImClient (Maybe FieldMetadata)
- icType :: Lens' ImClient (Maybe Text)
- icFormattedType :: Lens' ImClient (Maybe Text)
- data PersonMetadata
- personMetadata :: PersonMetadata
- pmPreviousResourceNames :: Lens' PersonMetadata [Text]
- pmObjectType :: Lens' PersonMetadata (Maybe Text)
- pmSources :: Lens' PersonMetadata [Source]
- pmDeleted :: Lens' PersonMetadata (Maybe Bool)
- data Nickname
- nickname :: Nickname
- nicValue :: Lens' Nickname (Maybe Text)
- nicMetadata :: Lens' Nickname (Maybe FieldMetadata)
- nicType :: Lens' Nickname (Maybe Text)
- data Organization
- organization :: Organization
- orgDePartment :: Lens' Organization (Maybe Text)
- orgLocation :: Lens' Organization (Maybe Text)
- orgDomain :: Lens' Organization (Maybe Text)
- orgEndDate :: Lens' Organization (Maybe Date)
- orgSymbol :: Lens' Organization (Maybe Text)
- orgJobDescription :: Lens' Organization (Maybe Text)
- orgCurrent :: Lens' Organization (Maybe Bool)
- orgStartDate :: Lens' Organization (Maybe Date)
- orgName :: Lens' Organization (Maybe Text)
- orgMetadata :: Lens' Organization (Maybe FieldMetadata)
- orgPhoneticName :: Lens' Organization (Maybe Text)
- orgTitle :: Lens' Organization (Maybe Text)
- orgType :: Lens' Organization (Maybe Text)
- orgFormattedType :: Lens' Organization (Maybe Text)
- data Interest
- interest :: Interest
- iValue :: Lens' Interest (Maybe Text)
- iMetadata :: Lens' Interest (Maybe FieldMetadata)
- data PersonResponse
- personResponse :: PersonResponse
- prRequestedResourceName :: Lens' PersonResponse (Maybe Text)
- prPerson :: Lens' PersonResponse (Maybe Person)
- prHTTPStatusCode :: Lens' PersonResponse (Maybe Int32)
- data Skill
- skill :: Skill
- sValue :: Lens' Skill (Maybe Text)
- sMetadata :: Lens' Skill (Maybe FieldMetadata)
- data Biography
- biography :: Biography
- bioValue :: Lens' Biography (Maybe Text)
- bioMetadata :: Lens' Biography (Maybe FieldMetadata)
- data CoverPhoto
- coverPhoto :: CoverPhoto
- cpDefault :: Lens' CoverPhoto (Maybe Bool)
- cpURL :: Lens' CoverPhoto (Maybe Text)
- cpMetadata :: Lens' CoverPhoto (Maybe FieldMetadata)
Service Configuration
peopleService :: ServiceConfig Source #
Default request referring to version v1
of the Google People API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
userBirthdayReadScope :: Proxy '["https://www.googleapis.com/auth/user.birthday.read"] Source #
View your complete date of birth
userInfoProFileScope :: Proxy '["https://www.googleapis.com/auth/userinfo.profile"] Source #
View your basic profile info
plusLoginScope :: Proxy '["https://www.googleapis.com/auth/plus.login"] Source #
Know your basic profile info and list of people in your circles.
userPhoneNumbersReadScope :: Proxy '["https://www.googleapis.com/auth/user.phonenumbers.read"] Source #
View your phone numbers
userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"] Source #
View your email address
contactsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/contacts.readonly"] Source #
View your contacts
userAddressesReadScope :: Proxy '["https://www.googleapis.com/auth/user.addresses.read"] Source #
View your street addresses
contactsScope :: Proxy '["https://www.googleapis.com/auth/contacts"] Source #
Manage your contacts
userEmailsReadScope :: Proxy '["https://www.googleapis.com/auth/user.emails.read"] Source #
View your email addresses
Photo
A person's photo. A picture shown next to the person's name to help others recognize the person.
See: photo
smart constructor.
Event
An event related to the person.
See: event
smart constructor.
Creates a value of Event
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eType :: Lens' Event (Maybe Text) Source #
The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`
eFormattedType :: Lens' Event (Maybe Text) Source #
The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
ListConnectionsResponse
listConnectionsResponse :: ListConnectionsResponse Source #
Creates a value of ListConnectionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcrNextPageToken :: Lens' ListConnectionsResponse (Maybe Text) Source #
The token that can be used to retrieve the next page of results.
lcrConnections :: Lens' ListConnectionsResponse [Person] Source #
The list of people that the requestor is connected to.
lcrNextSyncToken :: Lens' ListConnectionsResponse (Maybe Text) Source #
The token that can be used to retrieve changes since the last request.
DomainMembership
data DomainMembership Source #
A Google Apps Domain membership.
See: domainMembership
smart constructor.
domainMembership :: DomainMembership Source #
Creates a value of DomainMembership
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dmInViewerDomain :: Lens' DomainMembership (Maybe Bool) Source #
True if the person is in the viewer's Google Apps domain.
RelationshipInterest
data RelationshipInterest Source #
The kind of relationship the person is looking for.
See: relationshipInterest
smart constructor.
relationshipInterest :: RelationshipInterest Source #
Creates a value of RelationshipInterest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
riValue :: Lens' RelationshipInterest (Maybe Text) Source #
The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`
riMetadata :: Lens' RelationshipInterest (Maybe FieldMetadata) Source #
Metadata about the relationship interest.
riFormattedValue :: Lens' RelationshipInterest (Maybe Text) Source #
The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
BraggingRights
data BraggingRights Source #
A person's bragging rights.
See: braggingRights
smart constructor.
braggingRights :: BraggingRights Source #
Creates a value of BraggingRights
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
brValue :: Lens' BraggingRights (Maybe Text) Source #
The bragging rights; for example, `climbed mount everest`.
brMetadata :: Lens' BraggingRights (Maybe FieldMetadata) Source #
Metadata about the bragging rights.
Membership
data Membership Source #
A person's membership in a group.
See: membership
smart constructor.
membership :: Membership Source #
Creates a value of Membership
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mDomainMembership :: Lens' Membership (Maybe DomainMembership) Source #
The domain membership.
mContactGroupMembership :: Lens' Membership (Maybe ContactGroupMembership) Source #
The contact group membership.
mMetadata :: Lens' Membership (Maybe FieldMetadata) Source #
Metadata about the membership.
Person
Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
See: person
smart constructor.
Creates a value of Person
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
perEmailAddresses
perAgeRange
perEtag
perResidences
perBiographies
perTaglines
perBraggingRights
perBirthdays
perResourceName
perRelations
perURLs
perAddresses
perNicknames
perRelationshipStatuses
perImClients
perPhoneNumbers
perOccupations
perNames
perGenders
perPhotos
perEvents
perCoverPhotos
perSkills
perMetadata
perInterests
perOrganizations
perLocales
perMemberships
perRelationshipInterests
perEmailAddresses :: Lens' Person [EmailAddress] Source #
The person's email addresses.
perEtag :: Lens' Person (Maybe Text) Source #
The HTTP entity tag of the resource. Used for web cache validation.
perBraggingRights :: Lens' Person [BraggingRights] Source #
The person's bragging rights.
perResourceName :: Lens' Person (Maybe Text) Source #
The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.
perRelationshipStatuses :: Lens' Person [RelationshipStatus] Source #
The person's relationship statuses.
perPhoneNumbers :: Lens' Person [PhoneNumber] Source #
The person's phone numbers.
perOccupations :: Lens' Person [Occupation] Source #
The person's occupations.
perCoverPhotos :: Lens' Person [CoverPhoto] Source #
The person's cover photos.
perMetadata :: Lens' Person (Maybe PersonMetadata) Source #
Metadata about the person.
perOrganizations :: Lens' Person [Organization] Source #
The person's past or current organizations.
perMemberships :: Lens' Person [Membership] Source #
The person's group memberships.
perRelationshipInterests :: Lens' Person [RelationshipInterest] Source #
The kind of relationship the person is looking for.
ContactGroupMembership
data ContactGroupMembership Source #
A Google contact group membership.
See: contactGroupMembership
smart constructor.
contactGroupMembership :: ContactGroupMembership Source #
Creates a value of ContactGroupMembership
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cgmContactGroupId :: Lens' ContactGroupMembership (Maybe Text) Source #
The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.
Locale
A person's locale preference.
See: locale
smart constructor.
lValue :: Lens' Locale (Maybe Text) Source #
The well-formed IETF BCP 47 language tag representing the locale.
RelationshipStatus
data RelationshipStatus Source #
A person's relationship status.
See: relationshipStatus
smart constructor.
relationshipStatus :: RelationshipStatus Source #
Creates a value of RelationshipStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsValue :: Lens' RelationshipStatus (Maybe Text) Source #
The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
rsMetadata :: Lens' RelationshipStatus (Maybe FieldMetadata) Source #
Metadata about the relationship status.
rsFormattedValue :: Lens' RelationshipStatus (Maybe Text) Source #
The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
URL
A person's associated URLs.
See: url
smart constructor.
Creates a value of URL
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uType :: Lens' URL (Maybe Text) Source #
The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
uFormattedType :: Lens' URL (Maybe Text) Source #
The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
Address
A person's physical address. May be a P.O. box or street address. All fields are optional.
See: address
smart constructor.
Creates a value of Address
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aExtendedAddress :: Lens' Address (Maybe Text) Source #
The extended address of the address; for example, the apartment number.
aCountryCode :: Lens' Address (Maybe Text) Source #
The ISO 3166-1 alpha-2 country code of the address.
aFormattedValue :: Lens' Address (Maybe Text) Source #
The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
aRegion :: Lens' Address (Maybe Text) Source #
The region of the address; for example, the state or province.
aType :: Lens' Address (Maybe Text) Source #
The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
aFormattedType :: Lens' Address (Maybe Text) Source #
The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
Relation
A person's relation to another person.
See: relation
smart constructor.
Creates a value of Relation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rPerson :: Lens' Relation (Maybe Text) Source #
The name of the other person this relation refers to.
rType :: Lens' Relation (Maybe Text) Source #
The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
rFormattedType :: Lens' Relation (Maybe Text) Source #
The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
GetPeopleResponse
data GetPeopleResponse Source #
getPeopleResponse :: GetPeopleResponse Source #
Creates a value of GetPeopleResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gprResponses :: Lens' GetPeopleResponse [PersonResponse] Source #
The response for each requested resource name.
Birthday
A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
See: birthday
smart constructor.
Date
Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date.
See: date
smart constructor.
dDay :: Lens' Date (Maybe Int32) Source #
Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
dYear :: Lens' Date (Maybe Int32) Source #
Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
Tagline
A brief one-line description of the person.
See: tagline
smart constructor.
Residence
A person's past or current residence.
See: residence
smart constructor.
residence :: Residence Source #
Creates a value of Residence
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
resCurrent :: Lens' Residence (Maybe Bool) Source #
True if the residence is the person's current residence; false if the residence is a past residence.
resMetadata :: Lens' Residence (Maybe FieldMetadata) Source #
Metadata about the residence.
Gender
A person's gender.
See: gender
smart constructor.
Creates a value of Gender
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gValue :: Lens' Gender (Maybe Text) Source #
The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`
gFormattedValue :: Lens' Gender (Maybe Text) Source #
The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
Name
A person's name. If the name is a mononym, the family name is empty.
See: name
smart constructor.
Creates a value of Name
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nPhoneticHonorificSuffix :: Lens' Name (Maybe Text) Source #
The honorific suffixes spelled as they sound.
nPhoneticHonorificPrefix :: Lens' Name (Maybe Text) Source #
The honorific prefixes spelled as they sound.
nDisplayName :: Lens' Name (Maybe Text) Source #
The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
FieldMetadata
data FieldMetadata Source #
Metadata about a field.
See: fieldMetadata
smart constructor.
fieldMetadata :: FieldMetadata Source #
Creates a value of FieldMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fmVerified :: Lens' FieldMetadata (Maybe Bool) Source #
True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
fmPrimary :: Lens' FieldMetadata (Maybe Bool) Source #
True if the field is the primary field; false if the field is a secondary field.
PhoneNumber
data PhoneNumber Source #
A person's phone number.
See: phoneNumber
smart constructor.
phoneNumber :: PhoneNumber Source #
Creates a value of PhoneNumber
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pnCanonicalForm :: Lens' PhoneNumber (Maybe Text) Source #
The read-only canonicalized ITU-T E.164 form of the phone number.
pnMetadata :: Lens' PhoneNumber (Maybe FieldMetadata) Source #
Metadata about the phone number.
pnType :: Lens' PhoneNumber (Maybe Text) Source #
The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
pnFormattedType :: Lens' PhoneNumber (Maybe Text) Source #
The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.
Occupation
data Occupation Source #
A person's occupation.
See: occupation
smart constructor.
occupation :: Occupation Source #
Creates a value of Occupation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oMetadata :: Lens' Occupation (Maybe FieldMetadata) Source #
Metadata about the occupation.
EmailAddress
data EmailAddress Source #
A person's email address.
See: emailAddress
smart constructor.
emailAddress :: EmailAddress Source #
Creates a value of EmailAddress
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eaMetadata :: Lens' EmailAddress (Maybe FieldMetadata) Source #
Metadata about the email address.
eaType :: Lens' EmailAddress (Maybe Text) Source #
The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
eaFormattedType :: Lens' EmailAddress (Maybe Text) Source #
The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
Source
The source of a field.
See: source
smart constructor.
sId :: Lens' Source (Maybe Text) Source #
A unique identifier within the source type generated by the server.
ImClient
A person's instant messaging client.
See: imClient
smart constructor.
Creates a value of ImClient
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
icFormattedProtocol :: Lens' ImClient (Maybe Text) Source #
The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
icProtocol :: Lens' ImClient (Maybe Text) Source #
The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
icMetadata :: Lens' ImClient (Maybe FieldMetadata) Source #
Metadata about the IM client.
icType :: Lens' ImClient (Maybe Text) Source #
The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
icFormattedType :: Lens' ImClient (Maybe Text) Source #
The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
PersonMetadata
data PersonMetadata Source #
Metadata about a person.
See: personMetadata
smart constructor.
personMetadata :: PersonMetadata Source #
Creates a value of PersonMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pmPreviousResourceNames :: Lens' PersonMetadata [Text] Source #
Any former resource names this person has had. Populated only for `connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
pmObjectType :: Lens' PersonMetadata (Maybe Text) Source #
The type of the person object.
pmDeleted :: Lens' PersonMetadata (Maybe Bool) Source #
True if the person resource has been deleted. Populated only for `connections.list` requests that include a sync token.
Nickname
A person's nickname.
See: nickname
smart constructor.
Creates a value of Nickname
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nicMetadata :: Lens' Nickname (Maybe FieldMetadata) Source #
Metadata about the nickname.
Organization
data Organization Source #
A person's past or current organization. Overlapping date ranges are permitted.
See: organization
smart constructor.
organization :: Organization Source #
Creates a value of Organization
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
orgDePartment :: Lens' Organization (Maybe Text) Source #
The person's department at the organization.
orgLocation :: Lens' Organization (Maybe Text) Source #
The location of the organization office the person works at.
orgDomain :: Lens' Organization (Maybe Text) Source #
The domain name associated with the organization; for example, `google.com`.
orgEndDate :: Lens' Organization (Maybe Date) Source #
The end date when the person left the organization.
orgSymbol :: Lens' Organization (Maybe Text) Source #
The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
orgJobDescription :: Lens' Organization (Maybe Text) Source #
The person's job description at the organization.
orgCurrent :: Lens' Organization (Maybe Bool) Source #
True if the organization is the person's current organization; false if the organization is a past organization.
orgStartDate :: Lens' Organization (Maybe Date) Source #
The start date when the person joined the organization.
orgMetadata :: Lens' Organization (Maybe FieldMetadata) Source #
Metadata about the organization.
orgPhoneticName :: Lens' Organization (Maybe Text) Source #
The phonetic name of the organization.
orgType :: Lens' Organization (Maybe Text) Source #
The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`
orgFormattedType :: Lens' Organization (Maybe Text) Source #
The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
Interest
One of the person's interests.
See: interest
smart constructor.
PersonResponse
data PersonResponse Source #
The response for a single person
See: personResponse
smart constructor.
personResponse :: PersonResponse Source #
Creates a value of PersonResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prRequestedResourceName :: Lens' PersonResponse (Maybe Text) Source #
The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.
Skill
A skill that the person has.
See: skill
smart constructor.
Biography
A person's short biography.
See: biography
smart constructor.
biography :: Biography Source #
Creates a value of Biography
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bioMetadata :: Lens' Biography (Maybe FieldMetadata) Source #
Metadata about the biography.
CoverPhoto
data CoverPhoto Source #
A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
See: coverPhoto
smart constructor.
coverPhoto :: CoverPhoto Source #
Creates a value of CoverPhoto
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cpDefault :: Lens' CoverPhoto (Maybe Bool) Source #
True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
cpMetadata :: Lens' CoverPhoto (Maybe FieldMetadata) Source #
Metadata about the cover photo.