Indexing API
- Documents
- Permissions
- Troubleshooting
- Datasources
- Authentication
- People
- Shortcuts
Client API
- Activity
- Announcements
- Answers
- Authentication
- Chat
- Agents
- Collections
- Documents
- Insights
- Messages
- Pins
- Search
- Entities
- Shortcuts
- Summarize
- Verification
Announcements
Create Announcement
Announcements
Create Announcement
Create a textual announcement visible to some set of users based on department and location.
POST
/
rest
/
api
/
v1
/
createannouncement
from datetime import date
from glean import Glean, models
from glean.utils import parse_datetime
import os
with Glean(
api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as g_client:
res = g_client.client.announcements.create(start_time=parse_datetime("2024-06-17T07:14:55.338Z"), end_time=parse_datetime("2024-11-30T17:06:07.804Z"), title="<value>", body={
"text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"structured_list": [
models.StructuredTextItem(
link="https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
document=models.Document(
metadata=models.DocumentMetadata(
datasource="datasource",
object_type="Feature Request",
container="container",
parent_id="JIRA_EN-1337",
mime_type="mimeType",
document_id="documentId",
create_time=parse_datetime("2000-01-23T04:56:07.000Z"),
update_time=parse_datetime("2000-01-23T04:56:07.000Z"),
author=models.Person(
name="George Clooney",
obfuscated_id="abc123",
related_documents=[
models.RelatedDocuments(
query_suggestion=models.QuerySuggestion(
query="app:github type:pull author:mortimer",
search_provider_info=models.SearchProviderInfo(
name="Google",
search_link_url_template="https://www.google.com/search?q={query}&hl=en",
),
label="Mortimer's PRs",
datasource="github",
request_options=models.SearchRequestOptions(
datasource_filter="JIRA",
datasources_filter=[
"JIRA",
],
query_overrides_facet_filters=True,
facet_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
facet_filter_sets=[
models.FacetFilterSet(
filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
),
],
facet_bucket_size=796474,
auth_tokens=[
models.AuthToken(
access_token="123abc",
datasource="gmail",
scope="email profile https://www.googleapis.com/auth/gmail.readonly",
token_type="Bearer",
auth_user="1",
),
],
),
ranges=[
models.TextRange(
start_index=86,
),
models.TextRange(
start_index=169727,
),
models.TextRange(
start_index=89964,
),
],
input_details=models.SearchRequestInputDetails(
has_copy_paste=True,
),
),
results=[
models.SearchResult(
title="title",
url="https://example.com/foo/bar",
native_app_url="slack://foo/bar",
snippets=[
models.SearchResultSnippet(
snippet="snippet",
mime_type="mimeType",
),
],
),
],
),
],
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
query_suggestions=models.QuerySuggestionList(
suggestions=[
models.QuerySuggestion(
query="app:github type:pull author:mortimer",
label="Mortimer's PRs",
datasource="github",
),
],
),
invite_info=models.InviteInfo(
invites=[
models.ChannelInviteInfo(),
models.ChannelInviteInfo(),
models.ChannelInviteInfo(),
],
),
custom_fields=[
models.CustomFieldData(
label="<value>",
values=[
models.CustomFieldValueStr(),
models.CustomFieldValueStr(),
models.CustomFieldValueStr(),
],
),
models.CustomFieldData(
label="<value>",
values=[],
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
owner=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
mentioned_people=[
models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
],
components=[
"Backend",
"Networking",
],
status="[\"Done\"]",
pins=[
models.PinDocument(
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
document_id="<id>",
attribution=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
],
assigned_to=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
collections=[
models.Collection(
name="<value>",
description="yuck mortally round",
added_roles=[
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.ANSWER_MODERATOR,
),
],
removed_roles=[
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.ANSWER_MODERATOR,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.VIEWER,
),
],
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
id=924484,
creator=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
items=[
models.CollectionItem(
collection_id=583353,
created_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
shortcut=models.Shortcut(
input_alias="<value>",
created_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
roles=[
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.VERIFIER,
),
],
),
item_type=models.CollectionItemItemType.COLLECTION,
),
],
),
],
interactions=models.DocumentInteractions(
reacts=[
models.Reaction(
reactors=[
models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
],
),
models.Reaction(),
models.Reaction(),
],
shares=[
models.Share(
num_days_ago=540711,
sharer=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
models.Share(
num_days_ago=198175,
sharer=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
models.Share(
num_days_ago=353531,
sharer=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
],
),
verification=models.Verification(
state=models.State.DEPRECATED,
metadata=models.VerificationMetadata(
last_verifier=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
reminders=[
models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
requestor=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
remind_at=295558,
),
models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
requestor=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
remind_at=712214,
),
models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
requestor=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
remind_at=212775,
),
],
last_reminder=models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
requestor=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
remind_at=608384,
),
candidate_verifiers=[
models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
],
),
),
shortcuts=[
models.Shortcut(
input_alias="<value>",
created_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
],
custom_data={
"someCustomField": models.CustomDataValue(),
},
contact_person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
),
text="Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue.",
),
models.StructuredTextItem(
link="https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
document=models.Document(
metadata=models.DocumentMetadata(
datasource="datasource",
object_type="Feature Request",
container="container",
parent_id="JIRA_EN-1337",
mime_type="mimeType",
document_id="documentId",
create_time=parse_datetime("2000-01-23T04:56:07.000Z"),
update_time=parse_datetime("2000-01-23T04:56:07.000Z"),
author=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
owner=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
components=[
"Backend",
"Networking",
],
status="[\"Done\"]",
assigned_to=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
verification=models.Verification(
state=models.State.UNVERIFIED,
metadata=models.VerificationMetadata(
last_verifier=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
last_reminder=models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
requestor=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
remind_at=930830,
),
),
),
custom_data={
"someCustomField": models.CustomDataValue(),
},
contact_person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
),
text="Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue.",
),
],
}, audience_filters=[
{
"field_name": "type",
"values": [
{
"value": "Spreadsheet",
"relation_type": models.RelationType.EQUALS,
},
{
"value": "Presentation",
"relation_type": models.RelationType.EQUALS,
},
],
},
])
# Handle response
print(res){
"draftId": 342
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).
Auth type being used to access the endpoint (should be non-empty only for global tokens).
Body
application/json
Announcement content
The body is of type object.
Response
200
application/json
OK
The response is of type object.
from datetime import date
from glean import Glean, models
from glean.utils import parse_datetime
import os
with Glean(
api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as g_client:
res = g_client.client.announcements.create(start_time=parse_datetime("2024-06-17T07:14:55.338Z"), end_time=parse_datetime("2024-11-30T17:06:07.804Z"), title="<value>", body={
"text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"structured_list": [
models.StructuredTextItem(
link="https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
document=models.Document(
metadata=models.DocumentMetadata(
datasource="datasource",
object_type="Feature Request",
container="container",
parent_id="JIRA_EN-1337",
mime_type="mimeType",
document_id="documentId",
create_time=parse_datetime("2000-01-23T04:56:07.000Z"),
update_time=parse_datetime("2000-01-23T04:56:07.000Z"),
author=models.Person(
name="George Clooney",
obfuscated_id="abc123",
related_documents=[
models.RelatedDocuments(
query_suggestion=models.QuerySuggestion(
query="app:github type:pull author:mortimer",
search_provider_info=models.SearchProviderInfo(
name="Google",
search_link_url_template="https://www.google.com/search?q={query}&hl=en",
),
label="Mortimer's PRs",
datasource="github",
request_options=models.SearchRequestOptions(
datasource_filter="JIRA",
datasources_filter=[
"JIRA",
],
query_overrides_facet_filters=True,
facet_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
facet_filter_sets=[
models.FacetFilterSet(
filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
),
],
facet_bucket_size=796474,
auth_tokens=[
models.AuthToken(
access_token="123abc",
datasource="gmail",
scope="email profile https://www.googleapis.com/auth/gmail.readonly",
token_type="Bearer",
auth_user="1",
),
],
),
ranges=[
models.TextRange(
start_index=86,
),
models.TextRange(
start_index=169727,
),
models.TextRange(
start_index=89964,
),
],
input_details=models.SearchRequestInputDetails(
has_copy_paste=True,
),
),
results=[
models.SearchResult(
title="title",
url="https://example.com/foo/bar",
native_app_url="slack://foo/bar",
snippets=[
models.SearchResultSnippet(
snippet="snippet",
mime_type="mimeType",
),
],
),
],
),
],
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
query_suggestions=models.QuerySuggestionList(
suggestions=[
models.QuerySuggestion(
query="app:github type:pull author:mortimer",
label="Mortimer's PRs",
datasource="github",
),
],
),
invite_info=models.InviteInfo(
invites=[
models.ChannelInviteInfo(),
models.ChannelInviteInfo(),
models.ChannelInviteInfo(),
],
),
custom_fields=[
models.CustomFieldData(
label="<value>",
values=[
models.CustomFieldValueStr(),
models.CustomFieldValueStr(),
models.CustomFieldValueStr(),
],
),
models.CustomFieldData(
label="<value>",
values=[],
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
owner=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
mentioned_people=[
models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
],
components=[
"Backend",
"Networking",
],
status="[\"Done\"]",
pins=[
models.PinDocument(
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
document_id="<id>",
attribution=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
],
assigned_to=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
collections=[
models.Collection(
name="<value>",
description="yuck mortally round",
added_roles=[
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.ANSWER_MODERATOR,
),
],
removed_roles=[
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.ANSWER_MODERATOR,
),
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.VIEWER,
),
],
audience_filters=[
models.FacetFilter(
field_name="type",
values=[
models.FacetFilterValue(
value="Spreadsheet",
relation_type=models.RelationType.EQUALS,
),
models.FacetFilterValue(
value="Presentation",
relation_type=models.RelationType.EQUALS,
),
],
),
],
id=924484,
creator=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
items=[
models.CollectionItem(
collection_id=583353,
created_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
shortcut=models.Shortcut(
input_alias="<value>",
created_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
roles=[
models.UserRoleSpecification(
person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
role=models.UserRole.VERIFIER,
),
],
),
item_type=models.CollectionItemItemType.COLLECTION,
),
],
),
],
interactions=models.DocumentInteractions(
reacts=[
models.Reaction(
reactors=[
models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
],
),
models.Reaction(),
models.Reaction(),
],
shares=[
models.Share(
num_days_ago=540711,
sharer=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
models.Share(
num_days_ago=198175,
sharer=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
models.Share(
num_days_ago=353531,
sharer=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
],
),
verification=models.Verification(
state=models.State.DEPRECATED,
metadata=models.VerificationMetadata(
last_verifier=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
reminders=[
models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
requestor=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
remind_at=295558,
),
models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
requestor=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
remind_at=712214,
),
models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
requestor=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
remind_at=212775,
),
],
last_reminder=models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
requestor=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
remind_at=608384,
),
candidate_verifiers=[
models.Person(
name="George Clooney",
obfuscated_id="abc123",
),
],
),
),
shortcuts=[
models.Shortcut(
input_alias="<value>",
created_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
],
custom_data={
"someCustomField": models.CustomDataValue(),
},
contact_person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
),
text="Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue.",
),
models.StructuredTextItem(
link="https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
document=models.Document(
metadata=models.DocumentMetadata(
datasource="datasource",
object_type="Feature Request",
container="container",
parent_id="JIRA_EN-1337",
mime_type="mimeType",
document_id="documentId",
create_time=parse_datetime("2000-01-23T04:56:07.000Z"),
update_time=parse_datetime("2000-01-23T04:56:07.000Z"),
author=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
owner=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
components=[
"Backend",
"Networking",
],
status="[\"Done\"]",
assigned_to=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
updated_by=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
verification=models.Verification(
state=models.State.UNVERIFIED,
metadata=models.VerificationMetadata(
last_verifier=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
last_reminder=models.Reminder(
assignee=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
requestor=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
remind_at=930830,
),
),
),
custom_data={
"someCustomField": models.CustomDataValue(),
},
contact_person=models.Person(
name="George Clooney",
obfuscated_id="abc123",
metadata=models.PersonMetadata(
type=models.PersonMetadataType.FULL_TIME,
title="Actor",
department="Movies",
email="george@example.com",
location="Hollywood, CA",
phone="6505551234",
photo_url="https://example.com/george.jpg",
start_date=date.fromisoformat("2000-01-23"),
datasource_profile=[
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
models.DatasourceProfile(
datasource="github",
handle="<value>",
),
],
badges=[
models.Badge(
key="deployment_name_new_hire",
display_name="New hire",
icon_config=models.IconConfig(
color="#343CED",
key="person_icon",
icon_type=models.IconType.GLYPH,
name="user",
),
),
],
),
),
),
),
text="Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue.",
),
],
}, audience_filters=[
{
"field_name": "type",
"values": [
{
"value": "Spreadsheet",
"relation_type": models.RelationType.EQUALS,
},
{
"value": "Presentation",
"relation_type": models.RelationType.EQUALS,
},
],
},
])
# Handle response
print(res){
"draftId": 342
}