Skip to content

Commit 7280b41

Browse files
0xRy4n0xRy4n
committed
Doc update
1 parent ec92267 commit 7280b41

File tree

19 files changed

+364
-225
lines changed

19 files changed

+364
-225
lines changed

‎docs/intercom_python_sdk/apis/admins/models.html‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,10 @@ <h1 id="admins-api-models">Admins API Models</h1>
329329
return iter(self.admins)
330330

331331
def __len__(self):
332-
return len(self.admins)</code></pre>
332+
return len(self.admins)
333+
334+
def __getitem__(self, index):
335+
return self.admins[index]</code></pre>
333336
</details>
334337
</section>
335338
<section>
@@ -960,7 +963,10 @@ <h2 id="attributes">Attributes</h2>
960963
return iter(self.admins)
961964

962965
def __len__(self):
963-
return len(self.admins)</code></pre>
966+
return len(self.admins)
967+
968+
def __getitem__(self, index):
969+
return self.admins[index]</code></pre>
964970
</details>
965971
<h3>Ancestors</h3>
966972
<ul class="hlist">

‎docs/intercom_python_sdk/apis/articles/api.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ <h3>Class variables</h3>
270270
<h3>Methods</h3>
271271
<dl>
272272
<dt id="intercom_python_sdk.apis.articles.api.ArticlesAPI.create"><code class="name flex">
273-
<span>def <span class="ident">create</span></span>(<span>self, data: <uplink.arguments.Body object at 0x1027fb610>)</span>
273+
<span>def <span class="ident">create</span></span>(<span>self, data: <uplink.arguments.Body object at 0x105b70950>)</span>
274274
</code></dt>
275275
<dd>
276276
<div class="desc"><p>Create an Article.</p>
@@ -410,7 +410,7 @@ <h2 id="returns">Returns</h2>
410410
</details>
411411
</dd>
412412
<dt id="intercom_python_sdk.apis.articles.api.ArticlesAPI.update_by_id"><code class="name flex">
413-
<span>def <span class="ident">update_by_id</span></span>(<span>self, article_id: Union[str, int], data: <uplink.arguments.Body object at 0x1027d6dd0>)</span>
413+
<span>def <span class="ident">update_by_id</span></span>(<span>self, article_id: Union[str, int], data: <uplink.arguments.Body object at 0x105b71f50>)</span>
414414
</code></dt>
415415
<dd>
416416
<div class="desc"><p>Update an Article by ID.</p>

