Skip to content

Commit ee361d5

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.104.0
1 parent 7e8d904 commit ee361d5

File tree

13 files changed

+184
-17
lines changed

13 files changed

+184
-17
lines changed

‎entity/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ if res.activity_item is not None:
7272
* [get_related_entities_count](docs/sdks/relations/README.md#get_related_entities_count) - getRelatedEntitiesCount
7373
* [get_relations](docs/sdks/relations/README.md#get_relations) - getRelations
7474
* [get_relations_v2](docs/sdks/relations/README.md#get_relations_v2) - getRelationsV2
75+
* [get_relations_v3](docs/sdks/relations/README.md#get_relations_v3) - getRelationsV3
7576
* [update_relation](docs/sdks/relations/README.md#update_relation) - updateRelation
7677

7778
### [saved_views](docs/sdks/savedviews/README.md)

‎entity/RELEASES.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,4 +372,12 @@ Based on:
372372
- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml
373373
- Speakeasy CLI 1.104.0 (2.169.0) https://github.com/speakeasy-api/speakeasy
374374
### Generated
375-
- [python v2.1.0] entity
375+
- [python v2.1.0] entity
376+
377+
## 2023-10-23 01:14:22
378+
### Changes
379+
Based on:
380+
- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml
381+
- Speakeasy CLI 1.104.0 (2.169.0) https://github.com/speakeasy-api/speakeasy
382+
### Generated
383+
- [python v2.1.1] entity

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# GetRelationsV3Request
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description | Example |
7+
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
8+
| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to exclude schemas | |
9+
| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | |
10+
| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | |
11+
| `id` | *str* | :heavy_check_mark: | Entity id | |
12+
| `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | |
13+
| `include_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to only include schemas | |
14+
| `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | |
15+
| `slug` | *str* | :heavy_check_mark: | Entity Type | contact |

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# GetRelationsV3Response
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
8+
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `get_relations_resp_with_pagination` | [Optional[shared.GetRelationsRespWithPagination]](../../models/shared/getrelationsrespwithpagination.md) | :heavy_minus_sign: | Success |
10+
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
11+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

‎entity/docs/sdks/entities/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,14 @@ s = epilot.Epilot(
102102
req = operations.CreateEntityRequest(
103103
entity=shared.Entity(
104104
additional_properties={
105-
"_schema": 'string',
106-
"_tags": 'string',
107-
"_created_at": 'string',
108105
"_updated_at": 'string',
109106
"_acl": 'string',
110107
"_id": 'string',
111108
"_org": 'string',
112109
"_owners": 'string',
110+
"_schema": 'string',
111+
"_tags": 'string',
112+
"_created_at": 'string',
113113
},
114114
acl=shared.EntityACL(
115115
additional_properties={
@@ -373,14 +373,14 @@ s = epilot.Epilot(
373373
req = operations.PatchEntityRequest(
374374
entity=shared.Entity(
375375
additional_properties={
376+
"_owners": 'string',
377+
"_schema": 'string',
378+
"_tags": 'string',
376379
"_created_at": 'string',
377380
"_updated_at": 'string',
378381
"_acl": 'string',
379382
"_id": 'string',
380383
"_org": 'string',
381-
"_owners": 'string',
382-
"_schema": 'string',
383-
"_tags": 'string',
384384
},
385385
acl=shared.EntityACL(
386386
additional_properties={
@@ -605,14 +605,14 @@ s = epilot.Epilot(
605605
req = operations.UpdateEntityRequest(
606606
entity=shared.Entity(
607607
additional_properties={
608-
"_schema": 'string',
609-
"_tags": 'string',
610608
"_created_at": 'string',
611609
"_updated_at": 'string',
612610
"_acl": 'string',
613611
"_id": 'string',
614612
"_org": 'string',
615613
"_owners": 'string',
614+
"_schema": 'string',
615+
"_tags": 'string',
616616
},
617617
acl=shared.EntityACL(
618618
additional_properties={
@@ -711,14 +711,14 @@ req = operations.UpsertEntityRequest(
711711
request_body=operations.UpsertEntityRequestBody(
712712
entity=shared.Entity(
713713
additional_properties={
714+
"_created_at": 'string',
715+
"_updated_at": 'string',
714716
"_acl": 'string',
715717
"_id": 'string',
716718
"_org": 'string',
717719
"_owners": 'string',
718720
"_schema": 'string',
719721
"_tags": 'string',
720-
"_created_at": 'string',
721-
"_updated_at": 'string',
722722
},
723723
acl=shared.EntityACL(
724724
additional_properties={

‎entity/docs/sdks/relations/README.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Entity Relationships
1212
* [get_related_entities_count](#get_related_entities_count) - getRelatedEntitiesCount
1313
* [get_relations](#get_relations) - getRelations
1414
* [get_relations_v2](#get_relations_v2) - getRelationsV2
15+
* [get_relations_v3](#get_relations_v3) - getRelationsV3
1516
* [update_relation](#update_relation) - updateRelation
1617

1718
## add_relations
@@ -252,6 +253,57 @@ if res.get_relations_resp_with_pagination is not None:
252253
**[operations.GetRelationsV2Response](../../models/operations/getrelationsv2response.md)**
253254

254255

256+
## get_relations_v3
257+
258+
Returns 1st level direct relations for an entity with pagination.
259+
260+
You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
261+
262+
Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
263+
264+
265+
### Example Usage
266+
267+
```python
268+
import epilot
269+
from epilot.models import operations, shared
270+
271+
s = epilot.Epilot(
272+
security=shared.Security(
273+
epilot_auth="",
274+
),
275+
)
276+
277+
req = operations.GetRelationsV3Request(
278+
exclude_schemas=[
279+
'contact',
280+
],
281+
id='6e35e8b4-d75d-4f84-a79c-6a8b45571a04',
282+
include_schemas=[
283+
'contact',
284+
],
285+
slug='contact',
286+
)
287+
288+
res = s.relations.get_relations_v3(req)
289+
290+
if res.get_relations_resp_with_pagination is not None:
291+
# handle response
292+
pass
293+
```
294+
295+
### Parameters
296+
297+
| Parameter | Type | Required | Description |
298+
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
299+
| `request` | [operations.GetRelationsV3Request](../../models/operations/getrelationsv3request.md) | :heavy_check_mark: | The request object to use for the request. |
300+
301+
302+
### Response
303+
304+
**[operations.GetRelationsV3Response](../../models/operations/getrelationsv3response.md)**
305+
306+
255307
## update_relation
256308

257309
Updates an existing relation between two entities.

‎entity/files.gen‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ src/epilot/models/operations/deleterelation.py
3535
src/epilot/models/operations/getrelatedentitiescount.py
3636
src/epilot/models/operations/getrelations.py
3737
src/epilot/models/operations/getrelationsv2.py
38+
src/epilot/models/operations/getrelationsv3.py
3839
src/epilot/models/operations/updaterelation.py
3940
src/epilot/models/operations/createsavedview.py
4041
src/epilot/models/operations/deletesavedview.py
@@ -160,6 +161,8 @@ docs/models/operations/getrelationsrequest.md
160161
docs/models/operations/getrelationsresponse.md
161162
docs/models/operations/getrelationsv2request.md
162163
docs/models/operations/getrelationsv2response.md
164+
docs/models/operations/getrelationsv3request.md
165+
docs/models/operations/getrelationsv3response.md
163166
docs/models/operations/updaterelationrequestbody.md
164167
docs/models/operations/updaterelationrequest.md
165168
docs/models/operations/updaterelationresponse.md

‎entity/gen.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
configVersion: 1.0.0
22
management:
3-
docChecksum: 82907e4b42c145f2d0c1d69c446538c8
3+
docChecksum: 4f2bfdba964b95ce160b61f2cc75d523
44
docVersion: 1.0.0
55
speakeasyVersion: 1.104.0
66
generationVersion: 2.169.0
@@ -17,7 +17,7 @@ features:
1717
globalSecurity: 2.82.0
1818
globalServerURLs: 2.82.0
1919
python:
20-
version: 2.1.0
20+
version: 2.1.1
2121
author: epilot
2222
description: Python Client SDK for Epilot
2323
flattenGlobalSecurity: false

‎entity/setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
setuptools.setup(
1212
name="epilot-entity",
13-
version="2.1.0",
13+
version="2.1.1",
1414
author="epilot",
1515
description="Python Client SDK for Epilot",
1616
long_description=long_description,

0 commit comments

Comments
 (0)