Merge pull request #68 from epilot-dev/speakeasy-sdk-regen-1686275414

chore: speakeasy sdk regeneration - Generate Entity SDK
epilot-dev · Aug 6, 2024 · 29cf0c2 · 29cf0c2
2 parents 6e87005 + 699e092
commit 29cf0c2
Show file tree

Hide file tree

Showing 450 changed files with 12,717 additions and 2,583 deletions.
diff --git a/entity/.gitattributes b/entity/.gitattributes
@@ -0,0 +1,2 @@
+# This allows generated code to be indexed correctly
+*.py linguist-generated=false
diff --git a/entity/.gitignore b/entity/.gitignore
@@ -0,0 +1,7 @@
+.python-version
+.DS_Store
+venv/
+src/*.egg-info/
+__pycache__/
+.pytest_cache/
+.python-version`
diff --git a/entity/README.md b/entity/README.md
@@ -16,87 +16,214 @@ from epilot.models import operations, shared
 
 s = epilot.Epilot(
     security=shared.Security(
-        epilot_auth="Bearer YOUR_BEARER_TOKEN_HERE",
+        epilot_auth="",
     ),
 )
 
-
 req = operations.AttachActivityRequest(
     entities=[
-        "9bd9d8d6-9a67-44e0-b467-cc8796ed151a",
-        "05dfc2dd-f7cc-478c-a1ba-928fc816742c",
-        "b7392059-2939-46fe-a759-6eb10faaa235",
+        'ee1dee63-2954-4671-8246-751c43fec091',
     ],
-    id="01F130Q52Q6MWSNS8N2AVXV4JN",
+    id='01F130Q52Q6MWSNS8N2AVXV4JN',
 )
-    
+
 res = s.activity.attach_activity(req)
 
 if res.activity_item is not None:
     # handle response
+    pass
 ```
 <!-- End SDK Example Usage -->
 
 <!-- Start SDK Available Operations -->
-## SDK Available Operations
+## Available Resources and Operations
+
 
+### [activity](docs/sdks/activity/README.md)
 
-### activity
+* [attach_activity](docs/sdks/activity/README.md#attach_activity) - attachActivity
+* [create_activity](docs/sdks/activity/README.md#create_activity) - createActivity
+* [get_activity](docs/sdks/activity/README.md#get_activity) - getActivity
+* [get_entity_activity_feed](docs/sdks/activity/README.md#get_entity_activity_feed) - getEntityActivityFeed
 
-* `attach_activity` - attachActivity
-* `create_activity` - createActivity
-* `get_activity` - getActivity
-* `get_entity_activity_feed` - getEntityActivityFeed
+### [entities](docs/sdks/entities/README.md)
 
-### entities
+* [autocomplete](docs/sdks/entities/README.md#autocomplete) - autocomplete
+* [create_entity](docs/sdks/entities/README.md#create_entity) - createEntity
+* [delete_entity](docs/sdks/entities/README.md#delete_entity) - deleteEntity
+* [get_entity](docs/sdks/entities/README.md#get_entity) - getEntity
+* [patch_entity](docs/sdks/entities/README.md#patch_entity) - patchEntity
+* [search_entities](docs/sdks/entities/README.md#search_entities) - searchEntities
+* [update_entity](docs/sdks/entities/README.md#update_entity) - updateEntity
+* [upsert_entity](docs/sdks/entities/README.md#upsert_entity) - upsertEntity
 
-* `autocomplete` - autocomplete
-* `create_entity` - createEntity
-* `delete_entity` - deleteEntity
-* `get_entity` - getEntity
-* `patch_entity` - patchEntity
-* `search_entities` - searchEntities
-* `update_entity` - updateEntity
-* `upsert_entity` - upsertEntity
+### [entity_import](docs/sdks/entityimport/README.md)
 
-### export
+* [import_entities](docs/sdks/entityimport/README.md#import_entities) - Import Entities
 
-* `export_entities` - exportEntities
-* `import_entities` - importEntities
+### [export](docs/sdks/export/README.md)
 
-### relations
+* [export_entities](docs/sdks/export/README.md#export_entities) - exportEntities
 
-* `add_relations` - addRelations
-* `delete_relation` - deleteRelation
-* `get_relations` - getRelations
-* `get_relations_v2` - getRelationsV2
-* `update_relation` - updateRelation
+### [relations](docs/sdks/relations/README.md)
 
-### saved_views
+* [add_relations](docs/sdks/relations/README.md#add_relations) - addRelations
+* [delete_relation](docs/sdks/relations/README.md#delete_relation) - deleteRelation
+* [get_related_entities_count](docs/sdks/relations/README.md#get_related_entities_count) - getRelatedEntitiesCount
+* [get_relations](docs/sdks/relations/README.md#get_relations) - getRelations
+* [get_relations_v2](docs/sdks/relations/README.md#get_relations_v2) - getRelationsV2
+* [get_relations_v3](docs/sdks/relations/README.md#get_relations_v3) - getRelationsV3
+* [update_relation](docs/sdks/relations/README.md#update_relation) - updateRelation
 
-* `create_saved_view` - createSavedView
-* `delete_saved_view` - deleteSavedView
-* `get_saved_view` - getSavedView
-* `list_saved_views` - listSavedViews
-* `update_saved_view` - updateSavedView
+### [saved_views](docs/sdks/savedviews/README.md)
 
-### schemas
+* [create_saved_view](docs/sdks/savedviews/README.md#create_saved_view) - createSavedView
+* [delete_saved_view](docs/sdks/savedviews/README.md#delete_saved_view) - deleteSavedView
+* [get_saved_view](docs/sdks/savedviews/README.md#get_saved_view) - getSavedView
+* [list_favorite_views_for_user](docs/sdks/savedviews/README.md#list_favorite_views_for_user) - listFavoriteViewsForUser
+* [list_saved_views](docs/sdks/savedviews/README.md#list_saved_views) - listSavedViews
+* [update_saved_view](docs/sdks/savedviews/README.md#update_saved_view) - updateSavedView
 
-* `delete_schema` - deleteSchema
-* `get_schema` - getSchema
-* `get_schema_versions` - getSchemaVersions
-* `list_schema_blueprints` - listSchemaBlueprints
-* `list_schemas` - listSchemas
-* `list_taxonomy_classifications_for_schema` - listTaxonomyClassificationsForSchema
-* `put_schema` - putSchema
+### [schemas](docs/sdks/schemas/README.md)
 
-### taxonomy
+* [delete_schema](docs/sdks/schemas/README.md#delete_schema) - deleteSchema
+* [get_schema](docs/sdks/schemas/README.md#get_schema) - getSchema
+* [get_schema_versions](docs/sdks/schemas/README.md#get_schema_versions) - getSchemaVersions
+* [list_schema_blueprints](docs/sdks/schemas/README.md#list_schema_blueprints) - listSchemaBlueprints
+* [list_schemas](docs/sdks/schemas/README.md#list_schemas) - listSchemas
+* [list_taxonomy_classifications_for_schema](docs/sdks/schemas/README.md#list_taxonomy_classifications_for_schema) - listTaxonomyClassificationsForSchema
+* [put_schema](docs/sdks/schemas/README.md#put_schema) - putSchema
 
-* `get_taxonomy` - getTaxonomy
-* `list_taxonomies` - listTaxonomies
-* `taxonomies_classifications_search` - taxonomiesClassificationsSearch
-* `taxonomy_autocomplete` - taxonomyAutocomplete
-* `update_classifications_for_taxonomy` - updateClassificationsForTaxonomy
+### [taxonomy](docs/sdks/taxonomy/README.md)
+
+* [get_taxonomy](docs/sdks/taxonomy/README.md#get_taxonomy) - getTaxonomy
+* [list_taxonomies](docs/sdks/taxonomy/README.md#list_taxonomies) - listTaxonomies
+* [taxonomies_classifications_search](docs/sdks/taxonomy/README.md#taxonomies_classifications_search) - taxonomiesClassificationsSearch
+* [taxonomy_autocomplete](docs/sdks/taxonomy/README.md#taxonomy_autocomplete) - taxonomyAutocomplete
+* [update_classifications_for_taxonomy](docs/sdks/taxonomy/README.md#update_classifications_for_taxonomy) - updateClassificationsForTaxonomy
 <!-- End SDK Available Operations -->
 
+
+
+<!-- Start Dev Containers -->
+
+<!-- End Dev Containers -->
+
+
+
+<!-- Start Pagination -->
+# Pagination
+
+Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
+returned response object will have a `Next` method that can be called to pull down the next group of results. If the
+return value of `Next` is `None`, then there are no more pages to be fetched.
+
+Here's an example of one such pagination call:
+<!-- End Pagination -->
+
+
+
+<!-- Start Error Handling -->
+# Error Handling
+
+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.
+<!-- End Error Handling -->
+
+
+
+<!-- Start Server Selection -->
+# Server Selection
+
+## Select Server by Index
+
+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:
+
+| # | Server | Variables |
+| - | ------ | --------- |
+| 0 | `https://entity.sls.epilot.io` | None |
+
+For example:
+
+
+```python
+import epilot
+from epilot.models import operations, shared
+
+s = epilot.Epilot(
+    security=shared.Security(
+        epilot_auth="",
+    ),
+    server_idx=0
+)
+
+req = operations.AttachActivityRequest(
+    entities=[
+        'ee1dee63-2954-4671-8246-751c43fec091',
+    ],
+    id='01F130Q52Q6MWSNS8N2AVXV4JN',
+)
+
+res = s.activity.attach_activity(req)
+
+if res.activity_item is not None:
+    # handle response
+    pass
+```
+
+
+## Override Server URL Per-Client
+
+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:
+
+
+```python
+import epilot
+from epilot.models import operations, shared
+
+s = epilot.Epilot(
+    security=shared.Security(
+        epilot_auth="",
+    ),
+    server_url="https://entity.sls.epilot.io"
+)
+
+req = operations.AttachActivityRequest(
+    entities=[
+        'ee1dee63-2954-4671-8246-751c43fec091',
+    ],
+    id='01F130Q52Q6MWSNS8N2AVXV4JN',
+)
+
+res = s.activity.attach_activity(req)
+
+if res.activity_item is not None:
+    # handle response
+    pass
+```
+<!-- End Server Selection -->
+
+
+
+<!-- Start Custom HTTP Client -->
+# Custom HTTP Client
+
+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.
+
+
+For example, you could specify a header for every request that your sdk makes as follows:
+
+```python
+import epilot
+import requests
+
+http_client = requests.Session()
+http_client.headers.update({'x-custom-header': 'someValue'})
+s = epilot.Epilot(client: http_client)
+```
+<!-- End Custom HTTP Client -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+
+
 ### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# This allows generated code to be indexed correctly
		*.py linguist-generated=false