Skip to content

Commit

Permalink
feat(people): update the API
Browse files Browse the repository at this point in the history
#### people:v1
The following keys were added:
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.description
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.flatPath
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.httpMethod
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.id
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.parameterOrder
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.parameters.resourceName.description
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.parameters.resourceName.location
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.parameters.resourceName.pattern
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.parameters.resourceName.required
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.parameters.resourceName.type
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.path
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.request.$ref
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.response.$ref
- resources.otherContacts.methods.copyOtherContactToMyContactsGroup.scopes
- resources.v1.methods.otherContacts.description
- resources.v1.methods.otherContacts.flatPath
- resources.v1.methods.otherContacts.httpMethod
- resources.v1.methods.otherContacts.id
- resources.v1.methods.otherContacts.parameterOrder
- resources.v1.methods.otherContacts.parameters.pageSize.description
- resources.v1.methods.otherContacts.parameters.pageSize.format
- resources.v1.methods.otherContacts.parameters.pageSize.location
- resources.v1.methods.otherContacts.parameters.pageSize.type
- resources.v1.methods.otherContacts.parameters.pageToken.description
- resources.v1.methods.otherContacts.parameters.pageToken.location
- resources.v1.methods.otherContacts.parameters.pageToken.type
- resources.v1.methods.otherContacts.parameters.readMask.description
- resources.v1.methods.otherContacts.parameters.readMask.format
- resources.v1.methods.otherContacts.parameters.readMask.location
- resources.v1.methods.otherContacts.parameters.readMask.type
- resources.v1.methods.otherContacts.parameters.requestSyncToken.description
- resources.v1.methods.otherContacts.parameters.requestSyncToken.location
- resources.v1.methods.otherContacts.parameters.requestSyncToken.type
- resources.v1.methods.otherContacts.parameters.syncToken.description
- resources.v1.methods.otherContacts.parameters.syncToken.location
- resources.v1.methods.otherContacts.parameters.syncToken.type
- resources.v1.methods.otherContacts.path
- resources.v1.methods.otherContacts.response.$ref
- schemas.CopyOtherContactToMyContactsGroupRequest.description
- schemas.CopyOtherContactToMyContactsGroupRequest.id
- schemas.CopyOtherContactToMyContactsGroupRequest.properties.copyMask.description
- schemas.CopyOtherContactToMyContactsGroupRequest.properties.copyMask.format
- schemas.CopyOtherContactToMyContactsGroupRequest.properties.copyMask.type
- schemas.CopyOtherContactToMyContactsGroupRequest.properties.readMask.description
- schemas.CopyOtherContactToMyContactsGroupRequest.properties.readMask.format
- schemas.CopyOtherContactToMyContactsGroupRequest.properties.readMask.type
- schemas.CopyOtherContactToMyContactsGroupRequest.type
- schemas.ListOtherContactsResponse.description
- schemas.ListOtherContactsResponse.id
- schemas.ListOtherContactsResponse.properties.nextPageToken.description
- schemas.ListOtherContactsResponse.properties.nextPageToken.type
- schemas.ListOtherContactsResponse.properties.nextSyncToken.description
- schemas.ListOtherContactsResponse.properties.nextSyncToken.type
- schemas.ListOtherContactsResponse.properties.otherContacts.description
- schemas.ListOtherContactsResponse.properties.otherContacts.items.$ref
- schemas.ListOtherContactsResponse.properties.otherContacts.type
- schemas.ListOtherContactsResponse.type
- schemas.Name.properties.unstructuredName.description
- schemas.Name.properties.unstructuredName.type

The following keys were changed:
- resources.people.resources.connections.methods.list.description
- schemas.Source.properties.type.enum
- schemas.Source.properties.type.enumDescriptions
  • Loading branch information
