Skip to content

Commit 41d323e

Browse files
committed
Update docs
1 parent 2c3703b commit 41d323e

File tree

9 files changed

+676
-206
lines changed

9 files changed

+676
-206
lines changed

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 0x7f8745f52580>)</span>
273+
<span>def <span class="ident">create</span></span>(<span>self, data: <uplink.arguments.Body object at 0x10b77c510>)</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 0x7f8745f52e50>)</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 0x10b77cf90>)</span>
414414
</code></dt>
415415
<dd>
416416
<div class="desc"><p>Update an Article by ID.</p>

docs/intercom_python_sdk/apis/articles/languages.html

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,44 @@ <h2 class="section-title" id="header-classes">Classes</h2>
8080
<dl>
8181
<dt id="intercom_python_sdk.apis.articles.languages.ArticleLanguages"><code class="flex name class">
8282
<span>class <span class="ident">ArticleLanguages</span></span>
83-
<span>(</span><span>value, names=None, *, module=None, qualname=None, type=None, start=1)</span>
83+
<span>(</span><span>*args, **kwds)</span>
8484
</code></dt>
8585
<dd>
86-
<div class="desc"><p>An enumeration.</p></div>
86+
<div class="desc"><p>Create a collection of name/value pairs.</p>
87+
<p>Example enumeration:</p>
88+
<pre><code class="language-python-repl">&gt;&gt;&gt; class Color(Enum):
89+
... RED = 1
90+
... BLUE = 2
91+
... GREEN = 3
92+
</code></pre>
93+
<p>Access them by:</p>
94+
<ul>
95+
<li>attribute access::</li>
96+
</ul>
97+
<pre><code class="language-python-repl">&gt;&gt;&gt; Color.RED
98+
&lt;Color.RED: 1&gt;
99+
</code></pre>
100+
<ul>
101+
<li>value lookup:</li>
102+
</ul>
103+
<pre><code class="language-python-repl">&gt;&gt;&gt; Color(1)
104+
&lt;Color.RED: 1&gt;
105+
</code></pre>
106+
<ul>
107+
<li>name lookup:</li>
108+
</ul>
109+
<pre><code class="language-python-repl">&gt;&gt;&gt; Color['RED']
110+
&lt;Color.RED: 1&gt;
111+
</code></pre>
112+
<p>Enumerations can be iterated over, and know how many members they have:</p>
113+
<pre><code class="language-python-repl">&gt;&gt;&gt; len(Color)
114+
3
115+
</code></pre>
116+
<pre><code class="language-python-repl">&gt;&gt;&gt; list(Color)
117+
[&lt;Color.RED: 1&gt;, &lt;Color.BLUE: 2&gt;, &lt;Color.GREEN: 3&gt;]
118+
</code></pre>
119+
<p>Methods can be added to enumerations, and members can have their own
120+
attributes &ndash; see the documentation for details.</p></div>
87121
<details class="source">
88122
<summary>
89123
<span>Expand source code</span>

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 0x7f87460733d0>)</span>
315+
<span>def <span class="ident">create</span></span>(<span>self, attribute: <uplink.arguments.Body object at 0x10b33b890>)</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 0x7f8746062df0> = False, model: <uplink.arguments.Query object at 0x7f8746062e50> = None)</span>
381+
<span>def <span class="ident">list_all</span></span>(<span>self, include_archived: <uplink.arguments.Query object at 0x10b333e90> = False, model: <uplink.arguments.Query object at 0x10b5a8390> = 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 0x7f8746073910>)</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 0x10b33fa90>)</span>
419419
</code></dt>
420420
<dd>
421421
<div class="desc"><p>Update a data attribute by ID.</p>

docs/intercom_python_sdk/apis/data_events/api.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ <h2 id="returns">Returns</h2>
281281
</details>
282282
</dd>
283283
<dt id="intercom_python_sdk.apis.data_events.api.DataEventsAPI.submit"><code class="name flex">
284-
<span>def <span class="ident">submit</span></span>(<span>self, event: <uplink.arguments.Body object at 0x7f8745eaaee0>)</span>
284+
<span>def <span class="ident">submit</span></span>(<span>self, event: <uplink.arguments.Body object at 0x10b7d9c90>)</span>
285285
</code></dt>
286286
<dd>
287287
<div class="desc"><p>Submit a new data event.</p>

docs/intercom_python_sdk/apis/data_export/api.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ <h3>Class variables</h3>
218218
<h3>Methods</h3>
219219
<dl>
220220
<dt id="intercom_python_sdk.apis.data_export.api.DataExportAPI.cancel"><code class="name flex">
221-
<span>def <span class="ident">cancel</span></span>(<span>self, job_identifier: <uplink.arguments.Path object at 0x7f8745e8d7f0>)</span>
221+
<span>def <span class="ident">cancel</span></span>(<span>self, job_identifier: <uplink.arguments.Path object at 0x10b7f0fd0>)</span>
222222
</code></dt>
223223
<dd>
224224
<div class="desc"><p>Cancel a data export.</p></div>
@@ -233,7 +233,7 @@ <h3>Methods</h3>
233233
</details>
234234
</dd>
235235
<dt id="intercom_python_sdk.apis.data_export.api.DataExportAPI.download"><code class="name flex">
236-
<span>def <span class="ident">download</span></span>(<span>self, job_identifier: <uplink.arguments.Path object at 0x7f8745e8d520>)</span>
236+
<span>def <span class="ident">download</span></span>(<span>self, job_identifier: <uplink.arguments.Path object at 0x10b7f0890>)</span>
237237
</code></dt>
238238
<dd>
239239
<div class="desc"><p>Download a data export.</p></div>
@@ -298,7 +298,7 @@ <h2 id="returns">Returns</h2>
298298
</details>
299299
</dd>
300300
<dt id="intercom_python_sdk.apis.data_export.api.DataExportAPI.get"><code class="name flex">
301-
<span>def <span class="ident">get</span></span>(<span>self, job_identifier: <uplink.arguments.Path object at 0x7f8745e8db20>)</span>
301+
<span>def <span class="ident">get</span></span>(<span>self, job_identifier: <uplink.arguments.Path object at 0x10b7f17d0>)</span>
302302
</code></dt>
303303
<dd>
304304
<div class="desc"><p>Get a data export.</p></div>

0 commit comments

Comments
 (0)