Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions docs/reference/audit_logs/async_client.html
Original file line number Diff line number Diff line change
Expand Up @@ -390,8 +390,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
</details>
<div class="desc"><p>API client for Audit Logs API
See <a href="https://docs.slack.dev/admins/audit-logs-api/">https://docs.slack.dev/admins/audit-logs-api/</a> for more details</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>token</code></strong></dt>
<dd>An admin user's token, which starts with <code>xoxp-</code></dd>
<dt><strong><code>timeout</code></strong></dt>
Expand Down Expand Up @@ -506,15 +507,17 @@ <h3>Methods</h3>
<div class="desc"><p>Returns information about the kind of actions that the Audit Logs API
returns as a list of all actions and a short description of each.
Authentication not required.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>query_params</code></strong></dt>
<dd>Set any values if you want to add query params</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
<dt id="slack_sdk.audit_logs.async_client.AsyncAuditLogsClient.api_call"><code class="name flex">
<span>async def <span class="ident">api_call</span></span>(<span>self,<br>*,<br>http_verb: str = 'GET',<br>path: str,<br>query_params: Dict[str, Any] | None = None,<br>body_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="v1/response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
Expand Down Expand Up @@ -618,8 +621,9 @@ <h2 id="returns">Returns</h2>
Filters are added as query string parameters and can be combined together.
Multiple filter parameters are additive (a boolean AND) and are separated
with an ampersand (&amp;) in the query string. Filtering is entirely optional.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>latest</code></strong></dt>
<dd>Unix timestamp of the most recent audit event to include (inclusive).</dd>
<dt><strong><code>oldest</code></strong></dt>
Expand All @@ -640,8 +644,9 @@ <h2 id="args">Args</h2>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
<dt id="slack_sdk.audit_logs.async_client.AsyncAuditLogsClient.schemas"><code class="name flex">
<span>async def <span class="ident">schemas</span></span>(<span>self,<br>*,<br>query_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="v1/response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
Expand Down Expand Up @@ -676,15 +681,17 @@ <h2 id="returns">Returns</h2>
<div class="desc"><p>Returns information about the kind of objects which the Audit Logs API
returns as a list of all objects and a short description.
Authentication not required.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>query_params</code></strong></dt>
<dd>Set any values if you want to add query params</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
</dl>
</dd>
Expand Down
27 changes: 17 additions & 10 deletions docs/reference/audit_logs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -403,8 +403,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
</details>
<div class="desc"><p>API client for Audit Logs API
See <a href="https://docs.slack.dev/admins/audit-logs-api/">https://docs.slack.dev/admins/audit-logs-api/</a> for more details</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>token</code></strong></dt>
<dd>An admin user's token, which starts with <code>xoxp-</code></dd>
<dt><strong><code>timeout</code></strong></dt>
Expand Down Expand Up @@ -501,15 +502,17 @@ <h3>Methods</h3>
<div class="desc"><p>Returns information about the kind of actions that the Audit Logs API
returns as a list of all actions and a short description of each.
Authentication not required.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>query_params</code></strong></dt>
<dd>Set any values if you want to add query params</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
<dt id="slack_sdk.audit_logs.AuditLogsClient.api_call"><code class="name flex">
<span>def <span class="ident">api_call</span></span>(<span>self,<br>*,<br>http_verb: str = 'GET',<br>path: str,<br>query_params: Dict[str, Any] | None = None,<br>body_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="v1/response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
Expand Down Expand Up @@ -617,8 +620,9 @@ <h2 id="returns">Returns</h2>
Filters are added as query string parameters and can be combined together.
Multiple filter parameters are additive (a boolean AND) and are separated
with an ampersand (&amp;) in the query string. Filtering is entirely optional.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>latest</code></strong></dt>
<dd>Unix timestamp of the most recent audit event to include (inclusive).</dd>
<dt><strong><code>oldest</code></strong></dt>
Expand All @@ -639,8 +643,9 @@ <h2 id="args">Args</h2>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
<dt id="slack_sdk.audit_logs.AuditLogsClient.schemas"><code class="name flex">
<span>def <span class="ident">schemas</span></span>(<span>self,<br>*,<br>query_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="v1/response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
Expand Down Expand Up @@ -675,15 +680,17 @@ <h2 id="returns">Returns</h2>
<div class="desc"><p>Returns information about the kind of objects which the Audit Logs API
returns as a list of all objects and a short description.
Authentication not required.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>query_params</code></strong></dt>
<dd>Set any values if you want to add query params</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
</dl>
</dd>
Expand Down
27 changes: 17 additions & 10 deletions docs/reference/audit_logs/v1/async_client.html
Original file line number Diff line number Diff line change
Expand Up @@ -392,8 +392,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
</details>
<div class="desc"><p>API client for Audit Logs API
See <a href="https://docs.slack.dev/admins/audit-logs-api/">https://docs.slack.dev/admins/audit-logs-api/</a> for more details</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>token</code></strong></dt>
<dd>An admin user's token, which starts with <code>xoxp-</code></dd>
<dt><strong><code>timeout</code></strong></dt>
Expand Down Expand Up @@ -508,15 +509,17 @@ <h3>Methods</h3>
<div class="desc"><p>Returns information about the kind of actions that the Audit Logs API
returns as a list of all actions and a short description of each.
Authentication not required.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>query_params</code></strong></dt>
<dd>Set any values if you want to add query params</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.async_client.AsyncAuditLogsClient.api_call"><code class="name flex">
<span>async def <span class="ident">api_call</span></span>(<span>self,<br>*,<br>http_verb: str = 'GET',<br>path: str,<br>query_params: Dict[str, Any] | None = None,<br>body_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
Expand Down Expand Up @@ -620,8 +623,9 @@ <h2 id="returns">Returns</h2>
Filters are added as query string parameters and can be combined together.
Multiple filter parameters are additive (a boolean AND) and are separated
with an ampersand (&amp;) in the query string. Filtering is entirely optional.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>latest</code></strong></dt>
<dd>Unix timestamp of the most recent audit event to include (inclusive).</dd>
<dt><strong><code>oldest</code></strong></dt>
Expand All @@ -642,8 +646,9 @@ <h2 id="args">Args</h2>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.async_client.AsyncAuditLogsClient.schemas"><code class="name flex">
<span>async def <span class="ident">schemas</span></span>(<span>self,<br>*,<br>query_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
Expand Down Expand Up @@ -678,15 +683,17 @@ <h2 id="returns">Returns</h2>
<div class="desc"><p>Returns information about the kind of objects which the Audit Logs API
returns as a list of all objects and a short description.
Authentication not required.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>query_params</code></strong></dt>
<dd>Set any values if you want to add query params</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
</dl>
</dd>
Expand Down
27 changes: 17 additions & 10 deletions docs/reference/audit_logs/v1/client.html
Original file line number Diff line number Diff line change
Expand Up @@ -392,8 +392,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
</details>
<div class="desc"><p>API client for Audit Logs API
See <a href="https://docs.slack.dev/admins/audit-logs-api/">https://docs.slack.dev/admins/audit-logs-api/</a> for more details</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>token</code></strong></dt>
<dd>An admin user's token, which starts with <code>xoxp-</code></dd>
<dt><strong><code>timeout</code></strong></dt>
Expand Down Expand Up @@ -490,15 +491,17 @@ <h3>Methods</h3>
<div class="desc"><p>Returns information about the kind of actions that the Audit Logs API
returns as a list of all actions and a short description of each.
Authentication not required.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>query_params</code></strong></dt>
<dd>Set any values if you want to add query params</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.api_call"><code class="name flex">
<span>def <span class="ident">api_call</span></span>(<span>self,<br>*,<br>http_verb: str = 'GET',<br>path: str,<br>query_params: Dict[str, Any] | None = None,<br>body_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
Expand Down Expand Up @@ -606,8 +609,9 @@ <h2 id="returns">Returns</h2>
Filters are added as query string parameters and can be combined together.
Multiple filter parameters are additive (a boolean AND) and are separated
with an ampersand (&amp;) in the query string. Filtering is entirely optional.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>latest</code></strong></dt>
<dd>Unix timestamp of the most recent audit event to include (inclusive).</dd>
<dt><strong><code>oldest</code></strong></dt>
Expand All @@ -628,8 +632,9 @@ <h2 id="args">Args</h2>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
<dt id="slack_sdk.audit_logs.v1.client.AuditLogsClient.schemas"><code class="name flex">
<span>def <span class="ident">schemas</span></span>(<span>self,<br>*,<br>query_params: Dict[str, Any] | None = None,<br>headers: Dict[str, str] | None = None) ‑> <a title="slack_sdk.audit_logs.v1.response.AuditLogsResponse" href="response.html#slack_sdk.audit_logs.v1.response.AuditLogsResponse">AuditLogsResponse</a></span>
Expand Down Expand Up @@ -664,15 +669,17 @@ <h2 id="returns">Returns</h2>
<div class="desc"><p>Returns information about the kind of objects which the Audit Logs API
returns as a list of all objects and a short description.
Authentication not required.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>query_params</code></strong></dt>
<dd>Set any values if you want to add query params</dd>
<dt><strong><code>headers</code></strong></dt>
<dd>Additional request headers</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>API response</p></div>
<p>Returns
-----=
API response</p></div>
</dd>
</dl>
</dd>
Expand Down
8 changes: 5 additions & 3 deletions docs/reference/errors/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,15 @@ <h3>Ancestors</h3>
super(SlackApiError, self).__init__(msg)</code></pre>
</details>
<div class="desc"><p>Error raised when Slack does not send the expected response.</p>
<h2 id="attributes">Attributes</h2>
<dl>
<dt>Attributes</dt>
<dt>-----=</dt>
<dt><strong><code>response</code></strong> :&ensp;<code>SlackResponse</code></dt>
<dd>The SlackResponse object containing all of the data sent back from the API.</dd>
</dl>
<h2 id="note">Note</h2>
<p>The message (str) passed into the exception is used when
<p>Note
-----=
The message (str) passed into the exception is used when
a user converts the exception to a str.
i.e. str(SlackApiError("This text will be sent as a string."))</p></div>
<h3>Ancestors</h3>
Expand Down
11 changes: 7 additions & 4 deletions docs/reference/http_retry/async_handler.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<div class="desc"><p>Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter
see also: <a href="https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/">https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/</a></p>
<p>Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>backoff_factor</code></strong></dt>
<dd>The factor for the backoff interval calculation</dd>
<dt><strong><code>jitter</code></strong></dt>
Expand Down Expand Up @@ -290,13 +291,15 @@ <h3>Methods</h3>
raise NotImplementedError()</code></pre>
</details>
<div class="desc"><p>Calculates an interval duration in seconds.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>current_attempt</code></strong></dt>
<dd>the number of the current attempt (zero-origin; 0 means no retries are done so far)</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>calculated interval duration in seconds</p></div>
<p>Returns
-----=
calculated interval duration in seconds</p></div>
</dd>
</dl>
</dd>
Expand Down
9 changes: 6 additions & 3 deletions docs/reference/http_retry/builtin_async_handlers.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
</details>
<div class="desc"><p>RetryHandler that does retries for connectivity issues.</p>
<p>RetryHandler interface.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>max_retry_count</code></strong></dt>
<dd>The maximum times to do retries</dd>
<dt><strong><code>interval_calculator</code></strong></dt>
Expand Down Expand Up @@ -168,8 +169,9 @@ <h3>Ancestors</h3>
</details>
<div class="desc"><p>RetryHandler that does retries for rate limited errors.</p>
<p>RetryHandler interface.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>max_retry_count</code></strong></dt>
<dd>The maximum times to do retries</dd>
<dt><strong><code>interval_calculator</code></strong></dt>
Expand Down Expand Up @@ -250,8 +252,9 @@ <h3>Methods</h3>
</details>
<div class="desc"><p>RetryHandler that does retries for server errors.</p>
<p>RetryHandler interface.</p>
<h2 id="args">Args</h2>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>max_retry_count</code></strong></dt>
<dd>The maximum times to do retries</dd>
<dt><strong><code>interval_calculator</code></strong></dt>
Expand Down
Loading
Loading