yoshi-automation authored and JustinBeckwith committed Jun 5, 2020
1 parent cca8a40 commit 81cd993
Show file tree
Hide file tree
Showing 2 changed files with 553 additions and 5 deletions.
129 changes: 125 additions & 4 deletions discovery/people-v1.json
Expand Up @@ -342,6 +342,38 @@
}
}
},
"otherContacts": {
"methods": {
"copyOtherContactToMyContactsGroup": {
"description": "Copies an other contact to a new contact in the user's MY_CONTACTS group",
"flatPath": "v1/otherContacts/{otherContactsId}:copyOtherContactToMyContactsGroup",
"httpMethod": "POST",
"id": "people.otherContacts.copyOtherContactToMyContactsGroup",
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"description": "Required. The resource name of the other contact to copy.",
"location": "path",
"pattern": "^otherContacts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resourceName}:copyOtherContactToMyContactsGroup",
"request": {
"$ref": "CopyOtherContactToMyContactsGroupRequest"
},
"response": {
"$ref": "Person"
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
]
}
}
},
"people": {
"methods": {
"createContact": {
Expand Down Expand Up @@ -576,7 +608,7 @@
"connections": {
"methods": {
"list": {
"description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n\nThe request throws a 400 error if 'personFields' is not specified.",
"description": "Provides a list of the authenticated user's contacts.\n\nThe request throws a 400 error if 'personFields' is not specified.",
"flatPath": "v1/people/{peopleId}/connections",
"httpMethod": "GET",
"id": "people.people.connections.list",
Expand Down Expand Up @@ -648,9 +680,53 @@
}
}
}
},
"v1": {
"methods": {
"otherContacts": {
"description": "List all other contacts, that is contacts that are not in a contact group.\nOther contacts are typically auto created contacts from interactions.",
"flatPath": "v1/otherContacts",
"httpMethod": "POST",
"id": "people.otherContacts",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "Optional. The number of other contacts to include in the response. Valid values are\nbetween 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListOtherContacts` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListOtherContacts`\nmust match the call that provided the page token.",
"location": "query",
"type": "string"
},
"readMask": {
"description": "Required. A field mask to restrict which fields on each person are returned. Multiple\nfields can be specified by separating them with commas. Valid values are:\n\n* emailAddresses\n* names\n* phoneNumbers",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"requestSyncToken": {
"description": "Optional. Whether the response should include `next_sync_token`, which can be used to\nget all changes since the last request. For subsequent sync requests use\nthe `sync_token` param instead. Initial sync requests that specify\n`request_sync_token` have an additional rate limit.",
"location": "query",
"type": "boolean"
},
"syncToken": {
"description": "Optional. A sync token, received from a previous `ListOtherContacts` call.\nProvide this to retrieve only the resources changed since the last request.\nSync requests that specify `sync_token` have an additional rate limit.\n\nWhen syncing, all other parameters provided to `ListOtherContacts`\nmust match the call that provided the sync token.",
"location": "query",
"type": "string"
}
},
"path": "v1/otherContacts",
"response": {
"$ref": "ListOtherContactsResponse"
}
}
}
}
},
"revision": "20200513",
"revision": "20200604",
"rootUrl": "https://people.googleapis.com/",
"schemas": {
"Address": {
Expand Down Expand Up @@ -915,6 +991,23 @@
},
"type": "object"
},
"CopyOtherContactToMyContactsGroupRequest": {
"description": "A request to copy an other contact to my contacts group.",
"id": "CopyOtherContactToMyContactsGroupRequest",
"properties": {
"copyMask": {
"description": "Required. A field mask to restrict which fields are copied into the new contact.\nValid values are:\n\n* emailAddresses\n* names\n* phoneNumbers",
"format": "google-fieldmask",
"type": "string"
},
"readMask": {
"description": "Optional. A field mask to restrict which fields on the person are returned. Multiple\nfields can be specified by separating them with commas. Defaults to empty\nif not set, which will skip the post mutate get. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* residences\n* sipAddresses\n* skills\n* urls\n* userDefined",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"CoverPhoto": {
"description": "A person's cover photo. A large image shown on the person's\nprofile page that represents who they are or what they care about.",
"id": "CoverPhoto",
Expand Down Expand Up @@ -1206,6 +1299,28 @@
},
"type": "object"
},
"ListOtherContactsResponse": {
"description": "The response to a request for the authenticated user's other contacts.",
"id": "ListOtherContactsResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.",
"type": "string"
},
"nextSyncToken": {
"description": "A token, which can be sent as `sync_token` to retrieve changes since the\nlast request. Request must set `request_sync_token` to return the sync\ntoken.",
"type": "string"
},
"otherContacts": {
"description": "The list of other contacts returned as Person resources. Other contacts\nsupport a limited subset of supported fields. See\nListOtherContactsRequest.request_mask for more detailed information.",
"items": {
"$ref": "Person"
},
"type": "array"
}
},
"type": "object"
},
"Locale": {
"description": "A person's locale preference.",
"id": "Locale",
Expand Down Expand Up @@ -1341,6 +1456,10 @@
"phoneticMiddleName": {
"description": "The middle name(s) spelled as they sound.",
"type": "string"
},
"unstructuredName": {
"description": "The free form name value.",
"type": "string"
}
},
"type": "object"
Expand Down Expand Up @@ -1988,14 +2107,16 @@
"ACCOUNT",
"PROFILE",
"DOMAIN_PROFILE",
"CONTACT"
"CONTACT",
"OTHER_CONTACT"
],
"enumDescriptions": [
"Unspecified.",
"[Google Account](https://accounts.google.com).",
"[Google profile](https://profiles.google.com). You can view the\nprofile at\n[https://profiles.google.com/](https://profiles.google.com/){id}, where\n{id} is the source id.",
"[G Suite domain profile](https://support.google.com/a/answer/1628008).",
"[Google contact](https://contacts.google.com). You can view the\ncontact at\n[https://contact.google.com/](https://contact.google.com/){id}, where\n{id} is the source id."
"[Google contact](https://contacts.google.com). You can view the\ncontact at\n[https://contact.google.com/](https://contact.google.com/){id}, where\n{id} is the source id.",
"[Google contact](https://contacts.google.com). You can view these kinds\nof contacts under the 'Other contacts' tab."
],
"type": "string"
},
Expand Down

0 comments on commit 81cd993

Please sign in to comment.