Skip to content

Commit 81f1851

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.109.0
1 parent bf6cd40 commit 81f1851

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+222
-102
lines changed

‎entity/README.md‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,111 @@ return value of `Next` is `None`, then there are no more pages to be fetched.
121121
Here's an example of one such pagination call:
122122
<!-- End Pagination -->
123123

124+
125+
126+
<!-- Start Error Handling -->
127+
# Error Handling
128+
129+
Handling errors in your SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
130+
131+
132+
<!-- End Error Handling -->
133+
134+
135+
136+
<!-- Start Server Selection -->
137+
# Server Selection
138+
139+
## Select Server by Index
140+
141+
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
142+
143+
| # | Server | Variables |
144+
| - | ------ | --------- |
145+
| 0 | `https://entity.sls.epilot.io` | None |
146+
147+
For example:
148+
149+
150+
```python
151+
import epilot
152+
from epilot.models import operations, shared
153+
154+
s = epilot.Epilot(
155+
security=shared.Security(
156+
epilot_auth="",
157+
),
158+
server_idx=0
159+
)
160+
161+
req = operations.AttachActivityRequest(
162+
entities=[
163+
'ee1dee63-2954-4671-8246-751c43fec091',
164+
],
165+
id='01F130Q52Q6MWSNS8N2AVXV4JN',
166+
)
167+
168+
res = s.activity.attach_activity(req)
169+
170+
if res.activity_item is not None:
171+
# handle response
172+
pass
173+
```
174+
175+
176+
## Override Server URL Per-Client
177+
178+
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
179+
180+
181+
```python
182+
import epilot
183+
from epilot.models import operations, shared
184+
185+
s = epilot.Epilot(
186+
security=shared.Security(
187+
epilot_auth="",
188+
),
189+
server_url="https://entity.sls.epilot.io"
190+
)
191+
192+
req = operations.AttachActivityRequest(
193+
entities=[
194+
'ee1dee63-2954-4671-8246-751c43fec091',
195+
],
196+
id='01F130Q52Q6MWSNS8N2AVXV4JN',
197+
)
198+
199+
res = s.activity.attach_activity(req)
200+
201+
if res.activity_item is not None:
202+
# handle response
203+
pass
204+
```
205+
<!-- End Server Selection -->
206+
207+
208+
209+
<!-- Start Custom HTTP Client -->
210+
# Custom HTTP Client
211+
212+
The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
213+
214+
215+
For example, you could specify a header for every request that your sdk makes as follows:
216+
217+
```python
218+
import epilot
219+
import requests
220+
221+
http_client = requests.Session()
222+
http_client.headers.update({'x-custom-header': 'someValue'})
223+
s = epilot.Epilot(client: http_client)
224+
```
225+
226+
227+
<!-- End Custom HTTP Client -->
228+
124229
<!-- Placeholder for Future Speakeasy SDK Sections -->
125230

126231

‎entity/RELEASES.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,4 +396,12 @@ Based on:
396396
- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml
397397
- Speakeasy CLI 1.107.0 (2.171.0) https://github.com/speakeasy-api/speakeasy
398398
### Generated
399-
- [python v2.1.3] entity
399+
- [python v2.1.3] entity
400+
401+
## 2023-10-28 01:11:29
402+
### Changes
403+
Based on:
404+
- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml
405+
- Speakeasy CLI 1.109.0 (2.173.0) https://github.com/speakeasy-api/speakeasy
406+
### Generated
407+
- [python v2.1.4] entity

‎entity/docs/models/operations/createentityrequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88
| `entity` | [Optional[shared.Entity]](../../models/shared/entity.md) | :heavy_minus_sign: | N/A | |
99
| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN |
1010
| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | |
11-
| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact |
11+
| `slug` | *str* | :heavy_check_mark: | Entity Type | contact |

‎entity/docs/models/operations/deleteentityrequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
| Field | Type | Required | Description | Example |
77
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
88
| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN |
9-
| `id` | *str* | :heavy_check_mark: | N/A | |
9+
| `id` | *str* | :heavy_check_mark: | Entity id | |
1010
| `slug` | *str* | :heavy_check_mark: | Entity Type | contact |

‎entity/docs/models/operations/deleteschemarequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55

66
| Field | Type | Required | Description | Example |
77
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
8-
| `slug` | *str* | :heavy_check_mark: | N/A | contact |
8+
| `slug` | *str* | :heavy_check_mark: | Entity Type | contact |

‎entity/docs/models/operations/getentityactivityfeedrequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
88
| `after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Get activities after this timestamp | |
99
| `before` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | get activities before this timestamp | |
10-
| `from_` | *Optional[int]* | :heavy_minus_sign: | start from page | |
10+
| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | |
1111
| `id` | *str* | :heavy_check_mark: | Entity id | |
1212
| `include_relations` | *Optional[bool]* | :heavy_minus_sign: | Include activities from related entities | |
1313
| `size` | *Optional[int]* | :heavy_minus_sign: | max number of results to return | |

‎entity/docs/models/operations/getrelatedentitiescountrequest.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
## Fields
55

6-
| Field | Type | Required | Description | Example |
7-
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
8-
| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | To be excluded from the count by given schemas | |
9-
| `id` | *str* | :heavy_check_mark: | Entity id | |
10-
| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact |
6+
| Field | Type | Required | Description | Example |
7+
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
8+
| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to exclude schemas | |
9+
| `id` | *str* | :heavy_check_mark: | Entity id | |
10+
| `slug` | *str* | :heavy_check_mark: | Entity Type | contact |

0 commit comments

Comments
 (0)