‎docs/intercom_python_sdk/apis/articles/models.html‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ <h1 id="articles-api-models">Articles API Models</h1>
106106
self.__default_locale = kwargs.get(&#39;default_locale&#39;, &#39;&#39;)
107107
self.__statistics = kwargs.get(&#39;statistics&#39;, None)
108108
self.__id = kwargs.get(&#39;id&#39;, None)
109+
self.__translated_content = kwargs.get(&#39;translated_content&#39;, {})
109110

110111
# Properties
111112
@property
@@ -269,6 +270,16 @@ <h1 id="articles-api-models">Articles API Models</h1>
269270
&#34;&#34;&#34;
270271
return self.__id
271272

273+
@property
274+
def translated_content(self) -&gt; dict:
275+
&#34;&#34;&#34;
276+
The translated content of the Article.
277+
278+
Returns:
279+
dict: The translated content of the Article.
280+
&#34;&#34;&#34;
281+
return self.__translated_content
282+
272283
@property
273284
def content(self) -&gt; BeautifulSoup:
274285
&#34;&#34;&#34;
@@ -441,6 +452,16 @@ <h1 id="articles-api-models">Articles API Models</h1>
441452
&#34;&#34;&#34;
442453
self.__id = id
443454

455+
@translated_content.setter
456+
def translated_content(self, translated_content: dict):
457+
&#34;&#34;&#34;
458+
The translated content of the Article.
459+
460+
Args:
461+
translated_content (dict): The translated content of the Article.
462+
&#34;&#34;&#34;
463+
self.__translated_content = translated_content
464+
444465
# Methods
445466

446467
def update(self):
@@ -660,6 +681,7 @@ <h2 id="attributes">Attributes</h2>
660681
self.__default_locale = kwargs.get(&#39;default_locale&#39;, &#39;&#39;)
661682
self.__statistics = kwargs.get(&#39;statistics&#39;, None)
662683
self.__id = kwargs.get(&#39;id&#39;, None)
684+
self.__translated_content = kwargs.get(&#39;translated_content&#39;, {})
663685

664686
# Properties
665687
@property
@@ -823,6 +845,16 @@ <h2 id="attributes">Attributes</h2>
823845
&#34;&#34;&#34;
824846
return self.__id
825847

848+
@property
849+
def translated_content(self) -&gt; dict:
850+
&#34;&#34;&#34;
851+
The translated content of the Article.
852+
853+
Returns:
854+
dict: The translated content of the Article.
855+
&#34;&#34;&#34;
856+
return self.__translated_content
857+
826858
@property
827859
def content(self) -&gt; BeautifulSoup:
828860
&#34;&#34;&#34;
@@ -995,6 +1027,16 @@ <h2 id="attributes">Attributes</h2>
9951027
&#34;&#34;&#34;
9961028
self.__id = id
9971029

1030+
@translated_content.setter
1031+
def translated_content(self, translated_content: dict):
1032+
&#34;&#34;&#34;
1033+
The translated content of the Article.
1034+
1035+
Args:
1036+
translated_content (dict): The translated content of the Article.
1037+
&#34;&#34;&#34;
1038+
self.__translated_content = translated_content
1039+
9981040
# Methods
9991041

10001042
def update(self):
@@ -1311,6 +1353,29 @@ <h2 id="returns">Returns</h2>
13111353
return self.__title</code></pre>
13121354
</details>
13131355
</dd>
1356+
<dt id="intercom_python_sdk.apis.articles.models.Article.translated_content"><code class="name">var <span class="ident">translated_content</span> : dict</code></dt>
1357+
<dd>
1358+
<div class="desc"><p>The translated content of the Article.</p>
1359+
<h2 id="returns">Returns</h2>
1360+
<dl>
1361+
<dt><code>dict</code></dt>
1362+
<dd>The translated content of the Article.</dd>
1363+
</dl></div>
1364+
<details class="source">
1365+
<summary>
1366+
<span>Expand source code</span>
1367+
</summary>
1368+
<pre><code class="python">@property
1369+
def translated_content(self) -&gt; dict:
1370+
&#34;&#34;&#34;
1371+
The translated content of the Article.
1372+
1373+
Returns:
1374+
dict: The translated content of the Article.
1375+
&#34;&#34;&#34;
1376+
return self.__translated_content</code></pre>
1377+
</details>
1378+
</dd>
13141379
<dt id="intercom_python_sdk.apis.articles.models.Article.type"><code class="name">var <span class="ident">type</span> : str</code></dt>
13151380
<dd>
13161381
<div class="desc"><p>The type of the Article.</p>
@@ -1880,6 +1945,7 @@ <h4><code><a title="intercom_python_sdk.apis.articles.models.Article" href="#int
18801945
<li><code><a title="intercom_python_sdk.apis.articles.models.Article.state" href="#intercom_python_sdk.apis.articles.models.Article.state">state</a></code></li>
18811946
<li><code><a title="intercom_python_sdk.apis.articles.models.Article.statistics" href="#intercom_python_sdk.apis.articles.models.Article.statistics">statistics</a></code></li>
18821947
<li><code><a title="intercom_python_sdk.apis.articles.models.Article.title" href="#intercom_python_sdk.apis.articles.models.Article.title">title</a></code></li>
1948+
<li><code><a title="intercom_python_sdk.apis.articles.models.Article.translated_content" href="#intercom_python_sdk.apis.articles.models.Article.translated_content">translated_content</a></code></li>
18831949
<li><code><a title="intercom_python_sdk.apis.articles.models.Article.type" href="#intercom_python_sdk.apis.articles.models.Article.type">type</a></code></li>
18841950
<li><code><a title="intercom_python_sdk.apis.articles.models.Article.update" href="#intercom_python_sdk.apis.articles.models.Article.update">update</a></code></li>
18851951
<li><code><a title="intercom_python_sdk.apis.articles.models.Article.updated_at" href="#intercom_python_sdk.apis.articles.models.Article.updated_at">updated_at</a></code></li>

‎docs/intercom_python_sdk/apis/articles/schemas.html‎

Lines changed: 66 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -105,16 +105,16 @@ <h1 id="articles-api-schemas">Articles API Schemas</h1>
105105
id = fields.Int(required=True)
106106
type = fields.Str(allow_none=True)
107107
workspace_id = fields.Str(allow_none=True)
108-
title = fields.Str()
108+
title = fields.Str(required=True)
109109
description = fields.Str(allow_none=True)
110-
body = fields.Str()
111-
author_id = fields.Int(allow_none=True)
110+
body = fields.Str(required=True)
111+
author_id = fields.Int(required=True)
112112
state = fields.Str(allow_none=True)
113113
created_at = fields.Int(allow_none=True)
114114
updated_at = fields.Int(allow_none=True)
115115
url = fields.Str(allow_none=True)
116116
default_locale = fields.Str(allow_none=True)
117-
translated_content = fields.Dict(allow_none=True)
117+
translated_content = fields.Dict(values=fields.Str(), default=&#39;&#39;, allow_none=True)
118118
statistics = fields.Nested(ArticleStatisticsSchema, allow_none=True)
119119

120120
parent_id = fields.Int(allow_none=True)
@@ -125,6 +125,15 @@ <h1 id="articles-api-schemas">Articles API Schemas</h1>
125125
return a_models.Article(**data)
126126

127127

128+
class ArticlePagesSchema(SchemaBase):
129+
&#34;&#34;&#34; Paging information for a list of Articles on Intercom. &#34;&#34;&#34;
130+
type = fields.Str(default=&#39;pages&#39;)
131+
page = fields.Int()
132+
next = fields.Url(allow_none=True)
133+
per_page = fields.Int(default=50)
134+
total_pages = fields.Int()
135+
136+
128137
class ArticleListSchema(SchemaBase):
129138
&#34;&#34;&#34; This schema represents a list of Articles on Intercom.
130139

@@ -133,7 +142,7 @@ <h1 id="articles-api-schemas">Articles API Schemas</h1>
133142
total_count (int): The total number of Articles.
134143
data (list): The list of Articles.
135144
&#34;&#34;&#34;
136-
pages = fields.Dict()
145+
pages = fields.Nested(ArticlePagesSchema)
137146
total_count = fields.Int()
138147
data = fields.Nested(ArticleSchema, many=True)
139148

@@ -178,7 +187,7 @@ <h2 id="attributes">Attributes</h2>
178187
total_count (int): The total number of Articles.
179188
data (list): The list of Articles.
180189
&#34;&#34;&#34;
181-
pages = fields.Dict()
190+
pages = fields.Nested(ArticlePagesSchema)
182191
total_count = fields.Int()
183192
data = fields.Nested(ArticleSchema, many=True)
184193

@@ -226,6 +235,47 @@ <h3>Inherited members</h3>
226235
</li>
227236
</ul>
228237
</dd>
238+
<dt id="intercom_python_sdk.apis.articles.schemas.ArticlePagesSchema"><code class="flex name class">
239+
<span>class <span class="ident">ArticlePagesSchema</span></span>
240+
<span>(</span><span>*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)</span>
241+
</code></dt>
242+
<dd>
243+
<div class="desc"><p>Paging information for a list of Articles on Intercom.</p></div>
244+
<details class="source">
245+
<summary>
246+
<span>Expand source code</span>
247+
</summary>
248+
<pre><code class="python">class ArticlePagesSchema(SchemaBase):
249+
&#34;&#34;&#34; Paging information for a list of Articles on Intercom. &#34;&#34;&#34;
250+
type = fields.Str(default=&#39;pages&#39;)
251+
page = fields.Int()
252+
next = fields.Url(allow_none=True)
253+
per_page = fields.Int(default=50)
254+
total_pages = fields.Int()</code></pre>
255+
</details>
256+
<h3>Ancestors</h3>
257+
<ul class="hlist">
258+
<li><a title="intercom_python_sdk.core.schema_base.SchemaBase" href="../../core/schema_base.html#intercom_python_sdk.core.schema_base.SchemaBase">SchemaBase</a></li>
259+
<li>marshmallow.schema.Schema</li>
260+
<li>marshmallow.base.SchemaABC</li>
261+
<li>abc.ABC</li>
262+
</ul>
263+
<h3>Class variables</h3>
264+
<dl>
265+
<dt id="intercom_python_sdk.apis.articles.schemas.ArticlePagesSchema.opts"><code class="name">var <span class="ident">opts</span></code></dt>
266+
<dd>
267+
<div class="desc"></div>
268+
</dd>
269+
</dl>
270+
<h3>Inherited members</h3>
271+
<ul class="hlist">
272+
<li><code><b><a title="intercom_python_sdk.core.schema_base.SchemaBase" href="../../core/schema_base.html#intercom_python_sdk.core.schema_base.SchemaBase">SchemaBase</a></b></code>:
273+
<ul class="hlist">
274+
<li><code><a title="intercom_python_sdk.core.schema_base.SchemaBase.Meta" href="../../core/schema_base.html#intercom_python_sdk.core.schema_base.SchemaBase.Meta">Meta</a></code></li>
275+
</ul>
276+
</li>
277+
</ul>
278+
</dd>
229279
<dt id="intercom_python_sdk.apis.articles.schemas.ArticleSchema"><code class="flex name class">
230280
<span>class <span class="ident">ArticleSchema</span></span>
231281
<span>(</span><span>*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)</span>
@@ -297,16 +347,16 @@ <h2 id="attributes">Attributes</h2>
297347
id = fields.Int(required=True)
298348
type = fields.Str(allow_none=True)
299349
workspace_id = fields.Str(allow_none=True)
300-
title = fields.Str()
350+
title = fields.Str(required=True)
301351
description = fields.Str(allow_none=True)
302-
body = fields.Str()
303-
author_id = fields.Int(allow_none=True)
352+
body = fields.Str(required=True)
353+
author_id = fields.Int(required=True)
304354
state = fields.Str(allow_none=True)
305355
created_at = fields.Int(allow_none=True)
306356
updated_at = fields.Int(allow_none=True)
307357
url = fields.Str(allow_none=True)
308358
default_locale = fields.Str(allow_none=True)
309-
translated_content = fields.Dict(allow_none=True)
359+
translated_content = fields.Dict(values=fields.Str(), default=&#39;&#39;, allow_none=True)
310360
statistics = fields.Nested(ArticleStatisticsSchema, allow_none=True)
311361

312362
parent_id = fields.Int(allow_none=True)
@@ -449,6 +499,12 @@ <h4><code><a title="intercom_python_sdk.apis.articles.schemas.ArticleListSchema"
449499
</ul>
450500
</li>
451501
<li>
502+
<h4><code><a title="intercom_python_sdk.apis.articles.schemas.ArticlePagesSchema" href="#intercom_python_sdk.apis.articles.schemas.ArticlePagesSchema">ArticlePagesSchema</a></code></h4>
503+
<ul class="">
504+
<li><code><a title="intercom_python_sdk.apis.articles.schemas.ArticlePagesSchema.opts" href="#intercom_python_sdk.apis.articles.schemas.ArticlePagesSchema.opts">opts</a></code></li>
505+
</ul>
506+
</li>
507+
<li>
452508
<h4><code><a title="intercom_python_sdk.apis.articles.schemas.ArticleSchema" href="#intercom_python_sdk.apis.articles.schemas.ArticleSchema">ArticleSchema</a></code></h4>
453509
<ul class="">
454510
<li><code><a title="intercom_python_sdk.apis.articles.schemas.ArticleSchema.make_article" href="#intercom_python_sdk.apis.articles.schemas.ArticleSchema.make_article">make_article</a></code></li>

‎docs/intercom_python_sdk/apis/data_attributes/api.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ <h2 id="returns">Returns</h2>
312312
</details>
313313
</dd>
314314
<dt id="intercom_python_sdk.apis.data_attributes.api.DataAttributesAPI.create"><code class="name flex">
315-
<span>def <span class="ident">create</span></span>(<span>self, attribute: <uplink.arguments.Body object at 0x1026d7a10>)</span>
315+
<span>def <span class="ident">create</span></span>(<span>self, attribute: <uplink.arguments.Body object at 0x105baa790>)</span>
316316
</code></dt>
317317
<dd>
318318
<div class="desc"><p>Create a new data attribute.</p>
@@ -378,7 +378,7 @@ <h2 id="returns">Returns</h2>
378378
</details>
379379
</dd>
380380
<dt id="intercom_python_sdk.apis.data_attributes.api.DataAttributesAPI.list_all"><code class="name flex">
381-
<span>def <span class="ident">list_all</span></span>(<span>self, include_archived: <uplink.arguments.Query object at 0x101dba5d0> = False, model: <uplink.arguments.Query object at 0x101d9d910> = None)</span>
381+
<span>def <span class="ident">list_all</span></span>(<span>self, include_archived: <uplink.arguments.Query object at 0x104720450> = False, model: <uplink.arguments.Query object at 0x105acad90> = None)</span>
382382
</code></dt>
383383
<dd>
384384
<div class="desc"><p>List all data attributes.</p>
@@ -415,7 +415,7 @@ <h2 id="returns">Returns</h2>
415415
</details>
416416
</dd>
417417
<dt id="intercom_python_sdk.apis.data_attributes.api.DataAttributesAPI.update_by_id"><code class="name flex">
418-
<span>def <span class="ident">update_by_id</span></span>(<span>self, attribute_id: Union[str, int], attribute: <uplink.arguments.Body object at 0x1026f8cd0>)</span>
418+
<span>def <span class="ident">update_by_id</span></span>(<span>self, attribute_id: Union[str, int], attribute: <uplink.arguments.Body object at 0x105bc8290>)</span>
419419
</code></dt>
420420
<dd>
421421
<div class="desc"><p>Update a data attribute by ID.</p>

‎docs/intercom_python_sdk/apis/data_attributes/schemas.html‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ <h1 class="title">Module <code>intercom_python_sdk.apis.data_attributes.schemas<
8686
name = fields.Str(required=True)
8787
model = fields.Str(required=True)
8888
data_type = fields.Str(required=True)
89-
type = fields.Str()
89+
type = fields.Str(default=&#39;data_attribute&#39;)
9090
id = fields.Int()
9191
full_name = fields.Str()
9292
label = fields.Str()
@@ -115,11 +115,10 @@ <h1 class="title">Module <code>intercom_python_sdk.apis.data_attributes.schemas<
115115
pages (PagesSchema): The pagination information for the Data Attribute list.
116116
&#34;&#34;&#34;
117117
type = fields.Str()
118-
data = fields.List(fields.Nested(DataAttributeSchema(unknown=marshmallow.EXCLUDE)))
118+
data = fields.Nested(DataAttributeSchema, many=True)
119119

120120
@marshmallow.post_load
121121
def make_data_attribute_list(self, data, **kwargs):
122-
print(data)
123122
return da_models.DataAttributeList(**data)</code></pre>
124123
</details>
125124
</section>
@@ -161,11 +160,10 @@ <h2 id="attributes">Attributes</h2>
161160
pages (PagesSchema): The pagination information for the Data Attribute list.
162161
&#34;&#34;&#34;
163162
type = fields.Str()
164-
data = fields.List(fields.Nested(DataAttributeSchema(unknown=marshmallow.EXCLUDE)))
163+
data = fields.Nested(DataAttributeSchema, many=True)
165164

166165
@marshmallow.post_load
167166
def make_data_attribute_list(self, data, **kwargs):
168-
print(data)
169167
return da_models.DataAttributeList(**data)</code></pre>
170168
</details>
171169
<h3>Ancestors</h3>
@@ -195,7 +193,6 @@ <h3>Methods</h3>
195193
</summary>
196194
<pre><code class="python">@marshmallow.post_load
197195
def make_data_attribute_list(self, data, **kwargs):
198-
print(data)
199196
return da_models.DataAttributeList(**data)</code></pre>
200197
</details>
201198
</dd>
@@ -279,7 +276,7 @@ <h2 id="attributes">Attributes</h2>
279276
name = fields.Str(required=True)
280277
model = fields.Str(required=True)
281278
data_type = fields.Str(required=True)
282-
type = fields.Str()
279+
type = fields.Str(default=&#39;data_attribute&#39;)
283280
id = fields.Int()
284281
full_name = fields.Str()
285282
label = fields.Str()

0 commit comments

Comments
 (0)