-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy patharticle.py
More file actions
104 lines (72 loc) · 2.95 KB
/
article.py
File metadata and controls
104 lines (72 loc) · 2.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from typing import List, Optional
from typing_extensions import Literal
from .._models import BaseModel
from .shared.article_translated_content import ArticleTranslatedContent
__all__ = ["Article"]
class Article(BaseModel):
id: Optional[str] = None
"""The unique identifier for the article which is given by Intercom."""
author_id: Optional[int] = None
"""The id of the author of the article.
For multilingual articles, this will be the id of the author of the default
language's content. Must be a teammate on the help center's workspace.
"""
body: Optional[str] = None
"""The body of the article in HTML.
For multilingual articles, this will be the body of the default language's
content.
"""
created_at: Optional[int] = None
"""The time when the article was created.
For multilingual articles, this will be the timestamp of creation of the default
language's content in seconds.
"""
default_locale: Optional[str] = None
"""The default locale of the help center.
This field is only returned for multilingual help centers.
"""
description: Optional[str] = None
"""The description of the article.
For multilingual articles, this will be the description of the default
language's content.
"""
parent_id: Optional[int] = None
"""The id of the article's parent collection or section.
An article without this field stands alone.
"""
parent_ids: Optional[List[int]] = None
"""The ids of the article's parent collections or sections.
An article without this field stands alone.
"""
parent_type: Optional[str] = None
"""The type of parent, which can either be a `collection` or `section`."""
state: Optional[Literal["published", "draft"]] = None
"""Whether the article is `published` or is a `draft`.
For multilingual articles, this will be the state of the default language's
content.
"""
title: Optional[str] = None
"""The title of the article.
For multilingual articles, this will be the title of the default language's
content.
"""
translated_content: Optional[ArticleTranslatedContent] = None
"""The Translated Content of an Article.
The keys are the locale codes and the values are the translated content of the
article.
"""
type: Optional[Literal["article"]] = None
"""The type of object - `article`."""
updated_at: Optional[int] = None
"""The time when the article was last updated.
For multilingual articles, this will be the timestamp of last update of the
default language's content in seconds.
"""
url: Optional[str] = None
"""The URL of the article.
For multilingual articles, this will be the URL of the default language's
content.
"""
workspace_id: Optional[str] = None
"""The id of the workspace which the article belongs to."""