From 7c6bee0b6c8243b5bfa29f68efd2aebd7869fd9a Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 9 Jun 2023 01:50:36 +0000 Subject: [PATCH 01/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.2 --- entity/.gitignore | 5 + entity/README.md | 106 +- entity/RELEASES.md | 8 +- entity/USAGE.md | 15 +- entity/docs/activity/README.md | 146 +++ entity/docs/entities/README.md | 504 ++++++++ entity/docs/entityimport/README.md | 41 + entity/docs/epilot/README.md | 13 + entity/docs/export/README.md | 52 + entity/docs/relations/README.md | 196 ++++ entity/docs/savedviews/README.md | 171 +++ entity/docs/schemas/README.md | 1016 +++++++++++++++++ entity/docs/taxonomy/README.md | 213 ++++ entity/files.gen | 14 +- entity/gen.yaml | 11 +- entity/pylintrc | 13 +- entity/setup.py | 37 +- entity/src/epilot/__init__.py | 1 + entity/src/epilot/activity.py | 65 +- entity/src/epilot/entities.py | 107 +- entity/src/epilot/entity_import.py | 41 + entity/src/epilot/export.py | 58 +- .../epilot/models/operations/addrelations.py | 16 +- .../models/operations/attachactivity.py | 12 +- .../epilot/models/operations/autocomplete.py | 20 +- .../models/operations/createactivity.py | 12 +- .../epilot/models/operations/createentity.py | 16 +- .../models/operations/createsavedview.py | 8 +- .../epilot/models/operations/deleteentity.py | 12 +- .../models/operations/deleterelation.py | 16 +- .../models/operations/deletesavedview.py | 8 +- .../epilot/models/operations/deleteschema.py | 8 +- .../models/operations/exportentities.py | 14 +- .../epilot/models/operations/getactivity.py | 18 +- .../src/epilot/models/operations/getentity.py | 18 +- .../operations/getentityactivityfeed.py | 26 +- .../epilot/models/operations/getrelations.py | 16 +- .../models/operations/getrelationsv2.py | 26 +- .../epilot/models/operations/getsavedview.py | 12 +- .../src/epilot/models/operations/getschema.py | 12 +- .../models/operations/getschemaversions.py | 18 +- .../epilot/models/operations/gettaxonomy.py | 10 +- .../models/operations/importentities.py | 10 +- .../models/operations/listsavedviews.py | 10 +- .../models/operations/listschemablueprints.py | 10 +- .../epilot/models/operations/listschemas.py | 12 +- .../models/operations/listtaxonomies.py | 10 +- .../listtaxonomyclassificationsforschema.py | 18 +- .../epilot/models/operations/patchentity.py | 20 +- .../src/epilot/models/operations/putschema.py | 14 +- .../models/operations/searchentities.py | 10 +- .../taxonomiesclassificationssearch.py | 16 +- .../models/operations/taxonomyautocomplete.py | 16 +- .../updateclassificationsfortaxonomy.py | 18 +- .../epilot/models/operations/updateentity.py | 18 +- .../models/operations/updaterelation.py | 22 +- .../models/operations/updatesavedview.py | 12 +- .../epilot/models/operations/upsertentity.py | 22 +- entity/src/epilot/models/shared/__init__.py | 2 +- entity/src/epilot/models/shared/activity.py | 8 +- .../src/epilot/models/shared/activityitem.py | 18 +- .../models/shared/addressrelationattribute.py | 83 +- .../models/shared/automationattribute.py | 81 +- .../epilot/models/shared/booleanattribute.py | 81 +- .../models/shared/classificationsupdate.py | 6 +- .../epilot/models/shared/computedattribute.py | 81 +- .../epilot/models/shared/consentattribute.py | 85 +- .../epilot/models/shared/countryattribute.py | 81 +- .../epilot/models/shared/currencyattribute.py | 93 +- .../src/epilot/models/shared/dateattribute.py | 83 +- .../epilot/models/shared/entitycapability.py | 16 +- .../models/shared/entitydefaultcreate.py | 14 +- .../epilot/models/shared/entitydefaultedit.py | 14 +- .../models/shared/entitydefaulttable.py | 50 +- .../models/shared/entityimportparams.py | 14 +- .../epilot/models/shared/entityoperation.py | 32 +- .../src/epilot/models/shared/entityschema.py | 81 +- .../epilot/models/shared/entityschemaitem.py | 95 +- .../models/shared/entitysearchparams.py | 18 +- .../models/shared/entitysearchresults.py | 6 +- .../models/shared/entityviewdisabled.py | 6 +- .../src/epilot/models/shared/fileattribute.py | 100 +- .../epilot/models/shared/getrelationsresp.py | 8 +- .../shared/getrelationsrespwithpagination.py | 4 +- .../epilot/models/shared/internalattribute.py | 81 +- .../models/shared/internaluserattribute.py | 81 +- .../models/shared/invitationemailattribute.py | 81 +- .../src/epilot/models/shared/linkattribute.py | 81 +- .../models/shared/multiselectattribute.py | 95 +- .../epilot/models/shared/numberattribute.py | 83 +- .../models/shared/orderedlistattribute.py | 81 +- .../models/shared/partnerstatusattribute.py | 81 +- .../shared/paymentmethodrelationattribute.py | 83 +- .../epilot/models/shared/purposeattribute.py | 89 +- .../models/shared/redirectentityview.py | 8 +- .../epilot/models/shared/relationattribute.py | 158 +-- .../src/epilot/models/shared/relationitem.py | 8 +- .../models/shared/repeatableattribute.py | 111 +- entity/src/epilot/models/shared/savedview.py | 14 +- .../src/epilot/models/shared/savedviewitem.py | 20 +- .../epilot/models/shared/searchmappings.py | 26 +- entity/src/epilot/models/shared/security.py | 4 +- .../epilot/models/shared/selectattribute.py | 91 +- .../epilot/models/shared/sequenceattribute.py | 85 +- .../epilot/models/shared/statusattribute.py | 87 +- .../epilot/models/shared/summaryattribute.py | 16 +- .../src/epilot/models/shared/summaryfield.py | 4 +- .../src/epilot/models/shared/tagsattribute.py | 85 +- entity/src/epilot/models/shared/taxonomy.py | 10 +- .../models/shared/taxonomyclassification.py | 10 +- .../src/epilot/models/shared/textattribute.py | 83 +- .../models/shared/userrelationattribute.py | 83 +- entity/src/epilot/relations.py | 75 +- entity/src/epilot/saved_views.py | 77 +- entity/src/epilot/schemas.py | 103 +- entity/src/epilot/sdk.py | 110 +- entity/src/epilot/sdkconfiguration.py | 29 + entity/src/epilot/taxonomy.py | 75 +- entity/src/epilot/utils/utils.py | 192 ++-- 119 files changed, 4966 insertions(+), 1963 deletions(-) create mode 100755 entity/.gitignore create mode 100755 entity/docs/activity/README.md create mode 100755 entity/docs/entities/README.md create mode 100755 entity/docs/entityimport/README.md create mode 100755 entity/docs/epilot/README.md create mode 100755 entity/docs/export/README.md create mode 100755 entity/docs/relations/README.md create mode 100755 entity/docs/savedviews/README.md create mode 100755 entity/docs/schemas/README.md create mode 100755 entity/docs/taxonomy/README.md create mode 100755 entity/src/epilot/entity_import.py create mode 100755 entity/src/epilot/sdkconfiguration.py diff --git a/entity/.gitignore b/entity/.gitignore new file mode 100755 index 000000000..9072ad43b --- /dev/null +++ b/entity/.gitignore @@ -0,0 +1,5 @@ +venv/ +src/*.egg-info/ +__pycache__/ +.pytest_cache/ +.python-version` \ No newline at end of file diff --git a/entity/README.md b/entity/README.md index 9ae90f288..7e67227b7 100755 --- a/entity/README.md +++ b/entity/README.md @@ -12,24 +12,23 @@ pip install git+https://github.com/epilot-dev/sdk-python.git#subdirectory=entity ```python import epilot -from epilot.models import operations, shared +from epilot.models import operations 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", + '9bd9d8d6-9a67-44e0-b467-cc8796ed151a', + '05dfc2dd-f7cc-478c-a1ba-928fc816742c', + 'b7392059-2939-46fe-a759-6eb10faaa235', ], - id="01F130Q52Q6MWSNS8N2AVXV4JN", + id='01F130Q52Q6MWSNS8N2AVXV4JN', ) - + res = s.activity.attach_activity(req) if res.activity_item is not None: @@ -38,65 +37,68 @@ if res.activity_item is not None: -## SDK Available Operations +## Available Resources and Operations + + +### [activity](docs/activity/README.md) +* [attach_activity](docs/activity/README.md#attach_activity) - attachActivity +* [create_activity](docs/activity/README.md#create_activity) - createActivity +* [get_activity](docs/activity/README.md#get_activity) - getActivity +* [get_entity_activity_feed](docs/activity/README.md#get_entity_activity_feed) - getEntityActivityFeed -### activity +### [entities](docs/entities/README.md) -* `attach_activity` - attachActivity -* `create_activity` - createActivity -* `get_activity` - getActivity -* `get_entity_activity_feed` - getEntityActivityFeed +* [autocomplete](docs/entities/README.md#autocomplete) - autocomplete +* [create_entity](docs/entities/README.md#create_entity) - createEntity +* [delete_entity](docs/entities/README.md#delete_entity) - deleteEntity +* [get_entity](docs/entities/README.md#get_entity) - getEntity +* [patch_entity](docs/entities/README.md#patch_entity) - patchEntity +* [search_entities](docs/entities/README.md#search_entities) - searchEntities +* [update_entity](docs/entities/README.md#update_entity) - updateEntity +* [upsert_entity](docs/entities/README.md#upsert_entity) - upsertEntity -### entities +### [entity_import](docs/entityimport/README.md) -* `autocomplete` - autocomplete -* `create_entity` - createEntity -* `delete_entity` - deleteEntity -* `get_entity` - getEntity -* `patch_entity` - patchEntity -* `search_entities` - searchEntities -* `update_entity` - updateEntity -* `upsert_entity` - upsertEntity +* [import_entities](docs/entityimport/README.md#import_entities) - Import Entities -### export +### [export](docs/export/README.md) -* `export_entities` - exportEntities -* `import_entities` - importEntities +* [export_entities](docs/export/README.md#export_entities) - exportEntities -### relations +### [relations](docs/relations/README.md) -* `add_relations` - addRelations -* `delete_relation` - deleteRelation -* `get_relations` - getRelations -* `get_relations_v2` - getRelationsV2 -* `update_relation` - updateRelation +* [add_relations](docs/relations/README.md#add_relations) - addRelations +* [delete_relation](docs/relations/README.md#delete_relation) - deleteRelation +* [get_relations](docs/relations/README.md#get_relations) - getRelations +* [get_relations_v2](docs/relations/README.md#get_relations_v2) - getRelationsV2 +* [update_relation](docs/relations/README.md#update_relation) - updateRelation -### saved_views +### [saved_views](docs/savedviews/README.md) -* `create_saved_view` - createSavedView -* `delete_saved_view` - deleteSavedView -* `get_saved_view` - getSavedView -* `list_saved_views` - listSavedViews -* `update_saved_view` - updateSavedView +* [create_saved_view](docs/savedviews/README.md#create_saved_view) - createSavedView +* [delete_saved_view](docs/savedviews/README.md#delete_saved_view) - deleteSavedView +* [get_saved_view](docs/savedviews/README.md#get_saved_view) - getSavedView +* [list_saved_views](docs/savedviews/README.md#list_saved_views) - listSavedViews +* [update_saved_view](docs/savedviews/README.md#update_saved_view) - updateSavedView -### schemas +### [schemas](docs/schemas/README.md) -* `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 +* [delete_schema](docs/schemas/README.md#delete_schema) - deleteSchema +* [get_schema](docs/schemas/README.md#get_schema) - getSchema +* [get_schema_versions](docs/schemas/README.md#get_schema_versions) - getSchemaVersions +* [list_schema_blueprints](docs/schemas/README.md#list_schema_blueprints) - listSchemaBlueprints +* [list_schemas](docs/schemas/README.md#list_schemas) - listSchemas +* [list_taxonomy_classifications_for_schema](docs/schemas/README.md#list_taxonomy_classifications_for_schema) - listTaxonomyClassificationsForSchema +* [put_schema](docs/schemas/README.md#put_schema) - putSchema -### taxonomy +### [taxonomy](docs/taxonomy/README.md) -* `get_taxonomy` - getTaxonomy -* `list_taxonomies` - listTaxonomies -* `taxonomies_classifications_search` - taxonomiesClassificationsSearch -* `taxonomy_autocomplete` - taxonomyAutocomplete -* `update_classifications_for_taxonomy` - updateClassificationsForTaxonomy +* [get_taxonomy](docs/taxonomy/README.md#get_taxonomy) - getTaxonomy +* [list_taxonomies](docs/taxonomy/README.md#list_taxonomies) - listTaxonomies +* [taxonomies_classifications_search](docs/taxonomy/README.md#taxonomies_classifications_search) - taxonomiesClassificationsSearch +* [taxonomy_autocomplete](docs/taxonomy/README.md#taxonomy_autocomplete) - taxonomyAutocomplete +* [update_classifications_for_taxonomy](docs/taxonomy/README.md#update_classifications_for_taxonomy) - updateClassificationsForTaxonomy ### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 12414e257..e9aab3607 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -34,4 +34,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.19.2 (2.16.5) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.19.2 (2.16.5) https://github.com/speakeasy-api/speakeasy + +## 2023-06-09 01:50:11 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.45.2 (2.37.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/USAGE.md b/entity/USAGE.md index 7de411ee1..e2b02a3b0 100755 --- a/entity/USAGE.md +++ b/entity/USAGE.md @@ -1,24 +1,23 @@ ```python import epilot -from epilot.models import operations, shared +from epilot.models import operations 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", + '9bd9d8d6-9a67-44e0-b467-cc8796ed151a', + '05dfc2dd-f7cc-478c-a1ba-928fc816742c', + 'b7392059-2939-46fe-a759-6eb10faaa235', ], - id="01F130Q52Q6MWSNS8N2AVXV4JN", + id='01F130Q52Q6MWSNS8N2AVXV4JN', ) - + res = s.activity.attach_activity(req) if res.activity_item is not None: diff --git a/entity/docs/activity/README.md b/entity/docs/activity/README.md new file mode 100755 index 000000000..1d45f2759 --- /dev/null +++ b/entity/docs/activity/README.md @@ -0,0 +1,146 @@ +# activity + +## Overview + +Entity Events + +### Available Operations + +* [attach_activity](#attach_activity) - attachActivity +* [create_activity](#create_activity) - createActivity +* [get_activity](#get_activity) - getActivity +* [get_entity_activity_feed](#get_entity_activity_feed) - getEntityActivityFeed + +## attach_activity + +Attach existing activity to entity activity feeds + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.AttachActivityRequest( + entities=[ + 'c5955907-aff1-4a3a-afa9-467739251aa5', + ], + id='01F130Q52Q6MWSNS8N2AVXV4JN', +) + +res = s.activity.attach_activity(req) + +if res.activity_item is not None: + # handle response +``` + +## create_activity + +Create an activity that can be displayed in activity feeds. + +- All activites are published as events on the event bus +- Entity mutations are always part of an activity + + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.CreateActivityRequest( + activity=shared.Activity( + message='{{caller}} did something with {{entity payload.entity.id}}.', + payload={ + "quo": 'sequi', + }, + title='My custom activity', + type='MyCustomActivity', + ), + entities=[ + '5ad019da-1ffe-478f-897b-0074f15471b5', + 'e6e13b99-d488-4e1e-91e4-50ad2abd4426', + '9802d502-a94b-4b4f-a3c9-69e9a3efa77d', + 'fb14cd66-ae39-45ef-b9ba-88f3a6699707', + ], +) + +res = s.activity.create_activity(req) + +if res.activity_item is not None: + # handle response +``` + +## get_activity + +Get activity by id + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetActivityRequest( + id='01F130Q52Q6MWSNS8N2AVXV4JN', + operations_from=301575, + operations_size=716075, +) + +res = s.activity.get_activity(req) + +if res.activity_item is not None: + # handle response +``` + +## get_entity_activity_feed + +Get activity feed for an entity + + +### Example Usage + +```python +import epilot +import dateutil.parser +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetEntityActivityFeedRequest( + after=dateutil.parser.isoparse('2022-06-04T18:23:50.695Z'), + before=dateutil.parser.isoparse('2022-08-14T00:52:14.624Z'), + from_=618016, + id='b6e21419-5989-40af-a563-e2516fe4c8b7', + size=100226, + slug='contact', + type='SyncActivity', +) + +res = s.activity.get_entity_activity_feed(req) + +if res.get_entity_activity_feed_200_application_json_object is not None: + # handle response +``` diff --git a/entity/docs/entities/README.md b/entity/docs/entities/README.md new file mode 100755 index 000000000..468002d37 --- /dev/null +++ b/entity/docs/entities/README.md @@ -0,0 +1,504 @@ +# entities + +## Overview + +CRUD Access for Entities + +### Available Operations + +* [autocomplete](#autocomplete) - autocomplete +* [create_entity](#create_entity) - createEntity +* [delete_entity](#delete_entity) - deleteEntity +* [get_entity](#get_entity) - getEntity +* [patch_entity](#patch_entity) - patchEntity +* [search_entities](#search_entities) - searchEntities +* [update_entity](#update_entity) - updateEntity +* [upsert_entity](#upsert_entity) - upsertEntity + +## autocomplete + +Autocomplete entity attributes + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.AutocompleteRequest( + attribute='_tags', + input='architecto', + size=919483, + slug='contact', +) + +res = s.entities.autocomplete(req) + +if res.autocomplete_200_application_json_object is not None: + # handle response +``` + +## create_entity + +Creates a new entity using a key. + +## Activity + +If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityCreated` + +## Relations + +To create a relation, store a property object that defines a `$relation` array. + +Example: + +```json +{ + "contacts": { + "$relation": [ + { "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } + ] + } +} +``` + +The items in `$relation` support two properties: +- `entity_id` - The ID of the entity to link +- `_tags` - Tags or labels for the relation (optional) + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.CreateEntityRequest( + request_body={ + "expedita": 'nihil', + "repellat": 'quibusdam', + }, + activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', + async_=False, + slug='contact', +) + +res = s.entities.create_entity(req) + +if res.entity_item is not None: + # handle response +``` + +## delete_entity + +Deletes an Entity + +## Activity + +If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityDeleted` + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.DeleteEntityRequest( + activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', + id='2ed02892-1cdd-4c69-a601-fb576b0d5f0d', + slug='contact', +) + +res = s.entities.delete_entity(req) + +if res.status_code == 200: + # handle response +``` + +## get_entity + +Gets Entity and relations by id. + +## Relations + +When `hydrate=true`, relation attributes are replaced in-place with nested entity values. + +Example: +```json +{ + "_id": "123", + "name": "parent", + "_tags": ["parent"], + "contacts": { + "$relation": [ + { "entity_id": "456", "_tags": ["primary"] }, + { "entity_id": "789", "_tags": ["secondary"] }, + ] + }, + "addresses": { + "$relation_ref": [ + { "entity_id": "123", "_tags": ["primary"], "path": "address.0" }, + { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" }, + ] + } +} +``` + +Becomes: +```json +{ + "_id": "123", + "name": "parent", + "_tags": ["parent"], + "contacts": [ + { + "$relation": { "entity_id": "456", "_tags": ["primary"] }, + "_id": "456", + "name": "child 1", + "_tags": ["child"] + }, + { + "$relation": { "entity_id": "789", "_tags": ["secondary"] }, + "_id": "789", + "name": "child 2", + "_tags": ["child"] + } + ], + "addresses": [ + { + "$relation_ref": { "entity_id": "123", "_tags": ["primary"], "path": "address.0" }, + "_id": "123", + "address": "address 1", + "_tags": ["child"] + }, + { + "$relation_ref": { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" }, + "_id": "234", + "address": "address 2", + "_tags": ["child"] + } + ] +} +``` + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetEntityRequest( + hydrate=False, + id='30c5fbb2-5870-4532-82c7-3d5fe9b90c28', + slug='contact', +) + +res = s.entities.get_entity(req) + +if res.get_entity_200_application_json_object is not None: + # handle response +``` + +## patch_entity + +Partially updates an entity with the passed in entity data. + +- If an _updated_at is passed and the server contains a newer version of the entity a `409` Error is returned + +## Activity + +If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityUpdated` + +## Relations + +To create a relation, store a property that defines a `$relation` array. + +Example: + +```json +{ + "contacts": { + "$relation": [ + { "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } + ] + } +} +``` + +The items in `$relation` support two properties: +- `entity_id` - The ID of the entity to link +- `_tags` - Tags or labels for the relation (optional) + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.PatchEntityRequest( + request_body={ + "eaque": 'occaecati', + "rerum": 'adipisci', + "asperiores": 'earum', + }, + activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', + async_=False, + dry_run=False, + id='49a8d9cb-f486-4333-a3f9-b77f3a410067', + slug='contact', +) + +res = s.entities.patch_entity(req) + +if res.entity_item is not None: + # handle response +``` + +## search_entities + +Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying. + +Passing comma-separated `x-epilot-org-id` is supported for cross-org entity search. + +## Relations + +When `hydrate=true`, relation attributes are replaced in-place with nested entity values. + +Example: +```json +{ + "_id": "123", + "name": "parent", + "_tags": ["parent"], + "contacts": { + "$relation": [ + { "entity_id": "456", "_tags": ["primary"] }, + { "entity_id": "789", "_tags": ["secondary"] }, + ] + }, + "addresses": { + "$relation_ref": [ + { "entity_id": "123", "_tags": ["primary"], "path": "address.0" }, + { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" }, + ] + } +} +``` + +Becomes: +```json +{ + "_id": "123", + "name": "parent", + "_tags": ["parent"], + "contacts": [ + { + "$relation": { "entity_id": "456", "_tags": ["primary"] }, + "_id": "456", + "name": "child 1", + "_tags": ["child"] + }, + { + "$relation": { "entity_id": "789", "_tags": ["secondary"] }, + "_id": "789", + "name": "child 2", + "_tags": ["child"] + } + ], + "addresses": [ + { + "$relation_ref": { "entity_id": "123", "_tags": ["primary"], "path": "address.0" }, + "_id": "123", + "address": "address 1", + "_tags": ["child"] + }, + { + "$relation_ref": { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" }, + "_id": "234", + "address": "address 2", + "_tags": ["child"] + } + ] +} +``` + + +### Example Usage + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = shared.EntitySearchParams( + aggs={ + "accusamus": 'quidem', + "voluptatibus": 'voluptas', + }, + fields_=[ + 'eos', + 'atque', + 'sit', + ], + from_=854614, + hydrate=False, + include_scores=False, + q='_schema:contact AND status:active', + size=67249, + sort='_created_at:desc', +) + +res = s.entities.search_entities(req) + +if res.entity_search_results is not None: + # handle response +``` + +## update_entity + +Updates an Entity + +## Activity + +If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityUpdated` + +## Relations + +To create a relation, store a property that defines a `$relation` array. + +Example: + +```json +{ + "contacts": { + "$relation": [ + { "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } + ] + } +} +``` + +The items in `$relation` support two properties: +- `entity_id` - The ID of the entity to link +- `_tags` - Tags or labels for the relation (optional) + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.UpdateEntityRequest( + request_body={ + "dolorum": 'iusto', + "voluptate": 'dolorum', + "deleniti": 'omnis', + }, + activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', + async_=False, + id='ebf737ae-4203-4ce5-a6a9-5d8a0d446ce2', + slug='contact', +) + +res = s.entities.update_entity(req) + +if res.entity_item is not None: + # handle response +``` + +## upsert_entity + +Create or update an entity using `unique_key` + +- If no entities are matched, a new entity is created. +- If exactly one entity is matched, a `PATCH`-style update is applied to the existing entity. +- If more than one entity is matched a `409` Error is returned + +## Activity + +If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityCreated` or `EntityUpdated` + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.UpsertEntityRequest( + request_body=operations.UpsertEntityRequestBody( + entity={ + "a": 'esse', + "harum": 'iusto', + "ipsum": 'quisquam', + }, + unique_key=[ + 'email.0.email', + 'email.0.email', + 'email.0.email', + 'email.0.email', + ], + ), + activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', + async_=False, + dry_run=False, + slug='contact', +) + +res = s.entities.upsert_entity(req) + +if res.entity_item is not None: + # handle response +``` diff --git a/entity/docs/entityimport/README.md b/entity/docs/entityimport/README.md new file mode 100755 index 000000000..067f8ae66 --- /dev/null +++ b/entity/docs/entityimport/README.md @@ -0,0 +1,41 @@ +# entity_import + +### Available Operations + +* [import_entities](#import_entities) - Import Entities + +## import_entities + +This endpoint enables the import of entities into the platform. +The entities should be provided in a CSV format inside an S3 bucket. +This API will return the `job_id`` which can be used to fetch the status of the import process. + + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.ImportEntitiesRequest( + entity_import_params=shared.EntityImportParams( + s3_reference=shared.EntityImportParamsS3Reference( + bucket='my-bucket', + key='imports/my-import.json', + ), + schema='contact', + ), + job_id='abc123', +) + +res = s.entity_import.import_entities(req) + +if res.status_code == 200: + # handle response +``` diff --git a/entity/docs/epilot/README.md b/entity/docs/epilot/README.md new file mode 100755 index 000000000..67abac3cc --- /dev/null +++ b/entity/docs/epilot/README.md @@ -0,0 +1,13 @@ +# Epilot SDK + +## Overview + +Entity API: Flexible data layer for epilot Entities. + +Use this API configure and access your business objects like Contacts, Opportunities and Products. + +[Feature Documentation](https://docs.epilot.io/docs/entities/flexible-entities) + + +### Available Operations + diff --git a/entity/docs/export/README.md b/entity/docs/export/README.md new file mode 100755 index 000000000..1643205ea --- /dev/null +++ b/entity/docs/export/README.md @@ -0,0 +1,52 @@ +# export + +## Overview + +Export and Import entities via files + +### Available Operations + +* [export_entities](#export_entities) - exportEntities + +## export_entities + +create export file of entities + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.ExportEntitiesRequest( + entity_search_params=shared.EntitySearchParams( + aggs={ + "tempore": 'accusamus', + }, + fields_=[ + 'enim', + 'dolorem', + ], + from_=957451, + hydrate=False, + include_scores=False, + q='_schema:contact AND status:active', + size=518201, + sort='_created_at:desc', + ), + is_template=False, + job_id='abc123', + language='nihil', +) + +res = s.export.export_entities(req) + +if res.status_code == 200: + # handle response +``` diff --git a/entity/docs/relations/README.md b/entity/docs/relations/README.md new file mode 100755 index 000000000..6057713b0 --- /dev/null +++ b/entity/docs/relations/README.md @@ -0,0 +1,196 @@ +# relations + +## Overview + +Entity Relationships + +### Available Operations + +* [add_relations](#add_relations) - addRelations +* [delete_relation](#delete_relation) - deleteRelation +* [get_relations](#get_relations) - getRelations +* [get_relations_v2](#get_relations_v2) - getRelationsV2 +* [update_relation](#update_relation) - updateRelation + +## add_relations + +Relates one or more entities to parent entity by adding items to a relation attribute + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.AddRelationsRequest( + request_body=[ + shared.RelationItem( + tags=[ + 'neque', + 'sed', + 'vel', + ], + attribute='libero', + entity_id='5a73429c-db1a-4842-abb6-79d2322715bf', + reverse=False, + ), + ], + async_=False, + id='0cbb1e31-b8b9-40f3-843a-1108e0adcf4b', + slug='contact', +) + +res = s.relations.add_relations(req) + +if res.relation_item is not None: + # handle response +``` + +## delete_relation + +Removes relation between two entities + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.DeleteRelationRequest( + async_=False, + attribute='cupiditate', + entity_id='qui', + id='1879fce9-53f7-43ef-bfbc-7abd74dd39c0', + slug='contact', +) + +res = s.relations.delete_relation(req) + +if res.status_code == 200: + # handle response +``` + +## get_relations + +Returns 1st level direct relations for an entity. + +You can control whether to return the full entity or just the relation item with the `?hydrate` query param. + +Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetRelationsRequest( + hydrate=False, + id='f5d2cff7-c70a-4456-a6d4-36813f16d9f5', + include_reverse=False, + slug='contact', +) + +res = s.relations.get_relations(req) + +if res.get_relations_resp is not None: + # handle response +``` + +## get_relations_v2 + +Returns 1st level direct relations for an entity with pagination. + +You can control whether to return the full entity or just the relation item with the `?hydrate` query param. + +Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetRelationsV2Request( + fields_=[ + 'quisquam', + 'saepe', + 'ea', + 'impedit', + ], + from_=359271, + hydrate=False, + id='56146c3e-250f-4b00-8c42-e141aac366c8', + include_reverse=False, + query='assumenda', + size=860552, + slug='contact', +) + +res = s.relations.get_relations_v2(req) + +if res.get_relations_resp_with_pagination is not None: + # handle response +``` + +## update_relation + +Updates an existing relation between two entities. + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.UpdateRelationRequest( + request_body=operations.UpdateRelationRequestBody( + tags=[ + 'libero', + 'quasi', + ], + ), + async_=False, + attribute='tempora', + entity_id='numquam', + id='29074747-78a7-4bd4-a6d2-8c10ab3cdca4', + slug='contact', +) + +res = s.relations.update_relation(req) + +if res.relation_item is not None: + # handle response +``` diff --git a/entity/docs/savedviews/README.md b/entity/docs/savedviews/README.md new file mode 100755 index 000000000..d3cf90ee7 --- /dev/null +++ b/entity/docs/savedviews/README.md @@ -0,0 +1,171 @@ +# saved_views + +## Overview + +Saved Views for Entities + +### Available Operations + +* [create_saved_view](#create_saved_view) - createSavedView +* [delete_saved_view](#delete_saved_view) - deleteSavedView +* [get_saved_view](#get_saved_view) - getSavedView +* [list_saved_views](#list_saved_views) - listSavedViews +* [update_saved_view](#update_saved_view) - updateSavedView + +## create_saved_view + +Creates a new saved view + +### Example Usage + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = shared.SavedView( + created_by=shared.SavedViewCreatedBy1( + user_id='10598', + ), + name='View listing German', + org='66', + shared=True, + slug=[ + 'contact', + 'contact', + ], + ui_config={ + "cupiditate": 'consequatur', + }, +) + +res = s.saved_views.create_saved_view(req) + +if res.saved_view_item is not None: + # handle response +``` + +## delete_saved_view + +Deletes a saved view + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.DeleteSavedViewRequest( + id='4e523c7e-0bc7-4178-a479-6f2a70c68828', +) + +res = s.saved_views.delete_saved_view(req) + +if res.status_code == 200: + # handle response +``` + +## get_saved_view + +Gets Saved View configuration by id. + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetSavedViewRequest( + id='2aa48256-2f22-42e9-817e-e17cbe61e6b7', +) + +res = s.saved_views.get_saved_view(req) + +if res.get_saved_view_200_application_json_object is not None: + # handle response +``` + +## list_saved_views + +Get the Saved Views based on the schema + +### Example Usage + +```python +import epilot + + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.saved_views.list_saved_views() + +if res.list_saved_views_200_application_json_object is not None: + # handle response +``` + +## update_saved_view + +Updates a saved view + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.UpdateSavedViewRequest( + saved_view=shared.SavedView( + created_by={ + "minima": 'distinctio', + "eligendi": 'sit', + "culpa": 'tempore', + }, + name='View listing German', + org='66', + shared=True, + slug=[ + 'contact', + ], + ui_config={ + "consequuntur": 'consequatur', + "minus": 'quaerat', + "sapiente": 'consectetur', + "esse": 'blanditiis', + }, + ), + id='9fd871f9-9dd2-4efd-921a-a6f1e674bdb0', +) + +res = s.saved_views.update_saved_view(req) + +if res.saved_view_item is not None: + # handle response +``` diff --git a/entity/docs/schemas/README.md b/entity/docs/schemas/README.md new file mode 100755 index 000000000..c9627d945 --- /dev/null +++ b/entity/docs/schemas/README.md @@ -0,0 +1,1016 @@ +# schemas + +## Overview + +Model Entities + +### Available Operations + +* [delete_schema](#delete_schema) - deleteSchema +* [get_schema](#get_schema) - getSchema +* [get_schema_versions](#get_schema_versions) - getSchemaVersions +* [list_schema_blueprints](#list_schema_blueprints) - listSchemaBlueprints +* [list_schemas](#list_schemas) - listSchemas +* [list_taxonomy_classifications_for_schema](#list_taxonomy_classifications_for_schema) - listTaxonomyClassificationsForSchema +* [put_schema](#put_schema) - putSchema + +## delete_schema + +Delete a schema, or a specific version of a schema + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.DeleteSchemaRequest( + slug='contact', +) + +res = s.schemas.delete_schema(req) + +if res.status_code == 200: + # handle response +``` + +## get_schema + +By default gets the latest version of the Schema and to get the specific version of schema pass the id. + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetSchemaRequest( + id='4f157560-82d6-48ea-99f1-d17051339d08', + slug='contact', +) + +res = s.schemas.get_schema(req) + +if res.entity_schema_item is not None: + # handle response +``` + +## get_schema_versions + +Get all versions of this schema ordered by the latest versions including drafts. + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetSchemaVersionsRequest( + drafts_from=156.06, + drafts_size=5130.75, + slug='contact', + versions_from=4287.96, + versions_size=6498.32, +) + +res = s.schemas.get_schema_versions(req) + +if res.get_schema_versions_200_application_json_object is not None: + # handle response +``` + +## list_schema_blueprints + +List canonical versions of all available schemas + +### Example Usage + +```python +import epilot + + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.schemas.list_schema_blueprints() + +if res.list_schema_blueprints_200_application_json_object is not None: + # handle response +``` + +## list_schemas + +Get the latest versions of all schemas + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.ListSchemasRequest( + unpublished=False, +) + +res = s.schemas.list_schemas(req) + +if res.list_schemas_200_application_json_object is not None: + # handle response +``` + +## list_taxonomy_classifications_for_schema + +List taxonomy classifications for a given schema + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.ListTaxonomyClassificationsForSchemaRequest( + query='ab', + size=5445.91, + slug='contact', + taxonomy_slug='purpose', +) + +res = s.schemas.list_taxonomy_classifications_for_schema(req) + +if res.list_taxonomy_classifications_for_schema_200_application_json_object is not None: + # handle response +``` + +## put_schema + +Create or update a schema with a new version + +### Example Usage + +```python +import epilot +import dateutil.parser +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.PutSchemaRequest( + entity_schema=shared.EntitySchema( + attributes=[ + shared.TextAttribute( + purpose=[ + '94c26071-f93f-45f0-a42d-ac7af515cc41', + ], + constraints={ + "fuga": 'id', + }, + default_value='suscipit', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='velit', + hidden=False, + hide_label=False, + icon='culpa', + info_helpers=shared.TextAttributeInfoHelpers( + hint_custom_component='est', + hint_text='recusandae', + hint_text_key='totam', + hint_tooltip_placement='top', + ), + label='fugiat', + layout='full_width', + multiline=False, + name='Dora Luettgen', + order=0, + placeholder='possimus', + preview_value_formatter='facilis', + protected=False, + readonly=False, + render_condition='cum', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.TextAttributeType.STRING, + value_formatter='commodi', + ), + shared.PaymentMethodRelationAttribute( + purpose=[ + 'fd5e60b3-75ed-44f6-bbee-41f33317fe35', + 'b60eb1ea-4265-455b-a3c2-8744ed53b88f', + ], + constraints={ + "culpa": 'corrupti', + }, + default_value='pariatur', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='totam', + has_primary=False, + hidden=False, + hide_label=False, + icon='hic', + info_helpers=shared.PaymentMethodRelationAttributeInfoHelpers( + hint_custom_component='exercitationem', + hint_text='nobis', + hint_text_key='sit', + hint_tooltip_placement='top', + ), + label='rerum', + layout='full_width', + name='Faith Cole', + order=0, + placeholder='voluptate', + preview_value_formatter='expedita', + protected=False, + readonly=False, + render_condition='ab', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.PaymentMethodRelationAttributeType.RELATION_PAYMENT_METHOD, + value_formatter='iste', + ), + ], + blueprint='4a276b26-916f-4e1f-88f4-294e3698f447', + capabilities=[ + shared.EntityCapability( + purpose=[ + '03e8b445-e80c-4a55-afd2-0e457e1858b6', + 'a89fbe3a-5aa8-4e48-a4d0-ab4075088e51', + ], + attributes=[ + shared.UserRelationAttribute( + purpose=[ + '065e904f-3b11-494b-8abf-603a79f9dfe0', + ], + constraints={ + "quidem": 'reprehenderit', + "facere": 'fuga', + "praesentium": 'mollitia', + }, + default_value='veniam', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='voluptatem', + hidden=False, + hide_label=False, + icon='quisquam', + info_helpers=shared.UserRelationAttributeInfoHelpers( + hint_custom_component='repudiandae', + hint_text='quasi', + hint_text_key='atque', + hint_tooltip_placement='top', + ), + label='reprehenderit', + layout='full_width', + multiple=False, + name='Jimmie Hoppe', + order=0, + placeholder='et', + preview_value_formatter='esse', + protected=False, + readonly=False, + render_condition='amet', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.UserRelationAttributeType.RELATION_USER, + value_formatter='assumenda', + ), + shared.AddressRelationAttribute( + purpose=[ + '9eee9526-f8d9-486e-881e-ad4f0e101256', + '3f94e29e-973e-4922-a57a-15be3e060807', + 'e2b6e3ab-8845-4f05-97a6-0ff2a54a31e9', + ], + constraints={ + "molestiae": 'ex', + "ut": 'culpa', + }, + default_value='adipisci', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='debitis', + has_primary=False, + hidden=False, + hide_label=False, + icon='laudantium', + info_helpers=shared.AddressRelationAttributeInfoHelpers( + hint_custom_component='eum', + hint_text='nemo', + hint_text_key='recusandae', + hint_tooltip_placement='top', + ), + label='esse', + layout='full_width', + name='Alvin Kemmer', + order=0, + placeholder='aspernatur', + preview_value_formatter='ullam', + protected=False, + readonly=False, + render_condition='quasi', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.AddressRelationAttributeType.RELATION_ADDRESS, + value_formatter='animi', + ), + shared.RelationAttribute( + purpose=[ + '9da660ff-57bf-4aad-8f9e-fc1b4512c103', + '2648dc2f-6151-499e-bfd0-e9fe6c632ca3', + 'aed01179-9631-42fd-a047-71778ff61d01', + ], + actions=[ + shared.RelationAttributeActions( + action_type=shared.RelationAttributeActionsActionType.ADD_EXISTING, + default=False, + feature_flag='esse', + label='ex', + new_entity_item={ + "aliquid": 'ipsa', + }, + setting_flag='laborum', + ), + shared.RelationAttributeActions( + action_type=shared.RelationAttributeActionsActionType.ADD_EXISTING, + default=False, + feature_flag='nostrum', + label='fugiat', + new_entity_item={ + "aliquid": 'officia', + "suscipit": 'aliquid', + "perferendis": 'eum', + }, + setting_flag='voluptas', + ), + ], + add_button_label='iste', + allowed_schemas=[ + 'contact', + 'contact', + 'contact', + ], + constraints={ + "error": 'possimus', + }, + default_value='voluptates', + deprecated=False, + details_view_mode_enabled=False, + drawer_size=shared.RelationAttributeDrawerSize.MEDIUM, + edit_mode=shared.RelationAttributeEditMode.LIST_VIEW, + enable_relation_picker=False, + enable_relation_tags=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='laborum', + has_primary=False, + hidden=False, + hide_label=False, + icon='libero', + info_helpers=shared.RelationAttributeInfoHelpers( + hint_custom_component='ad', + hint_text='deleniti', + hint_text_key='enim', + hint_tooltip_placement='top', + ), + label='vitae', + layout='full_width', + name='Ruben Ryan', + order=0, + placeholder='ad', + preview_value_formatter='expedita', + protected=False, + readonly=False, + relation_affinity_mode=shared.RelationAttributeRelationAffinityMode.WEAK, + relation_type=shared.RelationAttributeRelationType.HAS_ONE, + render_condition='cum', + required=False, + reverse_attributes={ + "beatae": 'contact.account', + "voluptatum": 'contact.account', + }, + search_placeholder='omnis', + setting_flag='MY_SETTING', + show_in_table=False, + summary_fields=[ + shared.SummaryField( + display_as='est', + field='culpa', + ), + ], + type=shared.RelationAttributeType.RELATION, + value_formatter='voluptatem', + ), + ], + feature_flag='FF_MY_FEATURE_FLAG', + legacy=False, + name='customer_messaging', + setting_flag='MY_SETTING', + title='Messaging', + ui_hooks=[ + { + "architecto": 'fuga', + "pariatur": 'debitis', + "voluptatem": 'alias', + "deleniti": 'earum', + }, + { + "sapiente": 'rem', + "minus": 'nemo', + }, + { + "ratione": 'ullam', + "perferendis": 'illum', + "totam": 'impedit', + "quibusdam": 'nam', + }, + { + "culpa": 'dolor', + "aliquam": 'inventore', + }, + ], + ), + shared.EntityCapability( + purpose=[ + '14301042-1813-4d52-88ec-e7e253b66845', + '1c6c6e20-5e16-4dea-b3fe-c9578a645842', + '73a8418d-1623-409f-b092-9921aefb9f58', + ], + attributes=[ + shared.SequenceAttribute( + purpose=[ + '86e68e4b-e056-4013-b59d-a757a59ecfef', + '66ef1caa-3383-4c2b-ab47-7373c8d72f64', + 'd1db1f2c-4310-4661-a963-49e1cf9e06e3', + 'a437000a-e6b6-4bc9-b8f7-59eac55a9741', + ], + constraints={ + "consectetur": 'vitae', + "inventore": 'dolorem', + "ad": 'qui', + "iste": 'ex', + }, + default_value='nemo', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='soluta', + hidden=False, + hide_label=False, + icon='libero', + info_helpers=shared.SequenceAttributeInfoHelpers( + hint_custom_component='rem', + hint_text='dolorum', + hint_text_key='odio', + hint_tooltip_placement='top', + ), + label='fugit', + layout='full_width', + name='Mr. Anne Kautzer', + order=0, + placeholder='neque', + prefix='OR-', + preview_value_formatter='exercitationem', + protected=False, + readonly=False, + render_condition='itaque', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + start_number=88248, + type=shared.SequenceAttributeType.SEQUENCE, + value_formatter='ipsum', + ), + shared.NumberAttribute( + purpose=[ + 'bc2259b1-abda-48c0-b0e1-084cb0672d1a', + 'd879eeb9-665b-485e-bbd0-2bae0be2d782', + '259e3ea4-b519-47f9-a443-da7ce52b895c', + '537c6454-efb0-4b34-896c-3ca5acfbe2fd', + ], + constraints={ + "reprehenderit": 'aperiam', + "odio": 'minima', + }, + default_value='in', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + format='ducimus', + group='excepturi', + hidden=False, + hide_label=False, + icon='dolores', + info_helpers=shared.NumberAttributeInfoHelpers( + hint_custom_component='error', + hint_text='veritatis', + hint_text_key='ducimus', + hint_tooltip_placement='top', + ), + label='voluptate', + layout='full_width', + name='Bradford Murazik', + order=0, + placeholder='quaerat', + preview_value_formatter='commodi', + protected=False, + readonly=False, + render_condition='officiis', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.NumberAttributeType.NUMBER, + value_formatter='placeat', + ), + shared.InternalAttribute( + purpose=[ + '73409e3e-b1e5-4a2b-92eb-07f116db9954', + '5fc95fa8-8970-4e18-9dbb-30fcb33ea055', + ], + constraints={ + "architecto": 'cupiditate', + "molestiae": 'eligendi', + "possimus": 'non', + }, + default_value='magnam', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='itaque', + hidden=False, + hide_label=False, + icon='sed', + info_helpers=shared.InternalAttributeInfoHelpers( + hint_custom_component='asperiores', + hint_text='veniam', + hint_text_key='consequuntur', + hint_tooltip_placement='top', + ), + label='facere', + layout='full_width', + name='Fred Stracke', + order=0, + placeholder='ab', + preview_value_formatter='velit', + protected=False, + readonly=False, + render_condition='facilis', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.InternalAttributeType.INTERNAL, + value_formatter='tempore', + ), + shared.UserRelationAttribute( + purpose=[ + '48b656bc-db35-4ff2-a4b2-7537a8cd9e73', + '19c177d5-25f7-47b1-94ee-b52ff785fc37', + '814d4c98-e0c2-4bb8-9eb7-5dad636c6005', + '03d8bb31-180f-4739-ae9e-057eb809e281', + ], + constraints={ + "velit": 'dolor', + }, + default_value='sunt', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='a', + hidden=False, + hide_label=False, + icon='dolor', + info_helpers=shared.UserRelationAttributeInfoHelpers( + hint_custom_component='occaecati', + hint_text='atque', + hint_text_key='beatae', + hint_tooltip_placement='top', + ), + label='at', + layout='full_width', + multiple=False, + name='Mr. Bethany Koch', + order=0, + placeholder='ea', + preview_value_formatter='aperiam', + protected=False, + readonly=False, + render_condition='dignissimos', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.UserRelationAttributeType.RELATION_USER, + value_formatter='repellat', + ), + ], + feature_flag='FF_MY_FEATURE_FLAG', + legacy=False, + name='customer_messaging', + setting_flag='MY_SETTING', + title='Messaging', + ui_hooks=[ + { + "provident": 'consectetur', + "eligendi": 'dignissimos', + "consectetur": 'soluta', + "natus": 'temporibus', + }, + ], + ), + shared.EntityCapability( + purpose=[ + '3f2ceda7-e23f-4225-b411-faf4b7544e47', + '2e802857-a5b4-4046-ba7d-575f1400e764', + 'ad7334ec-1b78-41b3-aa08-088d100efada', + ], + attributes=[ + shared.TextAttribute( + purpose=[ + 'ef0422eb-2164-4cf9-ab83-66c723ffda9e', + ], + constraints={ + "nisi": 'rerum', + }, + default_value='recusandae', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='voluptates', + hidden=False, + hide_label=False, + icon='non', + info_helpers=shared.TextAttributeInfoHelpers( + hint_custom_component='rem', + hint_text='quia', + hint_text_key='ullam', + hint_tooltip_placement='top', + ), + label='quisquam', + layout='full_width', + multiline=False, + name='Dr. Shari Roob Sr.', + order=0, + placeholder='enim', + preview_value_formatter='optio', + protected=False, + readonly=False, + render_condition='rem', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.TextAttributeType.STRING, + value_formatter='perferendis', + ), + ], + feature_flag='FF_MY_FEATURE_FLAG', + legacy=False, + name='customer_messaging', + setting_flag='MY_SETTING', + title='Messaging', + ui_hooks=[ + { + "a": 'iste', + "dicta": 'quos', + "ullam": 'dolore', + "modi": 'itaque', + }, + { + "modi": 'consequuntur', + "assumenda": 'vero', + "doloribus": 'impedit', + "porro": 'accusamus', + }, + { + "reiciendis": 'ab', + "sint": 'nihil', + "esse": 'iure', + }, + ], + ), + shared.EntityCapability( + purpose=[ + '3e63562a-7b40-48f0-9e3d-48fdaf313a1f', + '5fd94259-c0b3-46f2-9ea9-44f3b756c11f', + ], + attributes=[ + shared.ComputedAttribute( + purpose=[ + '7a512624-3835-4bbc-85a2-3a45cefc5fde', + ], + constraints={ + "alias": 'culpa', + }, + default_value='ipsa', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='nobis', + hidden=False, + hide_label=False, + icon='necessitatibus', + info_helpers=shared.ComputedAttributeInfoHelpers( + hint_custom_component='quia', + hint_text='dicta', + hint_text_key='vel', + hint_tooltip_placement='top', + ), + label='perspiciatis', + layout='full_width', + name='Mr. Derrick Brakus V', + order=0, + placeholder='cumque', + preview_value_formatter='iure', + protected=False, + readonly=False, + render_condition='quibusdam', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.ComputedAttributeType.COMPUTED, + value_formatter='quod', + ), + shared.RelationAttribute( + purpose=[ + '34762799-bfbb-4e69-89fb-2bb4ecae6c3d', + '5db3adeb-d5da-4ea4-8506-a8aa94c02644', + 'cf5e9d9a-4578-4adc-9ac6-00dec001ac80', + '2e2ec09f-f8f0-4f81-aff3-477c13e902c1', + ], + actions=[ + shared.RelationAttributeActions( + action_type=shared.RelationAttributeActionsActionType.ADD_EXISTING, + default=False, + feature_flag='odit', + label='corporis', + new_entity_item={ + "alias": 'error', + "vel": 'accusantium', + "id": 'laboriosam', + }, + setting_flag='ex', + ), + shared.RelationAttributeActions( + action_type=shared.RelationAttributeActionsActionType.CREATE_NEW, + default=False, + feature_flag='veritatis', + label='ullam', + new_entity_item={ + "similique": 'incidunt', + }, + setting_flag='quam', + ), + ], + add_button_label='magni', + allowed_schemas=[ + 'contact', + 'contact', + 'contact', + ], + constraints={ + "omnis": 'sed', + "nesciunt": 'maxime', + "quis": 'cupiditate', + "aliquam": 'excepturi', + }, + default_value='maiores', + deprecated=False, + details_view_mode_enabled=False, + drawer_size=shared.RelationAttributeDrawerSize.MEDIUM, + edit_mode=shared.RelationAttributeEditMode.LIST_VIEW, + enable_relation_picker=False, + enable_relation_tags=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='velit', + has_primary=False, + hidden=False, + hide_label=False, + icon='reiciendis', + info_helpers=shared.RelationAttributeInfoHelpers( + hint_custom_component='amet', + hint_text='nemo', + hint_text_key='ipsa', + hint_tooltip_placement='top', + ), + label='quisquam', + layout='full_width', + name='Morris Kreiger', + order=0, + placeholder='a', + preview_value_formatter='nobis', + protected=False, + readonly=False, + relation_affinity_mode=shared.RelationAttributeRelationAffinityMode.STRONG, + relation_type=shared.RelationAttributeRelationType.HAS_MANY, + render_condition='dicta', + required=False, + reverse_attributes={ + "commodi": 'contact.account', + "eveniet": 'contact.account', + "porro": 'contact.account', + "tempore": 'contact.account', + }, + search_placeholder='quidem', + setting_flag='MY_SETTING', + show_in_table=False, + summary_fields=[ + shared.SummaryField( + display_as='fugit', + field='eius', + ), + 'eligendi', + ], + type=shared.RelationAttributeType.RELATION, + value_formatter='asperiores', + ), + ], + feature_flag='FF_MY_FEATURE_FLAG', + legacy=False, + name='customer_messaging', + setting_flag='MY_SETTING', + title='Messaging', + ui_hooks=[ + { + "sint": 'repellat', + "a": 'animi', + "maiores": 'itaque', + }, + { + "deserunt": 'corporis', + "velit": 'officiis', + "enim": 'officia', + "saepe": 'eum', + }, + ], + ), + ], + dialog_config={ + "accusantium": 'officia', + "impedit": 'quasi', + "blanditiis": 'eius', + "quisquam": 'eos', + }, + draft=False, + enable_setting=[ + '360_features', + '360_features', + '360_features', + ], + explicit_search_mappings={ + "minus": shared.SearchMappings( + fields_={ + "magnam": 'reprehenderit', + }, + index=False, + type=shared.SearchMappingsType.FLATTENED, + ), + "quos": shared.SearchMappings( + fields_={ + "amet": 'molestiae', + "amet": 'laborum', + "modi": 'perferendis', + }, + index=False, + type=shared.SearchMappingsType.NESTED, + ), + "architecto": shared.SearchMappings( + fields_={ + "dolore": 'sunt', + "maiores": 'neque', + "odit": 'earum', + }, + index=False, + type=shared.SearchMappingsType.BOOLEAN, + ), + }, + feature_flag='FF_MY_FEATURE_FLAG', + group_settings=[ + shared.EntitySchemaGroupSettings( + purpose=[ + '55756f5d-56d0-4bd0-af2d-fe13db4f62cb', + ], + expanded=False, + feature_flag='FF_MY_FEATURE_FLAG', + id='a3f8941a-ebc0-4b80-a692-4d3b2ecfcc8f', + info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( + default='voluptatum', + key='iste', + ), + label='corporis', + order=37129, + render_condition='_is_composite_price = "false"', + setting_flag='MY_SETTING', + ), + shared.EntitySchemaGroupSettings( + purpose=[ + '0f5dd3d6-fa18-404e-94c8-2f168a363c88', + ], + expanded=False, + feature_flag='FF_MY_FEATURE_FLAG', + id='73e48438-0b1f-46b8-8a27-5a60a04c495c', + info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( + default='placeat', + key='voluptas', + ), + label='occaecati', + order=600934, + render_condition='_is_composite_price = "false"', + setting_flag='MY_SETTING', + ), + ], + icon='person', + layout_settings={ + "nihil": 'inventore', + }, + name='Contact', + plural='Contacts', + published=False, + slug='contact', + title_template='{{first_name}} {{last_name}}', + ui_config=shared.EntitySchemaUIConfig( + create_view=shared.EntityViewDisabled( + view_type=shared.EntityViewDisabledViewType.DISABLED, + ), + edit_view=shared.RedirectEntityView( + route='/app/pricing-hub/product/:entityId', + view_type=shared.RedirectEntityViewViewType.REDIRECT, + ), + list_item=shared.EntitySchemaUIConfigListItem( + summary_attributes=[ + 'email', + ], + ), + sharing=shared.EntitySchemaUIConfigSharing( + show_sharing_button=True, + ), + single_view=shared.EntityDefaultEdit( + search_params={ + "facere": 'facilis', + "beatae": 'cumque', + "delectus": 'labore', + }, + table_menu_options=shared.EntityDefaultEditTableMenuOptions( + icon='expedita', + label='corrupti', + ), + view_type=shared.EntityDefaultEditViewType.DEFAULT, + ), + table_view=shared.RedirectEntityView( + route='/app/pricing-hub/product/:entityId', + view_type=shared.RedirectEntityViewViewType.REDIRECT, + ), + ), + version=543353, + ), + draft=False, + slug='contact', +) + +res = s.schemas.put_schema(req) + +if res.entity_schema_item is not None: + # handle response +``` diff --git a/entity/docs/taxonomy/README.md b/entity/docs/taxonomy/README.md new file mode 100755 index 000000000..3ad63cfa8 --- /dev/null +++ b/entity/docs/taxonomy/README.md @@ -0,0 +1,213 @@ +# taxonomy + +## Overview + +Entity classification with Taxonomies + +### Available Operations + +* [get_taxonomy](#get_taxonomy) - getTaxonomy +* [list_taxonomies](#list_taxonomies) - listTaxonomies +* [taxonomies_classifications_search](#taxonomies_classifications_search) - taxonomiesClassificationsSearch +* [taxonomy_autocomplete](#taxonomy_autocomplete) - taxonomyAutocomplete +* [update_classifications_for_taxonomy](#update_classifications_for_taxonomy) - updateClassificationsForTaxonomy + +## get_taxonomy + +Get taxonomy by slug + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetTaxonomyRequest( + taxonomy_slug='purpose', +) + +res = s.taxonomy.get_taxonomy(req) + +if res.taxonomy is not None: + # handle response +``` + +## list_taxonomies + +List taxonomies in an organisation + +### Example Usage + +```python +import epilot + + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.taxonomy.list_taxonomies() + +if res.list_taxonomies_200_application_json_object is not None: + # handle response +``` + +## taxonomies_classifications_search + +List taxonomy classifications in an organisation based on taxonomy slug + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.TaxonomiesClassificationsSearchRequest( + request_body=operations.TaxonomiesClassificationsSearchRequestBody( + classification_ids=[ + 'bdfc4ccc-a99b-4c7f-80b2-dce10873e42b', + '006d6788-78ba-4858-9a58-208c54fefa9c', + '95f2eac5-565d-4307-8fee-81206e2813fa', + '4a41c480-d3f2-4132-af03-102d514f4cc6', + ], + ), + taxonomy_slug='repellat', +) + +res = s.taxonomy.taxonomies_classifications_search(req) + +if res.taxonomies_classifications_search_200_application_json_object is not None: + # handle response +``` + +## taxonomy_autocomplete + +Taxonomies autocomplete + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.TaxonomyAutocompleteRequest( + query='quae', + size=5339.78, + taxonomy_slug='expedita', +) + +res = s.taxonomy.taxonomy_autocomplete(req) + +if res.taxonomy_autocomplete_200_application_json_object is not None: + # handle response +``` + +## update_classifications_for_taxonomy + +Update taxonomies in an organisation based in taxonomy slug + +### Example Usage + +```python +import epilot +import dateutil.parser +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.UpdateClassificationsForTaxonomyRequest( + classifications_update=shared.ClassificationsUpdate( + create=[ + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-03-17T11:23:26.153Z'), + id='21a6a4f7-7a87-4ee3-a4be-752c65b34418', + name='Wallbox PV', + parents=[ + '3bb91c8d-975e-40e8-819d-8f84f144f3e0', + '7edcc4aa-5f3c-4abd-905a-972e05672822', + '7b2d3094-70bf-47a4-ba87-cf535a6fae54', + 'ebf60c32-1f02-43b7-9d23-67fe1a0cc8df', + ], + updated_at=dateutil.parser.isoparse('2022-05-31T03:19:09.957Z'), + ), + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-11-12T03:58:41.553Z'), + id='a396d90c-364b-47c1-9dfb-ace188b1c4ee', + name='Wallbox PV', + parents=[ + 'c8c6ce61-1fee-4b1c-bcbd-b6eec74378ba', + ], + updated_at=dateutil.parser.isoparse('2022-09-06T09:53:00.602Z'), + ), + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-11-23T00:22:34.246Z'), + id='7747dc91-5ad2-4caf-9dd6-723dc0f5ae2f', + name='Wallbox PV', + parents=[ + 'a6b70087-8756-4143-b5a6-c98b55554080', + ], + updated_at=dateutil.parser.isoparse('2022-03-24T16:26:44.342Z'), + ), + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-04-05T19:27:13.618Z'), + id='cacc6cbd-6b5f-43ec-9093-04f926bad255', + name='Wallbox PV', + parents=[ + '819b474b-0ed2-40e5-a248-fff639a910ab', + ], + updated_at=dateutil.parser.isoparse('2020-09-02T19:39:17.071Z'), + ), + ], + delete=[ + 'b6267669-6e1e-4c00-a21b-335d89acb3ec', + 'fda8d0c5-49ef-4030-8497-8a61fa1cf206', + '88f77c1f-fc71-4dca-963f-2a3c80a97ff3', + ], + update=[ + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-03-28T10:53:29.573Z'), + id='ddf857a9-e618-476c-aab2-1d29dfc94d6f', + name='Wallbox PV', + parents=[ + 'cd799390-066a-46d2-9000-355338cec086', + 'fa21e915-2cb3-4119-967b-8e3c8db03408', + 'd6d364ff-d455-4906-9126-3d48e935c2c9', + 'e81f30be-3e43-4202-9721-657650664187', + ], + updated_at=dateutil.parser.isoparse('2022-03-05T14:32:00.362Z'), + ), + ], + ), + taxonomy_slug='provident', +) + +res = s.taxonomy.update_classifications_for_taxonomy(req) + +if res.update_classifications_for_taxonomy_200_application_json_object is not None: + # handle response +``` diff --git a/entity/files.gen b/entity/files.gen index 5fbc99a8f..5c8c16cc5 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -1,11 +1,14 @@ +src/epilot/sdkconfiguration.py src/epilot/activity.py src/epilot/entities.py +src/epilot/entity_import.py src/epilot/export.py src/epilot/relations.py src/epilot/saved_views.py src/epilot/schemas.py src/epilot/taxonomy.py src/epilot/sdk.py +.gitignore pylintrc setup.py src/epilot/__init__.py @@ -25,8 +28,8 @@ src/epilot/models/operations/patchentity.py src/epilot/models/operations/searchentities.py src/epilot/models/operations/updateentity.py src/epilot/models/operations/upsertentity.py -src/epilot/models/operations/exportentities.py src/epilot/models/operations/importentities.py +src/epilot/models/operations/exportentities.py src/epilot/models/operations/addrelations.py src/epilot/models/operations/deleterelation.py src/epilot/models/operations/getrelations.py @@ -104,4 +107,13 @@ src/epilot/models/shared/taxonomy.py src/epilot/models/shared/classificationsupdate.py src/epilot/models/shared/security.py src/epilot/models/shared/__init__.py +docs/epilot/README.md +docs/activity/README.md +docs/entities/README.md +docs/entityimport/README.md +docs/export/README.md +docs/relations/README.md +docs/savedviews/README.md +docs/schemas/README.md +docs/taxonomy/README.md USAGE.md \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 852bdf838..fe88b324a 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,16 +1,17 @@ configVersion: 1.0.0 management: - docChecksum: 08db6223bb1d9fff9895a9628a24aab3 + docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.19.2 - generationVersion: 2.16.5 + speakeasyVersion: 1.45.2 + generationVersion: 2.37.2 generation: - telemetryEnabled: false sdkClassName: epilot sdkFlattening: true singleTagPerOp: false + telemetryEnabled: false python: - version: 1.2.2 + version: 1.3.0 author: epilot description: Python Client SDK for Epilot + maxMethodParams: 0 packageName: epilot-entity diff --git a/entity/pylintrc b/entity/pylintrc index cb9d37ade..dd6adb149 100755 --- a/entity/pylintrc +++ b/entity/pylintrc @@ -124,12 +124,7 @@ attr-naming-style=snake_case #attr-rgx= # Bad variable names which should always be refused, separated by a comma. -bad-names=foo, - bar, - baz, - toto, - tutu, - tata +bad-names= # Bad variable names regexes, separated by a comma. If names match any regex, # they will always be refused @@ -440,7 +435,11 @@ disable=raw-checker-failed, trailing-newlines, too-many-public-methods, too-many-locals, - too-many-lines + too-many-lines, + using-constant-test, + too-many-statements, + cyclic-import, + too-many-nested-blocks # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option diff --git a/entity/setup.py b/entity/setup.py index 66da8b6d1..b9c2b2092 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,30 +10,33 @@ setuptools.setup( name="epilot-entity", - version="1.2.2", + version="1.3.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, long_description_content_type="text/markdown", packages=setuptools.find_packages(where="src"), install_requires=[ - "certifi==2022.12.07", - "charset-normalizer==2.1.1", - "dataclasses-json-speakeasy==0.5.8", - "idna==3.3", - "marshmallow==3.17.1", - "marshmallow-enum==1.5.1", - "mypy-extensions==0.4.3", - "packaging==21.3", - "pyparsing==3.0.9", - "python-dateutil==2.8.2", - "requests==2.28.1", - "six==1.16.0", - "typing-inspect==0.8.0", - "typing_extensions==4.3.0", - "urllib3==1.26.12", - "pylint==2.16.2", + "certifi>=2022.12.7", + "charset-normalizer>=2.1.1", + "dataclasses-json-speakeasy>=0.5.8", + "idna>=3.3", + "jsonpath-python>=1.0.6 ", + "marshmallow>=3.17.1", + "marshmallow-enum>=1.5.1", + "mypy-extensions>=0.4.3", + "packaging>=21.3", + "pyparsing>=3.0.9", + "python-dateutil>=2.8.2", + "requests>=2.28.1", + "six>=1.16.0", + "typing-inspect>=0.8.0", + "typing_extensions>=4.3.0", + "urllib3>=1.26.12", ], + extras_require={ + "dev":["pylint==2.16.2"] + }, package_dir={'': 'src'}, python_requires='>=3.9' ) diff --git a/entity/src/epilot/__init__.py b/entity/src/epilot/__init__.py index b9e232018..e6c0deeb6 100755 --- a/entity/src/epilot/__init__.py +++ b/entity/src/epilot/__init__.py @@ -1,3 +1,4 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" from .sdk import * +from .sdkconfiguration import * diff --git a/entity/src/epilot/activity.py b/entity/src/epilot/activity.py index 1a53c9fbc..d98a66118 100755 --- a/entity/src/epilot/activity.py +++ b/entity/src/epilot/activity.py @@ -1,40 +1,33 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests as requests_http -from . import utils +from .sdkconfiguration import SDKConfiguration +from epilot import utils from epilot.models import operations, shared from typing import Optional class Activity: r"""Entity Events""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str - _language: str - _sdk_version: str - _gen_version: str + sdk_configuration: SDKConfiguration - def __init__(self, client: requests_http.Session, security_client: requests_http.Session, server_url: str, language: str, sdk_version: str, gen_version: str) -> None: - self._client = client - self._security_client = security_client - self._server_url = server_url - self._language = language - self._sdk_version = sdk_version - self._gen_version = gen_version + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + def attach_activity(self, request: operations.AttachActivityRequest) -> operations.AttachActivityResponse: r"""attachActivity Attach existing activity to entity activity feeds """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.AttachActivityRequest, base_url, '/v1/entity/activity/{id}:attach', request) - + headers = {} query_params = utils.get_query_params(operations.AttachActivityRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('POST', url, params=query_params) + http_res = client.request('POST', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.AttachActivityResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -46,25 +39,26 @@ def attach_activity(self, request: operations.AttachActivityRequest) -> operatio return res + def create_activity(self, request: operations.CreateActivityRequest) -> operations.CreateActivityResponse: r"""createActivity Create an activity that can be displayed in activity feeds. - All activites are published as events on the event bus - Entity mutations are always part of an activity - """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity/activity' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/entity/activity' headers = {} req_content_type, data, form = utils.serialize_request_body(request, "activity", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateActivityRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('POST', url, params=query_params, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') @@ -78,19 +72,22 @@ def create_activity(self, request: operations.CreateActivityRequest) -> operatio return res + def get_activity(self, request: operations.GetActivityRequest) -> operations.GetActivityResponse: r"""getActivity Get activity by id """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.GetActivityRequest, base_url, '/v1/entity/activity/{id}', request) - + headers = {} query_params = utils.get_query_params(operations.GetActivityRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetActivityResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -102,20 +99,22 @@ def get_activity(self, request: operations.GetActivityRequest) -> operations.Get return res + def get_entity_activity_feed(self, request: operations.GetEntityActivityFeedRequest) -> operations.GetEntityActivityFeedResponse: r"""getEntityActivityFeed Get activity feed for an entity - """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.GetEntityActivityFeedRequest, base_url, '/v1/entity/{slug}/{id}/activity', request) - + headers = {} query_params = utils.get_query_params(operations.GetEntityActivityFeedRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetEntityActivityFeedResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) diff --git a/entity/src/epilot/entities.py b/entity/src/epilot/entities.py index 7e62dbdae..0eaf14f3e 100755 --- a/entity/src/epilot/entities.py +++ b/entity/src/epilot/entities.py @@ -1,41 +1,33 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests as requests_http -from . import utils +from .sdkconfiguration import SDKConfiguration +from epilot import utils from epilot.models import operations, shared from typing import Any, Optional class Entities: r"""CRUD Access for Entities""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str - _language: str - _sdk_version: str - _gen_version: str + sdk_configuration: SDKConfiguration - def __init__(self, client: requests_http.Session, security_client: requests_http.Session, server_url: str, language: str, sdk_version: str, gen_version: str) -> None: - self._client = client - self._security_client = security_client - self._server_url = server_url - self._language = language - self._sdk_version = sdk_version - self._gen_version = gen_version + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + def autocomplete(self, request: operations.AutocompleteRequest) -> operations.AutocompleteResponse: r"""autocomplete Autocomplete entity attributes - """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity:autocomplete' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/entity:autocomplete' + headers = {} query_params = utils.get_query_params(operations.AutocompleteRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.AutocompleteResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -47,6 +39,7 @@ def autocomplete(self, request: operations.AutocompleteRequest) -> operations.Au return res + def create_entity(self, request: operations.CreateEntityRequest) -> operations.CreateEntityResponse: r"""createEntity Creates a new entity using a key. @@ -74,19 +67,19 @@ def create_entity(self, request: operations.CreateEntityRequest) -> operations.C The items in `$relation` support two properties: - `entity_id` - The ID of the entity to link - `_tags` - Tags or labels for the relation (optional) - """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.CreateEntityRequest, base_url, '/v1/entity/{slug}', request) - headers = {} req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateEntityRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('POST', url, params=query_params, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') @@ -100,6 +93,7 @@ def create_entity(self, request: operations.CreateEntityRequest) -> operations.C return res + def delete_entity(self, request: operations.DeleteEntityRequest) -> operations.DeleteEntityResponse: r"""deleteEntity Deletes an Entity @@ -107,26 +101,26 @@ def delete_entity(self, request: operations.DeleteEntityRequest) -> operations.D ## Activity If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityDeleted` - """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.DeleteEntityRequest, base_url, '/v1/entity/{slug}/{id}', request) - + headers = {} query_params = utils.get_query_params(operations.DeleteEntityRequest, request) + headers['Accept'] = '*/*' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('DELETE', url, params=query_params) + http_res = client.request('DELETE', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.DeleteEntityResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - if http_res.status_code == 200: - pass return res + def get_entity(self, request: operations.GetEntityRequest) -> operations.GetEntityResponse: r"""getEntity Gets Entity and relations by id. @@ -192,17 +186,18 @@ def get_entity(self, request: operations.GetEntityRequest) -> operations.GetEnti ] } ``` - """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.GetEntityRequest, base_url, '/v1/entity/{slug}/{id}', request) - + headers = {} query_params = utils.get_query_params(operations.GetEntityRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetEntityResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -214,6 +209,7 @@ def get_entity(self, request: operations.GetEntityRequest) -> operations.GetEnti return res + def patch_entity(self, request: operations.PatchEntityRequest) -> operations.PatchEntityResponse: r"""patchEntity Partially updates an entity with the passed in entity data. @@ -243,12 +239,10 @@ def patch_entity(self, request: operations.PatchEntityRequest) -> operations.Pat The items in `$relation` support two properties: - `entity_id` - The ID of the entity to link - `_tags` - Tags or labels for the relation (optional) - """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.PatchEntityRequest, base_url, '/v1/entity/{slug}/{id}', request) - headers = {} req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): @@ -256,8 +250,10 @@ def patch_entity(self, request: operations.PatchEntityRequest) -> operations.Pat if data is None and form is None: raise Exception('request body is required') query_params = utils.get_query_params(operations.PatchEntityRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('PATCH', url, params=query_params, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') @@ -273,6 +269,7 @@ def patch_entity(self, request: operations.PatchEntityRequest) -> operations.Pat return res + def search_entities(self, request: shared.EntitySearchParams) -> operations.SearchEntitiesResponse: r"""searchEntities Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying. @@ -340,18 +337,18 @@ def search_entities(self, request: shared.EntitySearchParams) -> operations.Sear ] } ``` - """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity:search' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/entity:search' headers = {} req_content_type, data, form = utils.serialize_request_body(request, "request", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type + headers['Accept'] = 'application/json;q=1, text/csv;q=0' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('POST', url, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') @@ -367,6 +364,7 @@ def search_entities(self, request: shared.EntitySearchParams) -> operations.Sear return res + def update_entity(self, request: operations.UpdateEntityRequest) -> operations.UpdateEntityResponse: r"""updateEntity Updates an Entity @@ -394,19 +392,19 @@ def update_entity(self, request: operations.UpdateEntityRequest) -> operations.U The items in `$relation` support two properties: - `entity_id` - The ID of the entity to link - `_tags` - Tags or labels for the relation (optional) - """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.UpdateEntityRequest, base_url, '/v1/entity/{slug}/{id}', request) - headers = {} req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.UpdateEntityRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('PUT', url, params=query_params, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') @@ -420,6 +418,7 @@ def update_entity(self, request: operations.UpdateEntityRequest) -> operations.U return res + def upsert_entity(self, request: operations.UpsertEntityRequest) -> operations.UpsertEntityResponse: r"""upsertEntity Create or update an entity using `unique_key` @@ -431,19 +430,19 @@ def upsert_entity(self, request: operations.UpsertEntityRequest) -> operations.U ## Activity If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityCreated` or `EntityUpdated` - """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.UpsertEntityRequest, base_url, '/v1/entity/{slug}:upsert', request) - headers = {} req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.UpsertEntityRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('PATCH', url, params=query_params, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') diff --git a/entity/src/epilot/entity_import.py b/entity/src/epilot/entity_import.py new file mode 100755 index 000000000..8e7f93f30 --- /dev/null +++ b/entity/src/epilot/entity_import.py @@ -0,0 +1,41 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from .sdkconfiguration import SDKConfiguration +from epilot import utils +from epilot.models import operations + +class EntityImport: + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + + + def import_entities(self, request: operations.ImportEntitiesRequest) -> operations.ImportEntitiesResponse: + r"""Import Entities + This endpoint enables the import of entities into the platform. + The entities should be provided in a CSV format inside an S3 bucket. + This API will return the `job_id`` which can be used to fetch the status of the import process. + """ + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/v1/entity:import' + headers = {} + req_content_type, data, form = utils.serialize_request_body(request, "entity_import_params", 'json') + if req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + query_params = utils.get_query_params(operations.ImportEntitiesRequest, request) + headers['Accept'] = '*/*' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + + client = self.sdk_configuration.security_client + + http_res = client.request('POST', url, params=query_params, data=data, files=form, headers=headers) + content_type = http_res.headers.get('Content-Type') + + res = operations.ImportEntitiesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + + + return res + + \ No newline at end of file diff --git a/entity/src/epilot/export.py b/entity/src/epilot/export.py index 4dd6297c2..fda5b8a66 100755 --- a/entity/src/epilot/export.py +++ b/entity/src/epilot/export.py @@ -1,75 +1,39 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests as requests_http -from . import utils +from .sdkconfiguration import SDKConfiguration +from epilot import utils from epilot.models import operations class Export: r"""Export and Import entities via files""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str - _language: str - _sdk_version: str - _gen_version: str + sdk_configuration: SDKConfiguration - def __init__(self, client: requests_http.Session, security_client: requests_http.Session, server_url: str, language: str, sdk_version: str, gen_version: str) -> None: - self._client = client - self._security_client = security_client - self._server_url = server_url - self._language = language - self._sdk_version = sdk_version - self._gen_version = gen_version + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + def export_entities(self, request: operations.ExportEntitiesRequest) -> operations.ExportEntitiesResponse: r"""exportEntities create export file of entities """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity:export' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/entity:export' headers = {} req_content_type, data, form = utils.serialize_request_body(request, "entity_search_params", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.ExportEntitiesRequest, request) + headers['Accept'] = '*/*' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('POST', url, params=query_params, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.ExportEntitiesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - if http_res.status_code == 201: - pass - - return res - - def import_entities(self, request: operations.ImportEntitiesRequest) -> operations.ImportEntitiesResponse: - r"""importEntities - import entity data from - """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity:import' - - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "entity_import_params", 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - query_params = utils.get_query_params(operations.ImportEntitiesRequest, request) - - client = self._security_client - - http_res = client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.ImportEntitiesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 201: - pass return res diff --git a/entity/src/epilot/models/operations/addrelations.py b/entity/src/epilot/models/operations/addrelations.py index 5222ca473..f1c7fe46d 100755 --- a/entity/src/epilot/models/operations/addrelations.py +++ b/entity/src/epilot/models/operations/addrelations.py @@ -11,20 +11,20 @@ class AddRelationsRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Entity id""" + r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Type""" + r"""Entity Type""" async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) - r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" - request_body: Optional[list[shared_relationitem.RelationItem]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" + request_body: Optional[list[shared_relationitem.RelationItem]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @dataclasses.dataclass class AddRelationsResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) relation_item: Optional[shared_relationitem.RelationItem] = dataclasses.field(default=None) - r"""Success""" + r"""Success""" \ No newline at end of file diff --git a/entity/src/epilot/models/operations/attachactivity.py b/entity/src/epilot/models/operations/attachactivity.py index 7c09227f9..0e01e3d3d 100755 --- a/entity/src/epilot/models/operations/attachactivity.py +++ b/entity/src/epilot/models/operations/attachactivity.py @@ -11,17 +11,17 @@ class AttachActivityRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Activity Id""" + r"""Activity Id""" entities: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'entities', 'style': 'form', 'explode': False }}) - r"""Comma-separated list of entities which the activity primarily concerns""" + r"""Comma-separated list of entities which the activity primarily concerns""" @dataclasses.dataclass class AttachActivityResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() activity_item: Optional[shared_activityitem.ActivityItem] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/autocomplete.py b/entity/src/epilot/models/operations/autocomplete.py index 9222f6f39..7c41af7d8 100755 --- a/entity/src/epilot/models/operations/autocomplete.py +++ b/entity/src/epilot/models/operations/autocomplete.py @@ -12,13 +12,13 @@ class AutocompleteRequest: attribute: str = dataclasses.field(metadata={'query_param': { 'field_name': 'attribute', 'style': 'form', 'explode': True }}) - r"""Autocomplete attribute""" + r"""Autocomplete attribute""" input: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'input', 'style': 'form', 'explode': True }}) - r"""Input to autocomplete""" + r"""Input to autocomplete""" size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) - r"""Maximum number of results to return""" + r"""Maximum number of results to return""" slug: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'slug', 'style': 'form', 'explode': True }}) - r"""Limit results to entity schema""" + r"""Limit results to entity schema""" @dataclass_json(undefined=Undefined.EXCLUDE) @@ -26,16 +26,16 @@ class AutocompleteRequest: class Autocomplete200ApplicationJSON: r"""Success""" - hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) - results: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) + results: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class AutocompleteResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() autocomplete_200_application_json_object: Optional[Autocomplete200ApplicationJSON] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/createactivity.py b/entity/src/epilot/models/operations/createactivity.py index 0a2b6951a..325121647 100755 --- a/entity/src/epilot/models/operations/createactivity.py +++ b/entity/src/epilot/models/operations/createactivity.py @@ -11,17 +11,17 @@ @dataclasses.dataclass class CreateActivityRequest: - activity: Optional[shared_activity.Activity] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + activity: Optional[shared_activity.Activity] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) entities: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'entities', 'style': 'form', 'explode': False }}) - r"""Comma-separated list of entities which the activity primarily concerns""" + r"""Comma-separated list of entities which the activity primarily concerns""" @dataclasses.dataclass class CreateActivityResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() activity_item: Optional[shared_activityitem.ActivityItem] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/createentity.py b/entity/src/epilot/models/operations/createentity.py index 2fc5ae0c9..53149e334 100755 --- a/entity/src/epilot/models/operations/createentity.py +++ b/entity/src/epilot/models/operations/createentity.py @@ -10,20 +10,20 @@ class CreateEntityRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Schema""" + r"""Entity Schema""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) - r"""Activity to include in event feed""" + r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) - r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" - request_body: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" + request_body: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @dataclasses.dataclass class CreateEntityResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/createsavedview.py b/entity/src/epilot/models/operations/createsavedview.py index 79c8910ab..66d9ffad2 100755 --- a/entity/src/epilot/models/operations/createsavedview.py +++ b/entity/src/epilot/models/operations/createsavedview.py @@ -10,9 +10,9 @@ @dataclasses.dataclass class CreateSavedViewResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) saved_view_item: Optional[shared_savedviewitem.SavedViewItem] = dataclasses.field(default=None) - r"""Success""" + r"""Success""" \ No newline at end of file diff --git a/entity/src/epilot/models/operations/deleteentity.py b/entity/src/epilot/models/operations/deleteentity.py index aa5b318cc..5c36bc644 100755 --- a/entity/src/epilot/models/operations/deleteentity.py +++ b/entity/src/epilot/models/operations/deleteentity.py @@ -9,17 +9,17 @@ @dataclasses.dataclass class DeleteEntityRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) + id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Type""" + r"""Entity Type""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) - r"""Activity to include in event feed""" + r"""Activity to include in event feed""" @dataclasses.dataclass class DeleteEntityResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/deleterelation.py b/entity/src/epilot/models/operations/deleterelation.py index 1fc1ff9cc..52509fd77 100755 --- a/entity/src/epilot/models/operations/deleterelation.py +++ b/entity/src/epilot/models/operations/deleterelation.py @@ -10,21 +10,21 @@ class DeleteRelationRequest: attribute: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attribute', 'style': 'simple', 'explode': False }}) - r"""The attribute that express meaning""" + r"""The attribute that express meaning""" entity_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'entity_id', 'style': 'simple', 'explode': False }}) - r"""The attribute that express meaning""" + r"""The attribute that express meaning""" id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Entity id""" + r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Type""" + r"""Entity Type""" async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) - r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" + r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" @dataclasses.dataclass class DeleteRelationResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/deletesavedview.py b/entity/src/epilot/models/operations/deletesavedview.py index 641140151..c43649bb3 100755 --- a/entity/src/epilot/models/operations/deletesavedview.py +++ b/entity/src/epilot/models/operations/deletesavedview.py @@ -10,13 +10,13 @@ class DeleteSavedViewRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""View id""" + r"""View id""" @dataclasses.dataclass class DeleteSavedViewResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/deleteschema.py b/entity/src/epilot/models/operations/deleteschema.py index 63e149fef..c44a6f1e6 100755 --- a/entity/src/epilot/models/operations/deleteschema.py +++ b/entity/src/epilot/models/operations/deleteschema.py @@ -9,13 +9,13 @@ @dataclasses.dataclass class DeleteSchemaRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @dataclasses.dataclass class DeleteSchemaResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/exportentities.py b/entity/src/epilot/models/operations/exportentities.py index 0ed9440e8..3cb1c5377 100755 --- a/entity/src/epilot/models/operations/exportentities.py +++ b/entity/src/epilot/models/operations/exportentities.py @@ -10,19 +10,19 @@ @dataclasses.dataclass class ExportEntitiesRequest: - entity_search_params: Optional[shared_entitysearchparams.EntitySearchParams] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + entity_search_params: Optional[shared_entitysearchparams.EntitySearchParams] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) is_template: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'is_template', 'style': 'form', 'explode': True }}) - r"""Pass 'true' to generate import template""" + r"""Pass 'true' to generate import template""" job_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'job_id', 'style': 'form', 'explode': True }}) - r"""Export Job Id to get the result""" + r"""Export Job Id to get the result""" language: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'language', 'style': 'form', 'explode': True }}) - r"""Export headers translation language""" + r"""Export headers translation language""" @dataclasses.dataclass class ExportEntitiesResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/getactivity.py b/entity/src/epilot/models/operations/getactivity.py index ff4ef93c8..3117c4ceb 100755 --- a/entity/src/epilot/models/operations/getactivity.py +++ b/entity/src/epilot/models/operations/getactivity.py @@ -11,23 +11,19 @@ class GetActivityRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Activity Id""" + r"""Activity Id""" operations_from: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'operations_from', 'style': 'form', 'explode': True }}) - r"""Pagination offset for operations - - """ + r"""Pagination offset for operations""" operations_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'operations_size', 'style': 'form', 'explode': True }}) - r"""Maximum number of operations to include in response (default: 10) - - """ + r"""Maximum number of operations to include in response (default: 10)""" @dataclasses.dataclass class GetActivityResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() activity_item: Optional[shared_activityitem.ActivityItem] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/getentity.py b/entity/src/epilot/models/operations/getentity.py index 00c7a6548..771f46c85 100755 --- a/entity/src/epilot/models/operations/getentity.py +++ b/entity/src/epilot/models/operations/getentity.py @@ -12,11 +12,11 @@ class GetEntityRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Entity id""" + r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Type""" + r"""Entity Type""" hydrate: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) - r"""When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.""" + r"""When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.""" @dataclass_json(undefined=Undefined.EXCLUDE) @@ -24,16 +24,16 @@ class GetEntityRequest: class GetEntity200ApplicationJSON: r"""Success""" - entity: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity'), 'exclude': lambda f: f is None }}) - relations: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) + entity: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity'), 'exclude': lambda f: f is None }}) + relations: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class GetEntityResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() get_entity_200_application_json_object: Optional[GetEntity200ApplicationJSON] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/getentityactivityfeed.py b/entity/src/epilot/models/operations/getentityactivityfeed.py index 545d9ca12..2ede3a77a 100755 --- a/entity/src/epilot/models/operations/getentityactivityfeed.py +++ b/entity/src/epilot/models/operations/getentityactivityfeed.py @@ -14,19 +14,19 @@ class GetEntityActivityFeedRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Entity id""" + r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Type""" + r"""Entity Type""" after: Optional[datetime] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'after', 'style': 'form', 'explode': True }}) - r"""Get activities after this timestamp""" + r"""Get activities after this timestamp""" before: Optional[datetime] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'before', 'style': 'form', 'explode': True }}) - r"""get activities before this timestamp""" + r"""get activities before this timestamp""" from_: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) - r"""start from page""" + r"""start from page""" size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) - r"""max number of results to return""" + r"""max number of results to return""" type: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'type', 'style': 'form', 'explode': True }}) - r"""Activity type""" + r"""Activity type""" @dataclass_json(undefined=Undefined.EXCLUDE) @@ -34,16 +34,16 @@ class GetEntityActivityFeedRequest: class GetEntityActivityFeed200ApplicationJSON: r"""Success""" - results: Optional[list[shared_activityitem.ActivityItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - total: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('total'), 'exclude': lambda f: f is None }}) + results: Optional[list[shared_activityitem.ActivityItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + total: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('total'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class GetEntityActivityFeedResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() get_entity_activity_feed_200_application_json_object: Optional[GetEntityActivityFeed200ApplicationJSON] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py index eb38b4ae3..46e9948a8 100755 --- a/entity/src/epilot/models/operations/getrelations.py +++ b/entity/src/epilot/models/operations/getrelations.py @@ -10,21 +10,21 @@ class GetRelationsRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Entity id""" + r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Type""" + r"""Entity Type""" hydrate: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) - r"""When true, expand relation items with full blown entities.""" + r"""When true, expand relation items with full blown entities.""" include_reverse: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) - r"""When true, includes reverse relations in response (other entities pointing to this entity)""" + r"""When true, includes reverse relations in response (other entities pointing to this entity)""" @dataclasses.dataclass class GetRelationsResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() get_relations_resp: Optional[list[Any]] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/getrelationsv2.py b/entity/src/epilot/models/operations/getrelationsv2.py index fc9996797..f5cca7882 100755 --- a/entity/src/epilot/models/operations/getrelationsv2.py +++ b/entity/src/epilot/models/operations/getrelationsv2.py @@ -11,29 +11,29 @@ class GetRelationsV2Request: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Entity id""" + r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Type""" - fields: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': True }}) - r"""List of entity fields to include in results""" + r"""Entity Type""" + fields_: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': True }}) + r"""List of entity fields to include in results""" from_: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) - r"""Starting page number""" + r"""Starting page number""" hydrate: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) - r"""When true, expand relation items with full blown entities.""" + r"""When true, expand relation items with full blown entities.""" include_reverse: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) - r"""When true, includes reverse relations in response (other entities pointing to this entity)""" + r"""When true, includes reverse relations in response (other entities pointing to this entity)""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) - r"""Input to filter search results""" + r"""Input to filter search results""" size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) - r"""Number of results to return per page""" + r"""Number of results to return per page""" @dataclasses.dataclass class GetRelationsV2Response: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() get_relations_resp_with_pagination: Optional[shared_getrelationsrespwithpagination.GetRelationsRespWithPagination] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/getsavedview.py b/entity/src/epilot/models/operations/getsavedview.py index 28f720ade..5e1036ef3 100755 --- a/entity/src/epilot/models/operations/getsavedview.py +++ b/entity/src/epilot/models/operations/getsavedview.py @@ -13,7 +13,7 @@ class GetSavedViewRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""View id""" + r"""View id""" @dataclass_json(undefined=Undefined.EXCLUDE) @@ -21,15 +21,15 @@ class GetSavedViewRequest: class GetSavedView200ApplicationJSON: r"""Success""" - view: Optional[shared_savedviewitem.SavedViewItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view'), 'exclude': lambda f: f is None }}) + view: Optional[shared_savedviewitem.SavedViewItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class GetSavedViewResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() get_saved_view_200_application_json_object: Optional[GetSavedView200ApplicationJSON] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/getschema.py b/entity/src/epilot/models/operations/getschema.py index 59ff80c70..4b89cb308 100755 --- a/entity/src/epilot/models/operations/getschema.py +++ b/entity/src/epilot/models/operations/getschema.py @@ -10,16 +10,16 @@ @dataclasses.dataclass class GetSchemaRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'id', 'style': 'form', 'explode': True }}) + slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'id', 'style': 'form', 'explode': True }}) @dataclasses.dataclass class GetSchemaResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() entity_schema_item: Optional[shared_entityschemaitem.EntitySchemaItem] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/getschemaversions.py b/entity/src/epilot/models/operations/getschemaversions.py index 6c7f26c56..cfbd7851d 100755 --- a/entity/src/epilot/models/operations/getschemaversions.py +++ b/entity/src/epilot/models/operations/getschemaversions.py @@ -12,7 +12,11 @@ @dataclasses.dataclass class GetSchemaVersionsRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + drafts_from: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'drafts_from', 'style': 'form', 'explode': True }}) + drafts_size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'drafts_size', 'style': 'form', 'explode': True }}) + versions_from: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'versions_from', 'style': 'form', 'explode': True }}) + versions_size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'versions_size', 'style': 'form', 'explode': True }}) @dataclass_json(undefined=Undefined.EXCLUDE) @@ -20,16 +24,16 @@ class GetSchemaVersionsRequest: class GetSchemaVersions200ApplicationJSON: r"""Success""" - drafts: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('drafts'), 'exclude': lambda f: f is None }}) - versions: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('versions'), 'exclude': lambda f: f is None }}) + drafts: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('drafts'), 'exclude': lambda f: f is None }}) + versions: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('versions'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class GetSchemaVersionsResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() get_schema_versions_200_application_json_object: Optional[GetSchemaVersions200ApplicationJSON] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/gettaxonomy.py b/entity/src/epilot/models/operations/gettaxonomy.py index c13811e44..441fac98b 100755 --- a/entity/src/epilot/models/operations/gettaxonomy.py +++ b/entity/src/epilot/models/operations/gettaxonomy.py @@ -11,15 +11,15 @@ class GetTaxonomyRequest: taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) - r"""Taxonomy slug to return taxonomy for""" + r"""Taxonomy slug to return taxonomy for""" @dataclasses.dataclass class GetTaxonomyResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) taxonomy: Optional[shared_taxonomy.Taxonomy] = dataclasses.field(default=None) - r"""Taxonomy""" + r"""Taxonomy""" \ No newline at end of file diff --git a/entity/src/epilot/models/operations/importentities.py b/entity/src/epilot/models/operations/importentities.py index b4aeac9d7..1663206ab 100755 --- a/entity/src/epilot/models/operations/importentities.py +++ b/entity/src/epilot/models/operations/importentities.py @@ -10,15 +10,15 @@ @dataclasses.dataclass class ImportEntitiesRequest: - entity_import_params: Optional[shared_entityimportparams.EntityImportParams] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + entity_import_params: Optional[shared_entityimportparams.EntityImportParams] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) job_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'job_id', 'style': 'form', 'explode': True }}) - r"""Import Job Id to get the result""" + r"""The ID of the import job. This ID is used to track the progress and fetch the result of the import operation.""" @dataclasses.dataclass class ImportEntitiesResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/listsavedviews.py b/entity/src/epilot/models/operations/listsavedviews.py index 21407a550..6fb9c1c27 100755 --- a/entity/src/epilot/models/operations/listsavedviews.py +++ b/entity/src/epilot/models/operations/listsavedviews.py @@ -14,15 +14,15 @@ class ListSavedViews200ApplicationJSON: r"""Success""" - results: Optional[list[shared_savedviewitem.SavedViewItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[list[shared_savedviewitem.SavedViewItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class ListSavedViewsResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() list_saved_views_200_application_json_object: Optional[ListSavedViews200ApplicationJSON] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/listschemablueprints.py b/entity/src/epilot/models/operations/listschemablueprints.py index 6d8b5b024..7ba9e7260 100755 --- a/entity/src/epilot/models/operations/listschemablueprints.py +++ b/entity/src/epilot/models/operations/listschemablueprints.py @@ -14,15 +14,15 @@ class ListSchemaBlueprints200ApplicationJSON: r"""Success""" - results: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class ListSchemaBlueprintsResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() list_schema_blueprints_200_application_json_object: Optional[ListSchemaBlueprints200ApplicationJSON] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/listschemas.py b/entity/src/epilot/models/operations/listschemas.py index 2614845f5..cb7accd57 100755 --- a/entity/src/epilot/models/operations/listschemas.py +++ b/entity/src/epilot/models/operations/listschemas.py @@ -13,7 +13,7 @@ class ListSchemasRequest: unpublished: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'unpublished', 'style': 'form', 'explode': True }}) - r"""Return unpublished draft schemas""" + r"""Return unpublished draft schemas""" @dataclass_json(undefined=Undefined.EXCLUDE) @@ -21,15 +21,15 @@ class ListSchemasRequest: class ListSchemas200ApplicationJSON: r"""Success""" - results: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class ListSchemasResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() list_schemas_200_application_json_object: Optional[ListSchemas200ApplicationJSON] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/listtaxonomies.py b/entity/src/epilot/models/operations/listtaxonomies.py index 509636d7c..709ae7dd4 100755 --- a/entity/src/epilot/models/operations/listtaxonomies.py +++ b/entity/src/epilot/models/operations/listtaxonomies.py @@ -14,15 +14,15 @@ class ListTaxonomies200ApplicationJSON: r"""Returns list of taxonomies in an organisation""" - results: Optional[list[shared_taxonomy.Taxonomy]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[list[shared_taxonomy.Taxonomy]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class ListTaxonomiesResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() list_taxonomies_200_application_json_object: Optional[ListTaxonomies200ApplicationJSON] = dataclasses.field(default=None) - r"""Returns list of taxonomies in an organisation""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Returns list of taxonomies in an organisation""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py index 0fbbb0ea4..4948755a5 100755 --- a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py +++ b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py @@ -12,10 +12,10 @@ @dataclasses.dataclass class ListTaxonomyClassificationsForSchemaRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) - query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) - size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) + slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) + query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) + size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) @dataclass_json(undefined=Undefined.EXCLUDE) @@ -23,15 +23,15 @@ class ListTaxonomyClassificationsForSchemaRequest: class ListTaxonomyClassificationsForSchema200ApplicationJSON: r"""List of taxonomy classifications""" - results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class ListTaxonomyClassificationsForSchemaResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() list_taxonomy_classifications_for_schema_200_application_json_object: Optional[ListTaxonomyClassificationsForSchema200ApplicationJSON] = dataclasses.field(default=None) - r"""List of taxonomy classifications""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""List of taxonomy classifications""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/patchentity.py b/entity/src/epilot/models/operations/patchentity.py index 7c780fa34..e2d8d2e4d 100755 --- a/entity/src/epilot/models/operations/patchentity.py +++ b/entity/src/epilot/models/operations/patchentity.py @@ -10,24 +10,24 @@ class PatchEntityRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Entity Id""" - request_body: dict[str, Any] = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) + r"""Entity Id""" + request_body: dict[str, Any] = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Schema""" + r"""Entity Schema""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) - r"""Activity to include in event feed""" + r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) - r"""Don't wait for the patch entity to become available in Search API. Useful for large migrations""" + r"""Don't wait for the patch entity to become available in Search API. Useful for large migrations""" dry_run: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'dry_run', 'style': 'form', 'explode': True }}) - r"""Dry Run mode = returns the patch result but doesn't perform the patch.""" + r"""Dry Run mode = returns the patch result but doesn't perform the patch.""" @dataclasses.dataclass class PatchEntityResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) - r"""Entity was updated""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Entity was updated""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/putschema.py b/entity/src/epilot/models/operations/putschema.py index 3d4303034..967074aca 100755 --- a/entity/src/epilot/models/operations/putschema.py +++ b/entity/src/epilot/models/operations/putschema.py @@ -11,17 +11,17 @@ @dataclasses.dataclass class PutSchemaRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - draft: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'draft', 'style': 'form', 'explode': True }}) - entity_schema: Optional[shared_entityschema.EntitySchema] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + draft: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'draft', 'style': 'form', 'explode': True }}) + entity_schema: Optional[shared_entityschema.EntitySchema] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @dataclasses.dataclass class PutSchemaResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() entity_schema_item: Optional[shared_entityschemaitem.EntitySchemaItem] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/searchentities.py b/entity/src/epilot/models/operations/searchentities.py index fcfa66037..6abecb5ea 100755 --- a/entity/src/epilot/models/operations/searchentities.py +++ b/entity/src/epilot/models/operations/searchentities.py @@ -10,11 +10,11 @@ @dataclasses.dataclass class SearchEntitiesResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() entity_search_results: Optional[shared_entitysearchresults.EntitySearchResults] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) search_entities_200_text_csv_string: Optional[str] = dataclasses.field(default=None) - r"""Success""" + r"""Success""" \ No newline at end of file diff --git a/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py b/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py index da647f8b9..0f41b3622 100755 --- a/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py +++ b/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py @@ -13,15 +13,15 @@ @dataclasses.dataclass class TaxonomiesClassificationsSearchRequestBody: - classification_ids: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classificationIds'), 'exclude': lambda f: f is None }}) + classification_ids: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classificationIds'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class TaxonomiesClassificationsSearchRequest: taxonomy_slug: str = dataclasses.field(metadata={'query_param': { 'field_name': 'taxonomySlug', 'style': 'form', 'explode': True }}) - r"""Taxonomy slug""" - request_body: Optional[TaxonomiesClassificationsSearchRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + r"""Taxonomy slug""" + request_body: Optional[TaxonomiesClassificationsSearchRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @dataclass_json(undefined=Undefined.EXCLUDE) @@ -29,15 +29,15 @@ class TaxonomiesClassificationsSearchRequest: class TaxonomiesClassificationsSearch200ApplicationJSON: r"""Returns list of taxonomy classifications""" - results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class TaxonomiesClassificationsSearchResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) taxonomies_classifications_search_200_application_json_object: Optional[TaxonomiesClassificationsSearch200ApplicationJSON] = dataclasses.field(default=None) - r"""Returns list of taxonomy classifications""" + r"""Returns list of taxonomy classifications""" \ No newline at end of file diff --git a/entity/src/epilot/models/operations/taxonomyautocomplete.py b/entity/src/epilot/models/operations/taxonomyautocomplete.py index 93ec92414..1586e1622 100755 --- a/entity/src/epilot/models/operations/taxonomyautocomplete.py +++ b/entity/src/epilot/models/operations/taxonomyautocomplete.py @@ -13,11 +13,11 @@ class TaxonomyAutocompleteRequest: taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) - r"""Limit results to slug""" + r"""Limit results to slug""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) - r"""Input to autocomplete""" + r"""Input to autocomplete""" size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) - r"""Minimum number of results to return""" + r"""Minimum number of results to return""" @dataclass_json(undefined=Undefined.EXCLUDE) @@ -25,15 +25,15 @@ class TaxonomyAutocompleteRequest: class TaxonomyAutocomplete200ApplicationJSON: r"""Taxonomy classifications""" - results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class TaxonomyAutocompleteResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) taxonomy_autocomplete_200_application_json_object: Optional[TaxonomyAutocomplete200ApplicationJSON] = dataclasses.field(default=None) - r"""Taxonomy classifications""" + r"""Taxonomy classifications""" \ No newline at end of file diff --git a/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py b/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py index d896cd4db..0f48510b0 100755 --- a/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py +++ b/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py @@ -14,8 +14,8 @@ class UpdateClassificationsForTaxonomyRequest: taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) - r"""Taxonomy slug""" - classifications_update: Optional[shared_classificationsupdate.ClassificationsUpdate] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + r"""Taxonomy slug""" + classifications_update: Optional[shared_classificationsupdate.ClassificationsUpdate] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @dataclass_json(undefined=Undefined.EXCLUDE) @@ -23,17 +23,17 @@ class UpdateClassificationsForTaxonomyRequest: class UpdateClassificationsForTaxonomy200ApplicationJSON: r"""Taxonomies classifications""" - created: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created'), 'exclude': lambda f: f is None }}) - deleted: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deleted'), 'exclude': lambda f: f is None }}) - updated: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated'), 'exclude': lambda f: f is None }}) + created: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created'), 'exclude': lambda f: f is None }}) + deleted: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deleted'), 'exclude': lambda f: f is None }}) + updated: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class UpdateClassificationsForTaxonomyResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) update_classifications_for_taxonomy_200_application_json_object: Optional[UpdateClassificationsForTaxonomy200ApplicationJSON] = dataclasses.field(default=None) - r"""Taxonomies classifications""" + r"""Taxonomies classifications""" \ No newline at end of file diff --git a/entity/src/epilot/models/operations/updateentity.py b/entity/src/epilot/models/operations/updateentity.py index 6694cb83e..cfac0a796 100755 --- a/entity/src/epilot/models/operations/updateentity.py +++ b/entity/src/epilot/models/operations/updateentity.py @@ -10,22 +10,22 @@ class UpdateEntityRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Entity id""" + r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Type""" + r"""Entity Type""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) - r"""Activity to include in event feed""" + r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) - r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" - request_body: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" + request_body: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @dataclasses.dataclass class UpdateEntityResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) - r"""Success""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/operations/updaterelation.py b/entity/src/epilot/models/operations/updaterelation.py index 2a087ea36..fc397ac49 100755 --- a/entity/src/epilot/models/operations/updaterelation.py +++ b/entity/src/epilot/models/operations/updaterelation.py @@ -13,31 +13,31 @@ @dataclasses.dataclass class UpdateRelationRequestBody: - tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) + tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) @dataclasses.dataclass class UpdateRelationRequest: attribute: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attribute', 'style': 'simple', 'explode': False }}) - r"""The attribute that express meaning""" + r"""The attribute that express meaning""" entity_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'entity_id', 'style': 'simple', 'explode': False }}) - r"""The attribute that express meaning""" + r"""The attribute that express meaning""" id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Entity id""" + r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Type""" + r"""Entity Type""" async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) - r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" - request_body: Optional[UpdateRelationRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" + request_body: Optional[UpdateRelationRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @dataclasses.dataclass class UpdateRelationResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) relation_item: Optional[shared_relationitem.RelationItem] = dataclasses.field(default=None) - r"""Success""" + r"""Success""" \ No newline at end of file diff --git a/entity/src/epilot/models/operations/updatesavedview.py b/entity/src/epilot/models/operations/updatesavedview.py index 108d00cfe..edd752804 100755 --- a/entity/src/epilot/models/operations/updatesavedview.py +++ b/entity/src/epilot/models/operations/updatesavedview.py @@ -12,16 +12,16 @@ class UpdateSavedViewRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""View id""" - saved_view: Optional[shared_savedview.SavedView] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + r"""View id""" + saved_view: Optional[shared_savedview.SavedView] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @dataclasses.dataclass class UpdateSavedViewResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) saved_view_item: Optional[shared_savedviewitem.SavedViewItem] = dataclasses.field(default=None) - r"""Success""" + r"""Success""" \ No newline at end of file diff --git a/entity/src/epilot/models/operations/upsertentity.py b/entity/src/epilot/models/operations/upsertentity.py index 4a71ecaa6..ab5ca3c27 100755 --- a/entity/src/epilot/models/operations/upsertentity.py +++ b/entity/src/epilot/models/operations/upsertentity.py @@ -12,30 +12,30 @@ @dataclasses.dataclass class UpsertEntityRequestBody: - entity: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity') }}) - unique_key: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unique_key') }}) + entity: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity') }}) + unique_key: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unique_key') }}) @dataclasses.dataclass class UpsertEntityRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Schema""" + r"""Entity Schema""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) - r"""Activity to include in event feed""" + r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) - r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" + r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" dry_run: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'dry_run', 'style': 'form', 'explode': True }}) - r"""Dry Run mode = return matched entities but don't update them.""" - request_body: Optional[UpsertEntityRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + r"""Dry Run mode = return matched entities but don't update them.""" + request_body: Optional[UpsertEntityRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @dataclasses.dataclass class UpsertEntityResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) - r"""Entity was updated""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Entity was updated""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index f60cdfc56..48491c7f6 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -54,4 +54,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeTypeEnum","AutomationAttribute","AutomationAttributeTypeEnum","BooleanAttribute","BooleanAttributeTypeEnum","ClassificationsUpdate","ComputedAttribute","ComputedAttributeTypeEnum","ConsentAttribute","ConsentAttributeTypeEnum","CountryAttribute","CountryAttributeTypeEnum","CurrencyAttribute","CurrencyAttributeCurrency1","CurrencyAttributeTypeEnum","DateAttribute","DateAttributeTypeEnum","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewTypeEnum","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewTypeEnum","EntityDefaultTable","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1TypeEnum","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2TypeEnum","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableViewTypeEnum","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperationEnum","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigSharing","EntitySchemaUIConfig","EntitySchemaUIConfigListItem","EntitySchemaUIConfigSharing","EntitySearchParams","EntitySearchResults","EntityViewDisabled","EntityViewDisabledViewTypeEnum","FileAttribute","FileAttributeDefaultAccessControlEnum","FileAttributeTypeEnum","GetRelationsResp","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeTypeEnum","InternalUserAttribute","InternalUserAttributeTypeEnum","InvitationEmailAttribute","InvitationEmailAttributeTypeEnum","LinkAttribute","LinkAttributeTypeEnum","MultiSelectAttribute","MultiSelectAttributeOptions2","MultiSelectAttributeTypeEnum","NumberAttribute","NumberAttributeTypeEnum","OrderedListAttribute","OrderedListAttributeTypeEnum","PartnerStatusAttribute","PartnerStatusAttributeTypeEnum","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeTypeEnum","PurposeAttribute","PurposeAttributeTypeEnum","RedirectEntityView","RedirectEntityViewViewTypeEnum","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionTypeEnum","RelationAttributeDrawerSizeEnum","RelationAttributeEditModeEnum","RelationAttributeRelationAffinityModeEnum","RelationAttributeRelationTypeEnum","RelationAttributeTypeEnum","RelationItem","RepeatableAttribute","RepeatableAttributeRelationAffinityModeEnum","RepeatableAttributeTypeEnum","SavedView","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsTypeEnum","Security","SelectAttribute","SelectAttributeOptions1","SelectAttributeTypeEnum","SequenceAttribute","SequenceAttributeTypeEnum","StatusAttribute","StatusAttributeOptions2","StatusAttributeTypeEnum","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeTypeEnum","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeTypeEnum","UserRelationAttribute","UserRelationAttributeTypeEnum"] +__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigSharing","EntitySchemaUIConfig","EntitySchemaUIConfigListItem","EntitySchemaUIConfigSharing","EntitySearchParams","EntitySearchResults","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsResp","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerStatusAttribute","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeInfoHelpers","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeInfoHelpers","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] diff --git a/entity/src/epilot/models/shared/activity.py b/entity/src/epilot/models/shared/activity.py index 358dd431f..d9ec57c04 100755 --- a/entity/src/epilot/models/shared/activity.py +++ b/entity/src/epilot/models/shared/activity.py @@ -12,9 +12,9 @@ class Activity: message: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message') }}) - r"""Message for activity. Supports handlebars syntax.""" + r"""Message for activity. Supports handlebars syntax.""" title: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title') }}) - r"""Title for activity. Supports handlebars syntax.""" - type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) + r"""Title for activity. Supports handlebars syntax.""" + type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/activityitem.py b/entity/src/epilot/models/shared/activityitem.py index 51170003f..7dbba6926 100755 --- a/entity/src/epilot/models/shared/activityitem.py +++ b/entity/src/epilot/models/shared/activityitem.py @@ -17,16 +17,16 @@ class ActivityItem: r"""Success""" message: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message') }}) - r"""Message for activity. Supports handlebars syntax.""" + r"""Message for activity. Supports handlebars syntax.""" title: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title') }}) - r"""Title for activity. Supports handlebars syntax.""" - type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + r"""Title for activity. Supports handlebars syntax.""" + type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_id'), 'exclude': lambda f: f is None }}) - r"""See https://github.com/ulid/spec""" - caller: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caller'), 'exclude': lambda f: f is None }}) - operations: Optional[list[shared_entityoperation.EntityOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('operations'), 'exclude': lambda f: f is None }}) + r"""See https://github.com/ulid/spec""" + caller: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caller'), 'exclude': lambda f: f is None }}) + operations: Optional[list[shared_entityoperation.EntityOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('operations'), 'exclude': lambda f: f is None }}) operations_total: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('operations_total'), 'exclude': lambda f: f is None }}) - r"""Count of total operations attached to this activity""" - payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) - timestamp: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timestamp'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + r"""Count of total operations attached to this activity""" + payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) + timestamp: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timestamp'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/addressrelationattribute.py b/entity/src/epilot/models/shared/addressrelationattribute.py index 579077a65..1dc988e75 100755 --- a/entity/src/epilot/models/shared/addressrelationattribute.py +++ b/entity/src/epilot/models/shared/addressrelationattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class AddressRelationAttributeTypeEnum(str, Enum): - RELATION_ADDRESS = "relation_address" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class AddressRelationAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class AddressRelationAttributeType(str, Enum): + RELATION_ADDRESS = 'relation_address' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,51 +40,50 @@ class AddressRelationAttributeTypeEnum(str, Enum): class AddressRelationAttribute: r"""Reference to an address attribute of another entity""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" - has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) + r"""Which group the attribute should appear in. Accepts group ID or group name""" + has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[AddressRelationAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[AddressRelationAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[AddressRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/automationattribute.py b/entity/src/epilot/models/shared/automationattribute.py index e13f4b398..d3d2200f7 100755 --- a/entity/src/epilot/models/shared/automationattribute.py +++ b/entity/src/epilot/models/shared/automationattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class AutomationAttributeTypeEnum(str, Enum): - AUTOMATION = "automation" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class AutomationAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class AutomationAttributeType(str, Enum): + AUTOMATION = 'automation' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,50 +40,49 @@ class AutomationAttributeTypeEnum(str, Enum): class AutomationAttribute: r"""Automation entity""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[AutomationAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[AutomationAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[AutomationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/booleanattribute.py b/entity/src/epilot/models/shared/booleanattribute.py index 1f10155ec..5c76d0a4b 100755 --- a/entity/src/epilot/models/shared/booleanattribute.py +++ b/entity/src/epilot/models/shared/booleanattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class BooleanAttributeTypeEnum(str, Enum): - BOOLEAN = "boolean" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class BooleanAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class BooleanAttributeType(str, Enum): + BOOLEAN = 'boolean' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,50 +40,49 @@ class BooleanAttributeTypeEnum(str, Enum): class BooleanAttribute: r"""Yes / No Toggle""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[BooleanAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[BooleanAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[BooleanAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/classificationsupdate.py b/entity/src/epilot/models/shared/classificationsupdate.py index 555d7e3da..9318a95db 100755 --- a/entity/src/epilot/models/shared/classificationsupdate.py +++ b/entity/src/epilot/models/shared/classificationsupdate.py @@ -12,7 +12,7 @@ @dataclasses.dataclass class ClassificationsUpdate: - create: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create'), 'exclude': lambda f: f is None }}) - delete: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('delete'), 'exclude': lambda f: f is None }}) - update: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('update'), 'exclude': lambda f: f is None }}) + create: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create'), 'exclude': lambda f: f is None }}) + delete: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('delete'), 'exclude': lambda f: f is None }}) + update: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('update'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/computedattribute.py b/entity/src/epilot/models/shared/computedattribute.py index 3e06d0228..4286d21e4 100755 --- a/entity/src/epilot/models/shared/computedattribute.py +++ b/entity/src/epilot/models/shared/computedattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class ComputedAttributeTypeEnum(str, Enum): - COMPUTED = "computed" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class ComputedAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class ComputedAttributeType(str, Enum): + COMPUTED = 'computed' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,50 +40,49 @@ class ComputedAttributeTypeEnum(str, Enum): class ComputedAttribute: r"""An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes)""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[ComputedAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[ComputedAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[ComputedAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/consentattribute.py b/entity/src/epilot/models/shared/consentattribute.py index ac604395e..d97a6fad9 100755 --- a/entity/src/epilot/models/shared/consentattribute.py +++ b/entity/src/epilot/models/shared/consentattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class ConsentAttributeTypeEnum(str, Enum): - CONSENT = "consent" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class ConsentAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class ConsentAttributeType(str, Enum): + CONSENT = 'consent' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,52 +40,51 @@ class ConsentAttributeTypeEnum(str, Enum): class ConsentAttribute: r"""Consent Management""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - topic: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('topic') }}) - type: ConsentAttributeTypeEnum = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + topic: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('topic') }}) + type: ConsentAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - identifiers: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('identifiers'), 'exclude': lambda f: f is None }}) - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + identifiers: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('identifiers'), 'exclude': lambda f: f is None }}) + info_helpers: Optional[ConsentAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/countryattribute.py b/entity/src/epilot/models/shared/countryattribute.py index 55cfaf330..cc35f9eb3 100755 --- a/entity/src/epilot/models/shared/countryattribute.py +++ b/entity/src/epilot/models/shared/countryattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class CountryAttributeTypeEnum(str, Enum): - COUNTRY = "country" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class CountryAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class CountryAttributeType(str, Enum): + COUNTRY = 'country' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,50 +40,49 @@ class CountryAttributeTypeEnum(str, Enum): class CountryAttribute: r"""Country picker""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[CountryAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[CountryAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[CountryAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/currencyattribute.py b/entity/src/epilot/models/shared/currencyattribute.py index 04a0e77c8..347e3d736 100755 --- a/entity/src/epilot/models/shared/currencyattribute.py +++ b/entity/src/epilot/models/shared/currencyattribute.py @@ -13,13 +13,37 @@ class CurrencyAttributeCurrency1: r"""A currency configuration""" - code: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('code') }}) - description: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) - symbol: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('symbol') }}) - flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('flag'), 'exclude': lambda f: f is None }}) + code: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('code') }}) + description: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) + symbol: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('symbol') }}) + flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('flag'), 'exclude': lambda f: f is None }}) -class CurrencyAttributeTypeEnum(str, Enum): - CURRENCY = "currency" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class CurrencyAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class CurrencyAttributeType(str, Enum): + CURRENCY = 'currency' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -28,52 +52,51 @@ class CurrencyAttribute: r"""Currency input""" currency: list[Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) - r"""An array of currency configurations with a country code (ISO-4217)""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - type: CurrencyAttributeTypeEnum = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + r"""An array of currency configurations with a country code (ISO-4217)""" + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + type: CurrencyAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - currency_selector_only: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency_selector_only'), 'exclude': lambda f: f is None }}) - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + currency_selector_only: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency_selector_only'), 'exclude': lambda f: f is None }}) + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[CurrencyAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/dateattribute.py b/entity/src/epilot/models/shared/dateattribute.py index dde650479..1a893f8a9 100755 --- a/entity/src/epilot/models/shared/dateattribute.py +++ b/entity/src/epilot/models/shared/dateattribute.py @@ -7,9 +7,33 @@ from epilot import utils from typing import Any, Optional -class DateAttributeTypeEnum(str, Enum): - DATE = "date" - DATETIME = "datetime" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class DateAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class DateAttributeType(str, Enum): + DATE = 'date' + DATETIME = 'datetime' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -17,50 +41,49 @@ class DateAttributeTypeEnum(str, Enum): class DateAttribute: r"""Date or Datetime picker""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[DateAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[DateAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[DateAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entitycapability.py b/entity/src/epilot/models/shared/entitycapability.py index 9bb84934d..b8aeac623 100755 --- a/entity/src/epilot/models/shared/entitycapability.py +++ b/entity/src/epilot/models/shared/entitycapability.py @@ -13,16 +13,16 @@ class EntityCapability: r"""Capabilities the Entity has. Turn features on/off for entities.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""Unique name for the capability""" - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes'), 'exclude': lambda f: f is None }}) + r"""Unique name for the capability""" + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes'), 'exclude': lambda f: f is None }}) feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This capability should only be active when the feature flag is enabled""" + r"""This capability should only be active when the feature flag is enabled""" legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) - r"""Only show capability for legacy tenants (ivy)""" + r"""Only show capability for legacy tenants (ivy)""" setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This capability should only be active when the setting is enabled""" + r"""This capability should only be active when the setting is enabled""" title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) - r"""Human readable title of the capability""" - ui_hooks: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_hooks'), 'exclude': lambda f: f is None }}) + r"""Human readable title of the capability""" + ui_hooks: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_hooks'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entitydefaultcreate.py b/entity/src/epilot/models/shared/entitydefaultcreate.py index c51a74d4b..38527bc36 100755 --- a/entity/src/epilot/models/shared/entitydefaultcreate.py +++ b/entity/src/epilot/models/shared/entitydefaultcreate.py @@ -12,18 +12,18 @@ @dataclasses.dataclass class EntityDefaultCreateTableMenuOptions: - icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) - label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label'), 'exclude': lambda f: f is None }}) + icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) + label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label'), 'exclude': lambda f: f is None }}) -class EntityDefaultCreateViewTypeEnum(str, Enum): - DEFAULT = "default" +class EntityDefaultCreateViewType(str, Enum): + DEFAULT = 'default' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityDefaultCreate: - search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) - table_menu_options: Optional[EntityDefaultCreateTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) - view_type: Optional[EntityDefaultCreateViewTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) + table_menu_options: Optional[EntityDefaultCreateTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) + view_type: Optional[EntityDefaultCreateViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entitydefaultedit.py b/entity/src/epilot/models/shared/entitydefaultedit.py index ae1ced155..e5219557d 100755 --- a/entity/src/epilot/models/shared/entitydefaultedit.py +++ b/entity/src/epilot/models/shared/entitydefaultedit.py @@ -12,18 +12,18 @@ @dataclasses.dataclass class EntityDefaultEditTableMenuOptions: - icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) - label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label'), 'exclude': lambda f: f is None }}) + icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) + label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label'), 'exclude': lambda f: f is None }}) -class EntityDefaultEditViewTypeEnum(str, Enum): - DEFAULT = "default" +class EntityDefaultEditViewType(str, Enum): + DEFAULT = 'default' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityDefaultEdit: - search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) - table_menu_options: Optional[EntityDefaultEditTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) - view_type: Optional[EntityDefaultEditViewTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) + table_menu_options: Optional[EntityDefaultEditTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) + view_type: Optional[EntityDefaultEditViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py index fcf70f4df..b439daf6a 100755 --- a/entity/src/epilot/models/shared/entitydefaulttable.py +++ b/entity/src/epilot/models/shared/entitydefaulttable.py @@ -7,8 +7,8 @@ from epilot import utils from typing import Any, Optional -class EntityDefaultTableDropdownItems2TypeEnum(str, Enum): - LINK = "link" +class EntityDefaultTableDropdownItems2Type(str, Enum): + LINK = 'link' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,15 +16,15 @@ class EntityDefaultTableDropdownItems2TypeEnum(str, Enum): class EntityDefaultTableDropdownItems2: feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This dropdown item should only be active when the feature flag is enabled""" + r"""This dropdown item should only be active when the feature flag is enabled""" legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) - r"""Only show item for legacy tenants (ivy)""" - title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) - type: Optional[EntityDefaultTableDropdownItems2TypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('uri'), 'exclude': lambda f: f is None }}) + r"""Only show item for legacy tenants (ivy)""" + title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) + type: Optional[EntityDefaultTableDropdownItems2Type] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('uri'), 'exclude': lambda f: f is None }}) -class EntityDefaultTableDropdownItems1TypeEnum(str, Enum): - ENTITY = "entity" +class EntityDefaultTableDropdownItems1Type(str, Enum): + ENTITY = 'entity' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -32,42 +32,42 @@ class EntityDefaultTableDropdownItems1TypeEnum(str, Enum): class EntityDefaultTableDropdownItems1: entity: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity'), 'exclude': lambda f: f is None }}) - r"""URL-friendly identifier for the entity schema""" + r"""URL-friendly identifier for the entity schema""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This dropdown item should only be active when the feature flag is enabled""" + r"""This dropdown item should only be active when the feature flag is enabled""" legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) - r"""Only show item for legacy tenants (ivy)""" - type: Optional[EntityDefaultTableDropdownItems1TypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + r"""Only show item for legacy tenants (ivy)""" + type: Optional[EntityDefaultTableDropdownItems1Type] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityDefaultTableNavbarActionsOptions: - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - params: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('params'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + params: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('params'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityDefaultTableNavbarActions: - type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - options: Optional[list[EntityDefaultTableNavbarActionsOptions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + options: Optional[list[EntityDefaultTableNavbarActionsOptions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) -class EntityDefaultTableViewTypeEnum(str, Enum): - DEFAULT = "default" +class EntityDefaultTableViewType(str, Enum): + DEFAULT = 'default' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityDefaultTable: - classic_view: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classic_view'), 'exclude': lambda f: f is None }}) - dropdown_items: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dropdown_items'), 'exclude': lambda f: f is None }}) + classic_view: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classic_view'), 'exclude': lambda f: f is None }}) + dropdown_items: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dropdown_items'), 'exclude': lambda f: f is None }}) enable_thumbnails: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_thumbnails'), 'exclude': lambda f: f is None }}) - r"""Enable the thumbnail column""" - navbar_actions: Optional[list[EntityDefaultTableNavbarActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('navbar_actions'), 'exclude': lambda f: f is None }}) - row_actions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('row_actions'), 'exclude': lambda f: f is None }}) - view_type: Optional[EntityDefaultTableViewTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + r"""Enable the thumbnail column""" + navbar_actions: Optional[list[EntityDefaultTableNavbarActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('navbar_actions'), 'exclude': lambda f: f is None }}) + row_actions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('row_actions'), 'exclude': lambda f: f is None }}) + view_type: Optional[EntityDefaultTableViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entityimportparams.py b/entity/src/epilot/models/shared/entityimportparams.py index 5e619c841..a5a25eca7 100755 --- a/entity/src/epilot/models/shared/entityimportparams.py +++ b/entity/src/epilot/models/shared/entityimportparams.py @@ -9,15 +9,21 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityImportParamsS3Reference: + r"""The S3 bucket and key where the JSON file for import is located.""" - bucket: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bucket') }}) - key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key') }}) + bucket: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bucket') }}) + r"""The name of the S3 bucket where the JSON file for import is stored.""" + key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key') }}) + r"""The key or path to the JSON file within the S3 bucket.""" @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityImportParams: + r"""The parameters for importing entities.""" - s3_reference: EntityImportParamsS3Reference = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('S3Reference') }}) - schema: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schema') }}) + s3_reference: EntityImportParamsS3Reference = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('S3Reference') }}) + r"""The S3 bucket and key where the JSON file for import is located.""" + schema: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schema') }}) + r"""The schema of the entities being imported. This must match the schema of the entities on the platform.""" \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entityoperation.py b/entity/src/epilot/models/shared/entityoperation.py index d8cf521cd..5fb7b3834 100755 --- a/entity/src/epilot/models/shared/entityoperation.py +++ b/entity/src/epilot/models/shared/entityoperation.py @@ -12,35 +12,35 @@ @dataclasses.dataclass class EntityOperationDiff: - added: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('added'), 'exclude': lambda f: f is None }}) - deleted: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deleted'), 'exclude': lambda f: f is None }}) - updated: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated'), 'exclude': lambda f: f is None }}) + added: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('added'), 'exclude': lambda f: f is None }}) + deleted: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deleted'), 'exclude': lambda f: f is None }}) + updated: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated'), 'exclude': lambda f: f is None }}) -class EntityOperationOperationEnum(str, Enum): - CREATE_ENTITY = "createEntity" - UPDATE_ENTITY = "updateEntity" - DELETE_ENTITY = "deleteEntity" +class EntityOperationOperation(str, Enum): + CREATE_ENTITY = 'createEntity' + UPDATE_ENTITY = 'updateEntity' + DELETE_ENTITY = 'deleteEntity' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityOperationParams: - id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) slug: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug'), 'exclude': lambda f: f is None }}) - r"""URL-friendly identifier for the entity schema""" + r"""URL-friendly identifier for the entity schema""" @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityOperation: - entity: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity') }}) - operation: EntityOperationOperationEnum = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('operation') }}) - org: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org') }}) + entity: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity') }}) + operation: EntityOperationOperation = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('operation') }}) + org: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org') }}) activity_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('activity_id'), 'exclude': lambda f: f is None }}) - r"""See https://github.com/ulid/spec""" - diff: Optional[EntityOperationDiff] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('diff'), 'exclude': lambda f: f is None }}) - params: Optional[EntityOperationParams] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('params'), 'exclude': lambda f: f is None }}) - payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) + r"""See https://github.com/ulid/spec""" + diff: Optional[EntityOperationDiff] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('diff'), 'exclude': lambda f: f is None }}) + params: Optional[EntityOperationParams] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('params'), 'exclude': lambda f: f is None }}) + payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entityschema.py b/entity/src/epilot/models/shared/entityschema.py index 93be2f7a4..7786a3631 100755 --- a/entity/src/epilot/models/shared/entityschema.py +++ b/entity/src/epilot/models/shared/entityschema.py @@ -13,33 +13,33 @@ @dataclasses.dataclass class EntitySchemaGroupSettingsInfoTooltipTitle: - default: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default'), 'exclude': lambda f: f is None }}) - key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key'), 'exclude': lambda f: f is None }}) + default: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default'), 'exclude': lambda f: f is None }}) + key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaGroupSettings: - id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - expanded: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('expanded'), 'exclude': lambda f: f is None }}) + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + expanded: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('expanded'), 'exclude': lambda f: f is None }}) feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This group should only be active when the feature flag is enabled""" - info_tooltip_title: Optional[EntitySchemaGroupSettingsInfoTooltipTitle] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_tooltip_title'), 'exclude': lambda f: f is None }}) + r"""This group should only be active when the feature flag is enabled""" + info_tooltip_title: Optional[EntitySchemaGroupSettingsInfoTooltipTitle] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_tooltip_title'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Render order of the group""" - render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) + r"""Render order of the group""" + render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This group should only be active when the setting is enabled""" + r"""This group should only be active when the setting is enabled""" @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaUIConfigListItem: - summary_attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) + summary_attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @@ -47,58 +47,55 @@ class EntitySchemaUIConfigListItem: class EntitySchemaUIConfigSharing: show_sharing_button: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_sharing_button'), 'exclude': lambda f: f is None }}) - r"""Show the sharing button in entity detail view""" + r"""Show the sharing button in entity detail view""" @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaUIConfig: - create_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) - edit_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_view'), 'exclude': lambda f: f is None }}) - list_item: Optional[EntitySchemaUIConfigListItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('list_item'), 'exclude': lambda f: f is None }}) - sharing: Optional[EntitySchemaUIConfigSharing] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sharing'), 'exclude': lambda f: f is None }}) - single_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('single_view'), 'exclude': lambda f: f is None }}) - table_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_view'), 'exclude': lambda f: f is None }}) + create_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) + edit_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_view'), 'exclude': lambda f: f is None }}) + list_item: Optional[EntitySchemaUIConfigListItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('list_item'), 'exclude': lambda f: f is None }}) + sharing: Optional[EntitySchemaUIConfigSharing] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sharing'), 'exclude': lambda f: f is None }}) + single_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('single_view'), 'exclude': lambda f: f is None }}) + table_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_view'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchema: - r"""The \"type\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.""" + r"""The \\"type\\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.""" + attributes: list[Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) + r"""An ordered list of attributes the entity contains""" + capabilities: list[shared_entitycapability.EntityCapability] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""User-friendly identifier for the entity schema""" - plural: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plural') }}) + r"""User-friendly identifier for the entity schema""" + plural: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plural') }}) slug: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) - r"""URL-friendly identifier for the entity schema""" - attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes'), 'exclude': lambda f: f is None }}) - r"""An ordered list of attributes the entity contains""" + r"""URL-friendly identifier for the entity schema""" blueprint: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('blueprint'), 'exclude': lambda f: f is None }}) - r"""Reference to blueprint""" - capabilities: Optional[list[shared_entitycapability.EntityCapability]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities'), 'exclude': lambda f: f is None }}) - dialog_config: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dialog_config'), 'exclude': lambda f: f is None }}) - draft: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('draft'), 'exclude': lambda f: f is None }}) + r"""Reference to blueprint""" + dialog_config: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dialog_config'), 'exclude': lambda f: f is None }}) + draft: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('draft'), 'exclude': lambda f: f is None }}) enable_setting: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_setting'), 'exclude': lambda f: f is None }}) - r"""This schema should only be active when one of the organization settings is enabled""" + r"""This schema should only be active when one of the organization settings is enabled""" explicit_search_mappings: Optional[dict[str, shared_searchmappings.SearchMappings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('explicit_search_mappings'), 'exclude': lambda f: f is None }}) - r"""Advanced: explicit Elasticsearch index mapping definitions for entity data - - """ + r"""Advanced: explicit Elasticsearch index mapping definitions for entity data""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This schema should only be active when the feature flag is enabled""" + r"""This schema should only be active when the feature flag is enabled""" group_settings: Optional[list[EntitySchemaGroupSettings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group_settings'), 'exclude': lambda f: f is None }}) - r"""A dictionary of Group Titles and associated settings if present.""" - icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) + r"""A dictionary of Group Titles and associated settings if present.""" + icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) layout_settings: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout_settings'), 'exclude': lambda f: f is None }}) r"""Custom grid definitions for the layout. These settings are composed by managed and un-managed properties: - Managed Properties: are interpreted and transformed into layout styles - Un-managed Properties: are appended as styles into the attribute mounting node - - """ - published: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('published'), 'exclude': lambda f: f is None }}) + """ + published: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('published'), 'exclude': lambda f: f is None }}) title_template: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title_template'), 'exclude': lambda f: f is None }}) - r"""Template for rendering the title field. Uses handlebars""" - ui_config: Optional[EntitySchemaUIConfig] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config'), 'exclude': lambda f: f is None }}) - version: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('version'), 'exclude': lambda f: f is None }}) + r"""Template for rendering the title field. Uses handlebars""" + ui_config: Optional[EntitySchemaUIConfig] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config'), 'exclude': lambda f: f is None }}) + version: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('version'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entityschemaitem.py b/entity/src/epilot/models/shared/entityschemaitem.py index db534e35e..ac8ec297a 100755 --- a/entity/src/epilot/models/shared/entityschemaitem.py +++ b/entity/src/epilot/models/shared/entityschemaitem.py @@ -13,41 +13,41 @@ @dataclasses.dataclass class EntitySchemaItemGroupSettingsInfoTooltipTitle: - default: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default'), 'exclude': lambda f: f is None }}) - key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key'), 'exclude': lambda f: f is None }}) + default: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default'), 'exclude': lambda f: f is None }}) + key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaItemGroupSettings: - id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - expanded: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('expanded'), 'exclude': lambda f: f is None }}) + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + expanded: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('expanded'), 'exclude': lambda f: f is None }}) feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This group should only be active when the feature flag is enabled""" - info_tooltip_title: Optional[EntitySchemaItemGroupSettingsInfoTooltipTitle] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_tooltip_title'), 'exclude': lambda f: f is None }}) + r"""This group should only be active when the feature flag is enabled""" + info_tooltip_title: Optional[EntitySchemaItemGroupSettingsInfoTooltipTitle] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_tooltip_title'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Render order of the group""" - render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) + r"""Render order of the group""" + render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This group should only be active when the setting is enabled""" + r"""This group should only be active when the setting is enabled""" @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaItemSource: - id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) - type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaItemUIConfigListItem: - summary_attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) + summary_attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @@ -55,64 +55,61 @@ class EntitySchemaItemUIConfigListItem: class EntitySchemaItemUIConfigSharing: show_sharing_button: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_sharing_button'), 'exclude': lambda f: f is None }}) - r"""Show the sharing button in entity detail view""" + r"""Show the sharing button in entity detail view""" @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaItemUIConfig: - create_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) - edit_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_view'), 'exclude': lambda f: f is None }}) - list_item: Optional[EntitySchemaItemUIConfigListItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('list_item'), 'exclude': lambda f: f is None }}) - sharing: Optional[EntitySchemaItemUIConfigSharing] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sharing'), 'exclude': lambda f: f is None }}) - single_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('single_view'), 'exclude': lambda f: f is None }}) - table_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_view'), 'exclude': lambda f: f is None }}) + create_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) + edit_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_view'), 'exclude': lambda f: f is None }}) + list_item: Optional[EntitySchemaItemUIConfigListItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('list_item'), 'exclude': lambda f: f is None }}) + sharing: Optional[EntitySchemaItemUIConfigSharing] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sharing'), 'exclude': lambda f: f is None }}) + single_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('single_view'), 'exclude': lambda f: f is None }}) + table_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_view'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaItem: - r"""The \"type\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.""" + r"""The \\"type\\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.""" + attributes: list[Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) + r"""An ordered list of attributes the entity contains""" + capabilities: list[shared_entitycapability.EntityCapability] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""User-friendly identifier for the entity schema""" - plural: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plural') }}) + r"""User-friendly identifier for the entity schema""" + plural: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plural') }}) slug: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) - r"""URL-friendly identifier for the entity schema""" - attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes'), 'exclude': lambda f: f is None }}) - r"""An ordered list of attributes the entity contains""" + r"""URL-friendly identifier for the entity schema""" blueprint: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('blueprint'), 'exclude': lambda f: f is None }}) - r"""Reference to blueprint""" - capabilities: Optional[list[shared_entitycapability.EntityCapability]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities'), 'exclude': lambda f: f is None }}) - comment: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('comment'), 'exclude': lambda f: f is None }}) - created_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'exclude': lambda f: f is None }}) - dialog_config: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dialog_config'), 'exclude': lambda f: f is None }}) - draft: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('draft'), 'exclude': lambda f: f is None }}) + r"""Reference to blueprint""" + comment: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('comment'), 'exclude': lambda f: f is None }}) + created_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'exclude': lambda f: f is None }}) + dialog_config: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dialog_config'), 'exclude': lambda f: f is None }}) + draft: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('draft'), 'exclude': lambda f: f is None }}) enable_setting: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_setting'), 'exclude': lambda f: f is None }}) - r"""This schema should only be active when one of the organization settings is enabled""" + r"""This schema should only be active when one of the organization settings is enabled""" explicit_search_mappings: Optional[dict[str, shared_searchmappings.SearchMappings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('explicit_search_mappings'), 'exclude': lambda f: f is None }}) - r"""Advanced: explicit Elasticsearch index mapping definitions for entity data - - """ + r"""Advanced: explicit Elasticsearch index mapping definitions for entity data""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This schema should only be active when the feature flag is enabled""" + r"""This schema should only be active when the feature flag is enabled""" group_settings: Optional[list[EntitySchemaItemGroupSettings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group_settings'), 'exclude': lambda f: f is None }}) - r"""A dictionary of Group Titles and associated settings if present.""" - icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) + r"""A dictionary of Group Titles and associated settings if present.""" + icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) - r"""Generated uuid for schema""" + r"""Generated uuid for schema""" layout_settings: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout_settings'), 'exclude': lambda f: f is None }}) r"""Custom grid definitions for the layout. These settings are composed by managed and un-managed properties: - Managed Properties: are interpreted and transformed into layout styles - Un-managed Properties: are appended as styles into the attribute mounting node - - """ - published: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('published'), 'exclude': lambda f: f is None }}) - source: Optional[EntitySchemaItemSource] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('source'), 'exclude': lambda f: f is None }}) + """ + published: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('published'), 'exclude': lambda f: f is None }}) + source: Optional[EntitySchemaItemSource] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('source'), 'exclude': lambda f: f is None }}) title_template: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title_template'), 'exclude': lambda f: f is None }}) - r"""Template for rendering the title field. Uses handlebars""" - ui_config: Optional[EntitySchemaItemUIConfig] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config'), 'exclude': lambda f: f is None }}) - updated_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'exclude': lambda f: f is None }}) - version: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('version'), 'exclude': lambda f: f is None }}) + r"""Template for rendering the title field. Uses handlebars""" + ui_config: Optional[EntitySchemaItemUIConfig] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config'), 'exclude': lambda f: f is None }}) + updated_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'exclude': lambda f: f is None }}) + version: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('version'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entitysearchparams.py b/entity/src/epilot/models/shared/entitysearchparams.py index 5951b150c..ab19a9eab 100755 --- a/entity/src/epilot/models/shared/entitysearchparams.py +++ b/entity/src/epilot/models/shared/entitysearchparams.py @@ -12,17 +12,17 @@ class EntitySearchParams: q: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('q') }}) - r"""Lucene queries supported with ElasticSearch""" + r"""Lucene queries supported with ElasticSearch""" aggs: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggs'), 'exclude': lambda f: f is None }}) - r"""Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.""" - fields: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) - r"""List of entity fields to include in search results""" - from_: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('from'), 'exclude': lambda f: f is None }}) + r"""Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.""" + fields_: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) + r"""List of entity fields to include in search results""" + from_: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('from'), 'exclude': lambda f: f is None }}) hydrate: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hydrate'), 'exclude': lambda f: f is None }}) - r"""When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.""" + r"""When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.""" include_scores: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('include_scores'), 'exclude': lambda f: f is None }}) - r"""Adds a `_score` number field to results that can be used to rank by match score""" + r"""Adds a `_score` number field to results that can be used to rank by match score""" size: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('size'), 'exclude': lambda f: f is None }}) - r"""Max search size is 1000 with higher values defaulting to 1000""" - sort: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sort'), 'exclude': lambda f: f is None }}) + r"""Max search size is 1000 with higher values defaulting to 1000""" + sort: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sort'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entitysearchresults.py b/entity/src/epilot/models/shared/entitysearchresults.py index a80b6aaa5..32288e56a 100755 --- a/entity/src/epilot/models/shared/entitysearchresults.py +++ b/entity/src/epilot/models/shared/entitysearchresults.py @@ -12,7 +12,7 @@ class EntitySearchResults: r"""Success""" - aggregations: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggregations'), 'exclude': lambda f: f is None }}) - hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) - results: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + aggregations: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggregations'), 'exclude': lambda f: f is None }}) + hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) + results: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/entityviewdisabled.py b/entity/src/epilot/models/shared/entityviewdisabled.py index f0d0eaea5..04eb1da73 100755 --- a/entity/src/epilot/models/shared/entityviewdisabled.py +++ b/entity/src/epilot/models/shared/entityviewdisabled.py @@ -7,13 +7,13 @@ from epilot import utils from typing import Optional -class EntityViewDisabledViewTypeEnum(str, Enum): - DISABLED = "disabled" +class EntityViewDisabledViewType(str, Enum): + DISABLED = 'disabled' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityViewDisabled: - view_type: Optional[EntityViewDisabledViewTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + view_type: Optional[EntityViewDisabledViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/fileattribute.py b/entity/src/epilot/models/shared/fileattribute.py index 7893568a5..b1365f5ca 100755 --- a/entity/src/epilot/models/shared/fileattribute.py +++ b/entity/src/epilot/models/shared/fileattribute.py @@ -7,13 +7,37 @@ from epilot import utils from typing import Any, Optional -class FileAttributeDefaultAccessControlEnum(str, Enum): - PUBLIC_READ = "public-read" - PRIVATE = "private" +class FileAttributeDefaultAccessControl(str, Enum): + PUBLIC_READ = 'public-read' + PRIVATE = 'private' -class FileAttributeTypeEnum(str, Enum): - IMAGE = "image" - FILE = "file" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class FileAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class FileAttributeType(str, Enum): + IMAGE = 'image' + FILE = 'file' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -21,61 +45,59 @@ class FileAttributeTypeEnum(str, Enum): class FileAttribute: r"""File or Image Attachment""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - type: FileAttributeTypeEnum = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + type: FileAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) allowed_extensions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allowed_extensions'), 'exclude': lambda f: f is None }}) - r"""List of file extensions (without the dot suffix)""" + r"""List of file extensions (without the dot suffix)""" constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_access_control: Optional[FileAttributeDefaultAccessControlEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_access_control'), 'exclude': lambda f: f is None }}) - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_access_control: Optional[FileAttributeDefaultAccessControl] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_access_control'), 'exclude': lambda f: f is None }}) + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) display_images_landscaped: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('display_images_landscaped'), 'exclude': lambda f: f is None }}) - r"""Controls how the images are presented to the user during upload on the Entity Details view.""" + r"""Controls how the images are presented to the user during upload on the Entity Details view.""" enable_description: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_description'), 'exclude': lambda f: f is None }}) r"""When set to true, an i18n description will be used alongside the attribute label. This description should be set through the platform locales in the form: `file.{attribute_name}.description_text`. - - """ + """ entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - multiple: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('multiple'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[FileAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + multiple: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('multiple'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/getrelationsresp.py b/entity/src/epilot/models/shared/getrelationsresp.py index 4de986a05..c7c652e41 100755 --- a/entity/src/epilot/models/shared/getrelationsresp.py +++ b/entity/src/epilot/models/shared/getrelationsresp.py @@ -11,9 +11,9 @@ @dataclasses.dataclass class GetRelationsResp: - attribute: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attribute') }}) - entity_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_id') }}) - tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) + attribute: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attribute') }}) + entity_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_id') }}) + tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) reverse: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reverse'), 'exclude': lambda f: f is None }}) - r"""Whether this is a reverse relation""" + r"""Whether this is a reverse relation""" \ No newline at end of file diff --git a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py index 61d6f6340..4fe2e1548 100755 --- a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py +++ b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py @@ -12,6 +12,6 @@ class GetRelationsRespWithPagination: r"""Success""" - hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) - relations: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) + hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) + relations: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/internalattribute.py b/entity/src/epilot/models/shared/internalattribute.py index cd3c48227..659a341e5 100755 --- a/entity/src/epilot/models/shared/internalattribute.py +++ b/entity/src/epilot/models/shared/internalattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class InternalAttributeTypeEnum(str, Enum): - INTERNAL = "internal" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class InternalAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class InternalAttributeType(str, Enum): + INTERNAL = 'internal' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,50 +40,49 @@ class InternalAttributeTypeEnum(str, Enum): class InternalAttribute: r"""No UI representation""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[InternalAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[InternalAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[InternalAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/internaluserattribute.py b/entity/src/epilot/models/shared/internaluserattribute.py index 8c4b9f5b3..ecaf0d8cb 100755 --- a/entity/src/epilot/models/shared/internaluserattribute.py +++ b/entity/src/epilot/models/shared/internaluserattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class InternalUserAttributeTypeEnum(str, Enum): - INTERNAL_USER = "internal_user" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class InternalUserAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class InternalUserAttributeType(str, Enum): + INTERNAL_USER = 'internal_user' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,50 +40,49 @@ class InternalUserAttributeTypeEnum(str, Enum): class InternalUserAttribute: r"""Epilot internal user info""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[InternalUserAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[InternalUserAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[InternalUserAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/invitationemailattribute.py b/entity/src/epilot/models/shared/invitationemailattribute.py index 0229c0bef..a8ed138d0 100755 --- a/entity/src/epilot/models/shared/invitationemailattribute.py +++ b/entity/src/epilot/models/shared/invitationemailattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class InvitationEmailAttributeTypeEnum(str, Enum): - INVITATION_EMAIL = "invitation_email" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class InvitationEmailAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class InvitationEmailAttributeType(str, Enum): + INVITATION_EMAIL = 'invitation_email' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,50 +40,49 @@ class InvitationEmailAttributeTypeEnum(str, Enum): class InvitationEmailAttribute: r"""Email address for send invitation""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[InvitationEmailAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[InvitationEmailAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[InvitationEmailAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/linkattribute.py b/entity/src/epilot/models/shared/linkattribute.py index 650e8d6b4..ca6fd5370 100755 --- a/entity/src/epilot/models/shared/linkattribute.py +++ b/entity/src/epilot/models/shared/linkattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class LinkAttributeTypeEnum(str, Enum): - LINK = "link" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class LinkAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class LinkAttributeType(str, Enum): + LINK = 'link' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,50 +40,49 @@ class LinkAttributeTypeEnum(str, Enum): class LinkAttribute: r"""Link with title and href""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[LinkAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[LinkAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[LinkAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/multiselectattribute.py b/entity/src/epilot/models/shared/multiselectattribute.py index e4e28e8e5..8c1f8c7eb 100755 --- a/entity/src/epilot/models/shared/multiselectattribute.py +++ b/entity/src/epilot/models/shared/multiselectattribute.py @@ -8,16 +8,40 @@ from typing import Any, Optional +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class MultiSelectAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class MultiSelectAttributeOptions2: - value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) + value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) + title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) -class MultiSelectAttributeTypeEnum(str, Enum): - MULTISELECT = "multiselect" - CHECKBOX = "checkbox" +class MultiSelectAttributeType(str, Enum): + MULTISELECT = 'multiselect' + CHECKBOX = 'checkbox' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -25,57 +49,56 @@ class MultiSelectAttributeTypeEnum(str, Enum): class MultiSelectAttribute: r"""Multi Choice Selection""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) allow_any: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_any'), 'exclude': lambda f: f is None }}) - r"""Allow arbitrary input values in addition to provided options""" + r"""Allow arbitrary input values in addition to provided options""" allow_extra_options: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_extra_options'), 'exclude': lambda f: f is None }}) - r"""controls if the 360 ui will allow the user to enter a value which is not defined by the options""" + r"""controls if the 360 ui will allow the user to enter a value which is not defined by the options""" constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) disable_case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('disable_case_sensitive'), 'exclude': lambda f: f is None }}) - r"""controls if the matching of values against the options is case sensitive or not""" + r"""controls if the matching of values against the options is case sensitive or not""" entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[MultiSelectAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + options: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[MultiSelectAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[MultiSelectAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/numberattribute.py b/entity/src/epilot/models/shared/numberattribute.py index a4dc25dda..a5f2eaa6e 100755 --- a/entity/src/epilot/models/shared/numberattribute.py +++ b/entity/src/epilot/models/shared/numberattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class NumberAttributeTypeEnum(str, Enum): - NUMBER = "number" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class NumberAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class NumberAttributeType(str, Enum): + NUMBER = 'number' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,51 +40,50 @@ class NumberAttributeTypeEnum(str, Enum): class NumberAttribute: r"""Numeric input""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" - format: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('format'), 'exclude': lambda f: f is None }}) + r"""This attribute should only be active when the feature flag is enabled""" + format: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('format'), 'exclude': lambda f: f is None }}) group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[NumberAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[NumberAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[NumberAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/orderedlistattribute.py b/entity/src/epilot/models/shared/orderedlistattribute.py index 80a71ff5c..707cb95e0 100755 --- a/entity/src/epilot/models/shared/orderedlistattribute.py +++ b/entity/src/epilot/models/shared/orderedlistattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class OrderedListAttributeTypeEnum(str, Enum): - ORDERED_LIST = "ordered_list" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class OrderedListAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class OrderedListAttributeType(str, Enum): + ORDERED_LIST = 'ordered_list' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,50 +40,49 @@ class OrderedListAttributeTypeEnum(str, Enum): class OrderedListAttribute: r"""Type of attribute to render N number of ordered fields""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[OrderedListAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[OrderedListAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[OrderedListAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/partnerstatusattribute.py b/entity/src/epilot/models/shared/partnerstatusattribute.py index d9e381099..d9022837e 100755 --- a/entity/src/epilot/models/shared/partnerstatusattribute.py +++ b/entity/src/epilot/models/shared/partnerstatusattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class PartnerStatusAttributeTypeEnum(str, Enum): - PARTNER_STATUS = "partner_status" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class PartnerStatusAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class PartnerStatusAttributeType(str, Enum): + PARTNER_STATUS = 'partner_status' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,50 +40,49 @@ class PartnerStatusAttributeTypeEnum(str, Enum): class PartnerStatusAttribute: r"""Partner Status""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[PartnerStatusAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[PartnerStatusAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[PartnerStatusAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py index 0084656e3..e73ae6045 100755 --- a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py +++ b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class PaymentMethodRelationAttributeTypeEnum(str, Enum): - RELATION_PAYMENT_METHOD = "relation_payment_method" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class PaymentMethodRelationAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class PaymentMethodRelationAttributeType(str, Enum): + RELATION_PAYMENT_METHOD = 'relation_payment_method' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,51 +40,50 @@ class PaymentMethodRelationAttributeTypeEnum(str, Enum): class PaymentMethodRelationAttribute: r"""Reference to a payment method attribute of another entity""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" - has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) + r"""Which group the attribute should appear in. Accepts group ID or group name""" + has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[PaymentMethodRelationAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[PaymentMethodRelationAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[PaymentMethodRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/purposeattribute.py b/entity/src/epilot/models/shared/purposeattribute.py index 1f432b0d9..a63e509df 100755 --- a/entity/src/epilot/models/shared/purposeattribute.py +++ b/entity/src/epilot/models/shared/purposeattribute.py @@ -10,8 +10,32 @@ from marshmallow import fields from typing import Any, Optional -class PurposeAttributeTypeEnum(str, Enum): - PURPOSE = "purpose" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class PurposeAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class PurposeAttributeType(str, Enum): + PURPOSE = 'purpose' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -19,54 +43,53 @@ class PurposeAttributeTypeEnum(str, Enum): class PurposeAttribute: r"""Entity Taxonomy""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + info_helpers: Optional[PurposeAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - parents: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + parents: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[PurposeAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[PurposeAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/redirectentityview.py b/entity/src/epilot/models/shared/redirectentityview.py index 50d922b0b..4c258f4b1 100755 --- a/entity/src/epilot/models/shared/redirectentityview.py +++ b/entity/src/epilot/models/shared/redirectentityview.py @@ -7,14 +7,14 @@ from epilot import utils from typing import Optional -class RedirectEntityViewViewTypeEnum(str, Enum): - REDIRECT = "redirect" +class RedirectEntityViewViewType(str, Enum): + REDIRECT = 'redirect' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class RedirectEntityView: - route: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('route'), 'exclude': lambda f: f is None }}) - view_type: Optional[RedirectEntityViewViewTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + route: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('route'), 'exclude': lambda f: f is None }}) + view_type: Optional[RedirectEntityViewViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py index bccae6af4..bf8966664 100755 --- a/entity/src/epilot/models/shared/relationattribute.py +++ b/entity/src/epilot/models/shared/relationattribute.py @@ -7,7 +7,7 @@ from epilot import utils from typing import Any, Optional -class RelationAttributeActionsActionTypeEnum(str, Enum): +class RelationAttributeActionsActionType(str, Enum): r"""The action type. Currently supported actions: | action | description | @@ -15,18 +15,17 @@ class RelationAttributeActionsActionTypeEnum(str, Enum): | add_existing | Enables the user to pick an existing entity to link as relation | | create_new | Enables the user to create a new entity using the first/main `allowed_schemas` schema | create_from_existing | Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation | - """ - ADD_EXISTING = "add_existing" - CREATE_NEW = "create_new" - CREATE_FROM_EXISTING = "create_from_existing" + ADD_EXISTING = 'add_existing' + CREATE_NEW = 'create_new' + CREATE_FROM_EXISTING = 'create_from_existing' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class RelationAttributeActions: - action_type: Optional[RelationAttributeActionsActionTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action_type'), 'exclude': lambda f: f is None }}) + action_type: Optional[RelationAttributeActionsActionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action_type'), 'exclude': lambda f: f is None }}) r"""The action type. Currently supported actions: | action | description | @@ -34,37 +33,60 @@ class RelationAttributeActions: | add_existing | Enables the user to pick an existing entity to link as relation | | create_new | Enables the user to create a new entity using the first/main `allowed_schemas` schema | create_from_existing | Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation | - - """ + """ default: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default'), 'exclude': lambda f: f is None }}) - r"""Sets the action as the default action, visible as the main action button.""" + r"""Sets the action as the default action, visible as the main action button.""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""Name of the feature flag that enables this action""" + r"""Name of the feature flag that enables this action""" label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label'), 'exclude': lambda f: f is None }}) - r"""The action label or action translation key (i18n)""" - new_entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('new_entity_item'), 'exclude': lambda f: f is None }}) + r"""The action label or action translation key (i18n)""" + new_entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('new_entity_item'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""Name of the setting flag that enables this action""" + r"""Name of the setting flag that enables this action""" -class RelationAttributeDrawerSizeEnum(str, Enum): - SMALL = "small" - MEDIUM = "medium" - LARGE = "large" +class RelationAttributeDrawerSize(str, Enum): + SMALL = 'small' + MEDIUM = 'medium' + LARGE = 'large' -class RelationAttributeEditModeEnum(str, Enum): - LIST_VIEW = "list-view" +class RelationAttributeEditMode(str, Enum): + LIST_VIEW = 'list-view' -class RelationAttributeRelationAffinityModeEnum(str, Enum): + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class RelationAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class RelationAttributeRelationAffinityMode(str, Enum): r"""Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity.""" - WEAK = "weak" - STRONG = "strong" + WEAK = 'weak' + STRONG = 'strong' -class RelationAttributeRelationTypeEnum(str, Enum): - HAS_MANY = "has_many" - HAS_ONE = "has_one" +class RelationAttributeRelationType(str, Enum): + HAS_MANY = 'has_many' + HAS_ONE = 'has_one' -class RelationAttributeTypeEnum(str, Enum): - RELATION = "relation" +class RelationAttributeType(str, Enum): + RELATION = 'relation' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -72,67 +94,67 @@ class RelationAttributeTypeEnum(str, Enum): class RelationAttribute: r"""Entity Relationship""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - actions: Optional[list[RelationAttributeActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('actions'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + actions: Optional[list[RelationAttributeActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('actions'), 'exclude': lambda f: f is None }}) add_button_label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('add_button_label'), 'exclude': lambda f: f is None }}) - r"""Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is.""" - allowed_schemas: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allowedSchemas'), 'exclude': lambda f: f is None }}) + r"""Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is.""" + allowed_schemas: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allowedSchemas'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) details_view_mode_enabled: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details_view_mode_enabled'), 'exclude': lambda f: f is None }}) - r"""Enables the preview, edition, and creation of relation items on a Master-Details view mode.""" - drawer_size: Optional[RelationAttributeDrawerSizeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('drawer_size'), 'exclude': lambda f: f is None }}) - edit_mode: Optional[RelationAttributeEditModeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_mode'), 'exclude': lambda f: f is None }}) + r"""Enables the preview, edition, and creation of relation items on a Master-Details view mode.""" + drawer_size: Optional[RelationAttributeDrawerSize] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('drawer_size'), 'exclude': lambda f: f is None }}) + edit_mode: Optional[RelationAttributeEditMode] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_mode'), 'exclude': lambda f: f is None }}) enable_relation_picker: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_picker'), 'exclude': lambda f: f is None }}) - r"""When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.""" + r"""When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.""" enable_relation_tags: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_tags'), 'exclude': lambda f: f is None }}) - r"""When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item.""" + r"""When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item.""" entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" - has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) + r"""Which group the attribute should appear in. Accepts group ID or group name""" + has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" - icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + r"""When set to true, will hide the label of the field.""" + icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) + info_helpers: Optional[RelationAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) - relation_affinity_mode: Optional[RelationAttributeRelationAffinityModeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relation_affinity_mode'), 'exclude': lambda f: f is None }}) - r"""Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity.""" - relation_type: Optional[RelationAttributeRelationTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relation_type'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + relation_affinity_mode: Optional[RelationAttributeRelationAffinityMode] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relation_affinity_mode'), 'exclude': lambda f: f is None }}) + r"""Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity.""" + relation_type: Optional[RelationAttributeRelationType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relation_type'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) reverse_attributes: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reverse_attributes'), 'exclude': lambda f: f is None }}) - r"""Map of schema slug to target relation attribute""" + r"""Map of schema slug to target relation attribute""" search_placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_placeholder'), 'exclude': lambda f: f is None }}) - r"""Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is.""" + r"""Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is.""" setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - summary_fields: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_fields'), 'exclude': lambda f: f is None }}) - type: Optional[RelationAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + summary_fields: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_fields'), 'exclude': lambda f: f is None }}) + type: Optional[RelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/relationitem.py b/entity/src/epilot/models/shared/relationitem.py index d9d616e2e..16ec9127a 100755 --- a/entity/src/epilot/models/shared/relationitem.py +++ b/entity/src/epilot/models/shared/relationitem.py @@ -12,9 +12,9 @@ class RelationItem: r"""Success""" - attribute: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attribute') }}) - entity_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_id') }}) - tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) + attribute: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attribute') }}) + entity_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_id') }}) + tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) reverse: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reverse'), 'exclude': lambda f: f is None }}) - r"""Whether this is a reverse relation""" + r"""Whether this is a reverse relation""" \ No newline at end of file diff --git a/entity/src/epilot/models/shared/repeatableattribute.py b/entity/src/epilot/models/shared/repeatableattribute.py index 7bf8c4026..a38245297 100755 --- a/entity/src/epilot/models/shared/repeatableattribute.py +++ b/entity/src/epilot/models/shared/repeatableattribute.py @@ -7,20 +7,44 @@ from epilot import utils from typing import Any, Optional -class RepeatableAttributeRelationAffinityModeEnum(str, Enum): + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class RepeatableAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class RepeatableAttributeRelationAffinityMode(str, Enum): r"""Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.""" - WEAK = "weak" - STRONG = "strong" + WEAK = 'weak' + STRONG = 'strong' -class RepeatableAttributeTypeEnum(str, Enum): - STRING = "string" - PHONE = "phone" - EMAIL = "email" - ADDRESS = "address" - RELATION = "relation" - PAYMENT = "payment" - PRICE_COMPONENT = "price_component" - DATE = "date" +class RepeatableAttributeType(str, Enum): + STRING = 'string' + PHONE = 'phone' + EMAIL = 'email' + ADDRESS = 'address' + RELATION = 'relation' + PAYMENT = 'payment' + PRICE_COMPONENT = 'price_component' + DATE = 'date' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -28,56 +52,55 @@ class RepeatableAttributeTypeEnum(str, Enum): class RepeatableAttribute: r"""Repeatable (add N number of fields)""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) enable_relation_picker: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_picker'), 'exclude': lambda f: f is None }}) - r"""when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.""" + r"""when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.""" entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" - has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) + r"""Which group the attribute should appear in. Accepts group ID or group name""" + has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[RepeatableAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) - relation_affinity_mode: Optional[RepeatableAttributeRelationAffinityModeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relation_affinity_mode'), 'exclude': lambda f: f is None }}) - r"""Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.""" + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + relation_affinity_mode: Optional[RepeatableAttributeRelationAffinityMode] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relation_affinity_mode'), 'exclude': lambda f: f is None }}) + r"""Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.""" render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - repeatable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('repeatable'), 'exclude': lambda f: f is None }}) - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + repeatable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('repeatable'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[RepeatableAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[RepeatableAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/savedview.py b/entity/src/epilot/models/shared/savedview.py index c32adcfd3..5a8161503 100755 --- a/entity/src/epilot/models/shared/savedview.py +++ b/entity/src/epilot/models/shared/savedview.py @@ -12,7 +12,7 @@ class SavedViewCreatedBy1: r"""A user that created the view""" - user_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user_id'), 'exclude': lambda f: f is None }}) + user_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user_id'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @@ -20,14 +20,14 @@ class SavedViewCreatedBy1: class SavedView: r"""A saved entity view""" - created_by: Any = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) + created_by: Any = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""User-friendly identifier for the saved view""" + r"""User-friendly identifier for the saved view""" slug: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) - r"""list of schemas a view can belong to""" - ui_config: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config') }}) + r"""list of schemas a view can belong to""" + ui_config: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config') }}) org: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org'), 'exclude': lambda f: f is None }}) - r"""Organisation ID a view belongs to""" + r"""Organisation ID a view belongs to""" shared: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shared'), 'exclude': lambda f: f is None }}) - r"""boolean property for if a view is shared with organisation""" + r"""boolean property for if a view is shared with organisation""" \ No newline at end of file diff --git a/entity/src/epilot/models/shared/savedviewitem.py b/entity/src/epilot/models/shared/savedviewitem.py index ae466a0f4..4e73711ac 100755 --- a/entity/src/epilot/models/shared/savedviewitem.py +++ b/entity/src/epilot/models/shared/savedviewitem.py @@ -12,7 +12,7 @@ class SavedViewItemCreatedBy1: r"""A user that created the view""" - user_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user_id'), 'exclude': lambda f: f is None }}) + user_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user_id'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) @@ -20,18 +20,18 @@ class SavedViewItemCreatedBy1: class SavedViewItem: r"""A saved entity view""" - created_by: Any = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) + created_by: Any = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""User-friendly identifier for the saved view""" + r"""User-friendly identifier for the saved view""" slug: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) - r"""list of schemas a view can belong to""" - ui_config: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config') }}) - created_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'exclude': lambda f: f is None }}) + r"""list of schemas a view can belong to""" + ui_config: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config') }}) + created_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) - r"""Generated uuid for a saved view""" + r"""Generated uuid for a saved view""" org: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org'), 'exclude': lambda f: f is None }}) - r"""Organisation ID a view belongs to""" + r"""Organisation ID a view belongs to""" shared: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shared'), 'exclude': lambda f: f is None }}) - r"""boolean property for if a view is shared with organisation""" - updated_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'exclude': lambda f: f is None }}) + r"""boolean property for if a view is shared with organisation""" + updated_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/searchmappings.py b/entity/src/epilot/models/shared/searchmappings.py index 25dd74a04..944cbf09f 100755 --- a/entity/src/epilot/models/shared/searchmappings.py +++ b/entity/src/epilot/models/shared/searchmappings.py @@ -7,23 +7,23 @@ from epilot import utils from typing import Any, Optional -class SearchMappingsTypeEnum(str, Enum): - KEYWORD = "keyword" - TEXT = "text" - BOOLEAN = "boolean" - INTEGER = "integer" - LONG = "long" - FLOAT = "float" - DATE = "date" - FLATTENED = "flattened" - NESTED = "nested" +class SearchMappingsType(str, Enum): + KEYWORD = 'keyword' + TEXT = 'text' + BOOLEAN = 'boolean' + INTEGER = 'integer' + LONG = 'long' + FLOAT = 'float' + DATE = 'date' + FLATTENED = 'flattened' + NESTED = 'nested' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SearchMappings: - fields: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) - index: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) - type: Optional[SearchMappingsTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + fields_: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) + index: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) + type: Optional[SearchMappingsType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/security.py b/entity/src/epilot/models/shared/security.py index 0dedc5e9a..e4f1a8c31 100755 --- a/entity/src/epilot/models/shared/security.py +++ b/entity/src/epilot/models/shared/security.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class Security: - epilot_auth: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'http', 'sub_type': 'bearer', 'field_name': 'Authorization' }}) - epilot_org: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'apiKey', 'sub_type': 'header', 'field_name': 'x-epilot-org-id' }}) + epilot_auth: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'http', 'sub_type': 'bearer', 'field_name': 'Authorization' }}) + epilot_org: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'apiKey', 'sub_type': 'header', 'field_name': 'x-epilot-org-id' }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/selectattribute.py b/entity/src/epilot/models/shared/selectattribute.py index 0952db1f8..6dcefa48f 100755 --- a/entity/src/epilot/models/shared/selectattribute.py +++ b/entity/src/epilot/models/shared/selectattribute.py @@ -8,16 +8,40 @@ from typing import Any, Optional +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SelectAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SelectAttributeOptions1: - value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) + value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) + title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) -class SelectAttributeTypeEnum(str, Enum): - SELECT = "select" - RADIO = "radio" +class SelectAttributeType(str, Enum): + SELECT = 'select' + RADIO = 'radio' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -25,53 +49,52 @@ class SelectAttributeTypeEnum(str, Enum): class SelectAttribute: r"""Dropdown select""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) allow_any: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_any'), 'exclude': lambda f: f is None }}) - r"""Allow arbitrary input values in addition to provided options""" + r"""Allow arbitrary input values in addition to provided options""" constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[SelectAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + options: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[SelectAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[SelectAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/sequenceattribute.py b/entity/src/epilot/models/shared/sequenceattribute.py index a08ddb1a1..1b09784da 100755 --- a/entity/src/epilot/models/shared/sequenceattribute.py +++ b/entity/src/epilot/models/shared/sequenceattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class SequenceAttributeTypeEnum(str, Enum): - SEQUENCE = "sequence" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SequenceAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class SequenceAttributeType(str, Enum): + SEQUENCE = 'sequence' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,53 +40,52 @@ class SequenceAttributeTypeEnum(str, Enum): class SequenceAttribute: r"""Sequence of unique identifiers""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[SequenceAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) prefix: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('prefix'), 'exclude': lambda f: f is None }}) - r"""Prefix added before the sequence number""" - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Prefix added before the sequence number""" + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - start_number: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_number'), 'exclude': lambda f: f is None }}) - type: Optional[SequenceAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + start_number: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_number'), 'exclude': lambda f: f is None }}) + type: Optional[SequenceAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py index 627b2e887..f7e3f5c8a 100755 --- a/entity/src/epilot/models/shared/statusattribute.py +++ b/entity/src/epilot/models/shared/statusattribute.py @@ -8,15 +8,39 @@ from typing import Any, Optional +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class StatusAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class StatusAttributeOptions2: - value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) + value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) + title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) -class StatusAttributeTypeEnum(str, Enum): - STATUS = "status" +class StatusAttributeType(str, Enum): + STATUS = 'status' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -24,51 +48,50 @@ class StatusAttributeTypeEnum(str, Enum): class StatusAttribute: r"""Status select""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[StatusAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + options: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[StatusAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[StatusAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/summaryattribute.py b/entity/src/epilot/models/shared/summaryattribute.py index f6aa68c1e..01a302aee 100755 --- a/entity/src/epilot/models/shared/summaryattribute.py +++ b/entity/src/epilot/models/shared/summaryattribute.py @@ -21,25 +21,23 @@ class SummaryAttribute: } ``` The value field supports handlebar expressions from which you can pick any field from the entity state. - """ label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - r"""Label to be shown on the top of the value.""" + r"""Label to be shown on the top of the value.""" value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - r"""A static value or an handlebar expression.""" + r"""A static value or an handlebar expression.""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""Binds summary field visibility to the feature flag state.""" + r"""Binds summary field visibility to the feature flag state.""" render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ + """ setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""Binds summary field visibility to the setting flag state.""" + r"""Binds summary field visibility to the setting flag state.""" show_as_tag: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_as_tag'), 'exclude': lambda f: f is None }}) - r"""Displays the value within a tag chip.""" + r"""Displays the value within a tag chip.""" tag_color: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tag_color'), 'exclude': lambda f: f is None }}) - r"""CSS hex color or CSS color name for the tag chip.""" + r"""CSS hex color or CSS color name for the tag chip.""" \ No newline at end of file diff --git a/entity/src/epilot/models/shared/summaryfield.py b/entity/src/epilot/models/shared/summaryfield.py index fb74fef65..33622de7d 100755 --- a/entity/src/epilot/models/shared/summaryfield.py +++ b/entity/src/epilot/models/shared/summaryfield.py @@ -13,7 +13,7 @@ class SummaryField: r"""Summary Fields are displayed inside list view as a resume of the relation entity.""" display_as: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('display_as'), 'exclude': lambda f: f is None }}) - r"""An hint on how to display the summary field""" + r"""An hint on how to display the summary field""" field: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('field'), 'exclude': lambda f: f is None }}) - r"""The field from the entity attributes to display""" + r"""The field from the entity attributes to display""" \ No newline at end of file diff --git a/entity/src/epilot/models/shared/tagsattribute.py b/entity/src/epilot/models/shared/tagsattribute.py index 9b8dbdfa5..f1217fa71 100755 --- a/entity/src/epilot/models/shared/tagsattribute.py +++ b/entity/src/epilot/models/shared/tagsattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class TagsAttributeTypeEnum(str, Enum): - TAGS = "tags" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class TagsAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class TagsAttributeType(str, Enum): + TAGS = 'tags' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,52 +40,51 @@ class TagsAttributeTypeEnum(str, Enum): class TagsAttribute: r"""Tags""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[TagsAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + options: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - suggestions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggestions'), 'exclude': lambda f: f is None }}) - type: Optional[TagsAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + suggestions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggestions'), 'exclude': lambda f: f is None }}) + type: Optional[TagsAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/taxonomy.py b/entity/src/epilot/models/shared/taxonomy.py index b5a34a9c0..67dbbb46b 100755 --- a/entity/src/epilot/models/shared/taxonomy.py +++ b/entity/src/epilot/models/shared/taxonomy.py @@ -16,11 +16,11 @@ class Taxonomy: r"""Taxonomy""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag""" + r"""A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag""" slug: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) - r"""URL-friendly name for taxonomy""" - created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + r"""URL-friendly name for taxonomy""" + created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) plural: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plural'), 'exclude': lambda f: f is None }}) - r"""Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags""" - updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + r"""Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags""" + updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/taxonomyclassification.py b/entity/src/epilot/models/shared/taxonomyclassification.py index 1440e7acc..6d03e02d0 100755 --- a/entity/src/epilot/models/shared/taxonomyclassification.py +++ b/entity/src/epilot/models/shared/taxonomyclassification.py @@ -14,9 +14,9 @@ @dataclasses.dataclass class TaxonomyClassification: - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) - id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) - parents: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) - updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + parents: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) + updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/textattribute.py b/entity/src/epilot/models/shared/textattribute.py index 8c2a0bd08..fd98e4209 100755 --- a/entity/src/epilot/models/shared/textattribute.py +++ b/entity/src/epilot/models/shared/textattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class TextAttributeTypeEnum(str, Enum): - STRING = "string" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class TextAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class TextAttributeType(str, Enum): + STRING = 'string' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,51 +40,50 @@ class TextAttributeTypeEnum(str, Enum): class TextAttribute: r"""Textarea or text input""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - multiline: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('multiline'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[TextAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + multiline: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('multiline'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[TextAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[TextAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/models/shared/userrelationattribute.py b/entity/src/epilot/models/shared/userrelationattribute.py index dd11bd3d1..b02c7edfb 100755 --- a/entity/src/epilot/models/shared/userrelationattribute.py +++ b/entity/src/epilot/models/shared/userrelationattribute.py @@ -7,8 +7,32 @@ from epilot import utils from typing import Any, Optional -class UserRelationAttributeTypeEnum(str, Enum): - RELATION_USER = "relation_user" + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class UserRelationAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + +class UserRelationAttributeType(str, Enum): + RELATION_USER = 'relation_user' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,51 +40,50 @@ class UserRelationAttributeTypeEnum(str, Enum): class UserRelationAttribute: r"""User Relationship""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. - - """ - default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` disables editing the attribute on the entity builder UI""" + r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the feature flag is enabled""" + r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) - r"""Which group the attribute should appear in. Accepts group ID or group name""" + r"""Which group the attribute should appear in. Accepts group ID or group name""" hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) - r"""Do not render attribute in entity views""" + r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) - r"""When set to true, will hide the label of the field.""" + r"""When set to true, will hide the label of the field.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name - - """ - layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - multiple: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('multiple'), 'exclude': lambda f: f is None }}) + """ + info_helpers: Optional[UserRelationAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + multiple: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('multiple'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) - r"""Attribute sort order (ascending) in group""" - placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) - preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) - r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. - - """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) - r"""This attribute should only be active when the setting is enabled""" + r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) - r"""Render as a column in table views. When defined, overrides `hidden`""" - type: Optional[UserRelationAttributeTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[UserRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) \ No newline at end of file diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py index 679051157..51487f014 100755 --- a/entity/src/epilot/relations.py +++ b/entity/src/epilot/relations.py @@ -1,42 +1,34 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests as requests_http -from . import utils +from .sdkconfiguration import SDKConfiguration +from epilot import utils from epilot.models import operations, shared from typing import Any, Optional class Relations: r"""Entity Relationships""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str - _language: str - _sdk_version: str - _gen_version: str - - def __init__(self, client: requests_http.Session, security_client: requests_http.Session, server_url: str, language: str, sdk_version: str, gen_version: str) -> None: - self._client = client - self._security_client = security_client - self._server_url = server_url - self._language = language - self._sdk_version = sdk_version - self._gen_version = gen_version + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + def add_relations(self, request: operations.AddRelationsRequest) -> operations.AddRelationsResponse: r"""addRelations Relates one or more entities to parent entity by adding items to a relation attribute """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.AddRelationsRequest, base_url, '/v1/entity/{slug}/{id}/relations', request) - headers = {} req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.AddRelationsRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('POST', url, params=query_params, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') @@ -50,28 +42,30 @@ def add_relations(self, request: operations.AddRelationsRequest) -> operations.A return res + def delete_relation(self, request: operations.DeleteRelationRequest) -> operations.DeleteRelationResponse: r"""deleteRelation Removes relation between two entities """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.DeleteRelationRequest, base_url, '/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}', request) - + headers = {} query_params = utils.get_query_params(operations.DeleteRelationRequest, request) + headers['Accept'] = '*/*' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('DELETE', url, params=query_params) + http_res = client.request('DELETE', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.DeleteRelationResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - if http_res.status_code == 204: - pass return res + def get_relations(self, request: operations.GetRelationsRequest) -> operations.GetRelationsResponse: r"""getRelations Returns 1st level direct relations for an entity. @@ -79,17 +73,18 @@ def get_relations(self, request: operations.GetRelationsRequest) -> operations.G You can control whether to return the full entity or just the relation item with the `?hydrate` query param. Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. - """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.GetRelationsRequest, base_url, '/v1/entity/{slug}/{id}/relations', request) - + headers = {} query_params = utils.get_query_params(operations.GetRelationsRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetRelationsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -101,6 +96,7 @@ def get_relations(self, request: operations.GetRelationsRequest) -> operations.G return res + def get_relations_v2(self, request: operations.GetRelationsV2Request) -> operations.GetRelationsV2Response: r"""getRelationsV2 Returns 1st level direct relations for an entity with pagination. @@ -108,17 +104,18 @@ def get_relations_v2(self, request: operations.GetRelationsV2Request) -> operati You can control whether to return the full entity or just the relation item with the `?hydrate` query param. Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. - """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.GetRelationsV2Request, base_url, '/v2/entity/{slug}/{id}/relations', request) - + headers = {} query_params = utils.get_query_params(operations.GetRelationsV2Request, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetRelationsV2Response(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -130,21 +127,23 @@ def get_relations_v2(self, request: operations.GetRelationsV2Request) -> operati return res + def update_relation(self, request: operations.UpdateRelationRequest) -> operations.UpdateRelationResponse: r"""updateRelation Updates an existing relation between two entities. """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.UpdateRelationRequest, base_url, '/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}', request) - headers = {} req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.UpdateRelationRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('PUT', url, params=query_params, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') diff --git a/entity/src/epilot/saved_views.py b/entity/src/epilot/saved_views.py index d3bb713a5..288192276 100755 --- a/entity/src/epilot/saved_views.py +++ b/entity/src/epilot/saved_views.py @@ -1,41 +1,33 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests as requests_http -from . import utils +from .sdkconfiguration import SDKConfiguration +from epilot import utils from epilot.models import operations, shared from typing import Optional class SavedViews: r"""Saved Views for Entities""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str - _language: str - _sdk_version: str - _gen_version: str - - def __init__(self, client: requests_http.Session, security_client: requests_http.Session, server_url: str, language: str, sdk_version: str, gen_version: str) -> None: - self._client = client - self._security_client = security_client - self._server_url = server_url - self._language = language - self._sdk_version = sdk_version - self._gen_version = gen_version + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + def create_saved_view(self, request: shared.SavedView) -> operations.CreateSavedViewResponse: r"""createSavedView Creates a new saved view """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity/view' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/entity/view' headers = {} req_content_type, data, form = utils.serialize_request_body(request, "request", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('POST', url, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') @@ -49,39 +41,43 @@ def create_saved_view(self, request: shared.SavedView) -> operations.CreateSaved return res + def delete_saved_view(self, request: operations.DeleteSavedViewRequest) -> operations.DeleteSavedViewResponse: r"""deleteSavedView Deletes a saved view """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.DeleteSavedViewRequest, base_url, '/v1/entity/view/{id}', request) + headers = {} + headers['Accept'] = '*/*' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + client = self.sdk_configuration.security_client - client = self._security_client - - http_res = client.request('DELETE', url) + http_res = client.request('DELETE', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.DeleteSavedViewResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - if http_res.status_code == 200: - pass return res + def get_saved_view(self, request: operations.GetSavedViewRequest) -> operations.GetSavedViewResponse: r"""getSavedView Gets Saved View configuration by id. """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.GetSavedViewRequest, base_url, '/v1/entity/view/{id}', request) + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + client = self.sdk_configuration.security_client - client = self._security_client - - http_res = client.request('GET', url) + http_res = client.request('GET', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetSavedViewResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -93,18 +89,21 @@ def get_saved_view(self, request: operations.GetSavedViewRequest) -> operations. return res + def list_saved_views(self) -> operations.ListSavedViewsResponse: r"""listSavedViews Get the Saved Views based on the schema """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity/views' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/entity/views' + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url) + http_res = client.request('GET', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.ListSavedViewsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -116,20 +115,22 @@ def list_saved_views(self) -> operations.ListSavedViewsResponse: return res + def update_saved_view(self, request: operations.UpdateSavedViewRequest) -> operations.UpdateSavedViewResponse: r"""updateSavedView Updates a saved view """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.UpdateSavedViewRequest, base_url, '/v1/entity/view/{id}', request) - headers = {} req_content_type, data, form = utils.serialize_request_body(request, "saved_view", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('PUT', url, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') diff --git a/entity/src/epilot/schemas.py b/entity/src/epilot/schemas.py index b0d26e82e..02d3742c2 100755 --- a/entity/src/epilot/schemas.py +++ b/entity/src/epilot/schemas.py @@ -1,61 +1,55 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests as requests_http -from . import utils +from .sdkconfiguration import SDKConfiguration +from epilot import utils from epilot.models import operations, shared from typing import Optional class Schemas: r"""Model Entities""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str - _language: str - _sdk_version: str - _gen_version: str - - def __init__(self, client: requests_http.Session, security_client: requests_http.Session, server_url: str, language: str, sdk_version: str, gen_version: str) -> None: - self._client = client - self._security_client = security_client - self._server_url = server_url - self._language = language - self._sdk_version = sdk_version - self._gen_version = gen_version + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + def delete_schema(self, request: operations.DeleteSchemaRequest) -> operations.DeleteSchemaResponse: r"""deleteSchema Delete a schema, or a specific version of a schema """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.DeleteSchemaRequest, base_url, '/v1/entity/schemas/{slug}', request) + headers = {} + headers['Accept'] = '*/*' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + client = self.sdk_configuration.security_client - client = self._security_client - - http_res = client.request('DELETE', url) + http_res = client.request('DELETE', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.DeleteSchemaResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - if http_res.status_code == 204: - pass return res + def get_schema(self, request: operations.GetSchemaRequest) -> operations.GetSchemaResponse: r"""getSchema By default gets the latest version of the Schema and to get the specific version of schema pass the id. """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.GetSchemaRequest, base_url, '/v1/entity/schemas/{slug}', request) - + headers = {} query_params = utils.get_query_params(operations.GetSchemaRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetSchemaResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -67,18 +61,22 @@ def get_schema(self, request: operations.GetSchemaRequest) -> operations.GetSche return res + def get_schema_versions(self, request: operations.GetSchemaVersionsRequest) -> operations.GetSchemaVersionsResponse: r"""getSchemaVersions Get all versions of this schema ordered by the latest versions including drafts. """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.GetSchemaVersionsRequest, base_url, '/v1/entity/schemas/{slug}/versions', request) + headers = {} + query_params = utils.get_query_params(operations.GetSchemaVersionsRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + client = self.sdk_configuration.security_client - client = self._security_client - - http_res = client.request('GET', url) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetSchemaVersionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -90,18 +88,21 @@ def get_schema_versions(self, request: operations.GetSchemaVersionsRequest) -> o return res + def list_schema_blueprints(self) -> operations.ListSchemaBlueprintsResponse: r"""listSchemaBlueprints List canonical versions of all available schemas """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity/schemas/blueprints' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/entity/schemas/blueprints' + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url) + http_res = client.request('GET', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.ListSchemaBlueprintsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -113,19 +114,22 @@ def list_schema_blueprints(self) -> operations.ListSchemaBlueprintsResponse: return res + def list_schemas(self, request: operations.ListSchemasRequest) -> operations.ListSchemasResponse: r"""listSchemas Get the latest versions of all schemas """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity/schemas' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/entity/schemas' + headers = {} query_params = utils.get_query_params(operations.ListSchemasRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.ListSchemasResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -137,19 +141,22 @@ def list_schemas(self, request: operations.ListSchemasRequest) -> operations.Lis return res + def list_taxonomy_classifications_for_schema(self, request: operations.ListTaxonomyClassificationsForSchemaRequest) -> operations.ListTaxonomyClassificationsForSchemaResponse: r"""listTaxonomyClassificationsForSchema List taxonomy classifications for a given schema """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.ListTaxonomyClassificationsForSchemaRequest, base_url, '/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}', request) - + headers = {} query_params = utils.get_query_params(operations.ListTaxonomyClassificationsForSchemaRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.ListTaxonomyClassificationsForSchemaResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -161,21 +168,23 @@ def list_taxonomy_classifications_for_schema(self, request: operations.ListTaxon return res + def put_schema(self, request: operations.PutSchemaRequest) -> operations.PutSchemaResponse: r"""putSchema Create or update a schema with a new version """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.PutSchemaRequest, base_url, '/v1/entity/schemas/{slug}', request) - headers = {} req_content_type, data, form = utils.serialize_request_body(request, "entity_schema", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.PutSchemaRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('PUT', url, params=query_params, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') diff --git a/entity/src/epilot/sdk.py b/entity/src/epilot/sdk.py index 19d9feb49..e85430415 100755 --- a/entity/src/epilot/sdk.py +++ b/entity/src/epilot/sdk.py @@ -1,33 +1,30 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" import requests as requests_http -from . import utils from .activity import Activity from .entities import Entities +from .entity_import import EntityImport from .export import Export from .relations import Relations from .saved_views import SavedViews from .schemas import Schemas +from .sdkconfiguration import SDKConfiguration from .taxonomy import Taxonomy +from epilot import utils from epilot.models import shared -SERVERS = [ - "https://entity.sls.epilot.io", -] -"""Contains the list of servers available to the SDK""" - class Epilot: - r"""Flexible data layer for epilot Entities. + r"""Entity API: Flexible data layer for epilot Entities. Use this API configure and access your business objects like Contacts, Opportunities and Products. [Feature Documentation](https://docs.epilot.io/docs/entities/flexible-entities) - """ activity: Activity r"""Entity Events""" entities: Entities r"""CRUD Access for Entities""" + entity_import: EntityImport export: Export r"""Export and Import entities via files""" relations: Relations @@ -39,15 +36,11 @@ class Epilot: taxonomy: Taxonomy r"""Entity classification with Taxonomies""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str = SERVERS[0] - _language: str = "python" - _sdk_version: str = "1.2.2" - _gen_version: str = "2.16.5" + sdk_configuration: SDKConfiguration def __init__(self, security: shared.Security = None, + server_idx: int = None, server_url: str = None, url_params: dict[str, str] = None, client: requests_http.Session = None @@ -56,6 +49,8 @@ def __init__(self, :param security: The security details required for authentication :type security: shared.Security + :param server_idx: The index of the server to use for all operations + :type server_idx: int :param server_url: The server URL to use for all operations :type server_url: str :param url_params: Parameters to optionally template the server URL with @@ -63,85 +58,26 @@ def __init__(self, :param client: The requests.Session HTTP client to use for all operations :type client: requests_http.Session """ - self._client = requests_http.Session() + if client is None: + client = requests_http.Session() + security_client = utils.configure_security_client(client, security) if server_url is not None: if url_params is not None: - self._server_url = utils.template_url(server_url, url_params) - else: - self._server_url = server_url - - if client is not None: - self._client = client - - self._security_client = utils.configure_security_client(self._client, security) - + server_url = utils.template_url(server_url, url_params) + self.sdk_configuration = SDKConfiguration(client, security_client, server_url, server_idx) + self._init_sdks() def _init_sdks(self): - self.activity = Activity( - self._client, - self._security_client, - self._server_url, - self._language, - self._sdk_version, - self._gen_version - ) - - self.entities = Entities( - self._client, - self._security_client, - self._server_url, - self._language, - self._sdk_version, - self._gen_version - ) - - self.export = Export( - self._client, - self._security_client, - self._server_url, - self._language, - self._sdk_version, - self._gen_version - ) - - self.relations = Relations( - self._client, - self._security_client, - self._server_url, - self._language, - self._sdk_version, - self._gen_version - ) - - self.saved_views = SavedViews( - self._client, - self._security_client, - self._server_url, - self._language, - self._sdk_version, - self._gen_version - ) - - self.schemas = Schemas( - self._client, - self._security_client, - self._server_url, - self._language, - self._sdk_version, - self._gen_version - ) - - self.taxonomy = Taxonomy( - self._client, - self._security_client, - self._server_url, - self._language, - self._sdk_version, - self._gen_version - ) - + self.activity = Activity(self.sdk_configuration) + self.entities = Entities(self.sdk_configuration) + self.entity_import = EntityImport(self.sdk_configuration) + self.export = Export(self.sdk_configuration) + self.relations = Relations(self.sdk_configuration) + self.saved_views = SavedViews(self.sdk_configuration) + self.schemas = Schemas(self.sdk_configuration) + self.taxonomy = Taxonomy(self.sdk_configuration) \ No newline at end of file diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py new file mode 100755 index 000000000..d8f0a290d --- /dev/null +++ b/entity/src/epilot/sdkconfiguration.py @@ -0,0 +1,29 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests +from dataclasses import dataclass + + +SERVERS = [ + 'https://entity.sls.epilot.io', +] +"""Contains the list of servers available to the SDK""" + +@dataclass +class SDKConfiguration: + client: requests.Session + security_client: requests.Session + server_url: str = '' + server_idx: int = 0 + language: str = 'python' + openapi_doc_version: str = '1.0.0' + sdk_version: str = '1.3.0' + gen_version: str = '2.37.2' + + def get_server_details(self) -> tuple[str, dict[str, str]]: + if self.server_url: + return self.server_url.removesuffix('/'), {} + if self.server_idx is None: + self.server_idx = 0 + + return SERVERS[self.server_idx], {} diff --git a/entity/src/epilot/taxonomy.py b/entity/src/epilot/taxonomy.py index d8bbba05d..dcb67a049 100755 --- a/entity/src/epilot/taxonomy.py +++ b/entity/src/epilot/taxonomy.py @@ -1,39 +1,32 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests as requests_http -from . import utils +from .sdkconfiguration import SDKConfiguration +from epilot import utils from epilot.models import operations, shared from typing import Optional class Taxonomy: r"""Entity classification with Taxonomies""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str - _language: str - _sdk_version: str - _gen_version: str - - def __init__(self, client: requests_http.Session, security_client: requests_http.Session, server_url: str, language: str, sdk_version: str, gen_version: str) -> None: - self._client = client - self._security_client = security_client - self._server_url = server_url - self._language = language - self._sdk_version = sdk_version - self._gen_version = gen_version + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + def get_taxonomy(self, request: operations.GetTaxonomyRequest) -> operations.GetTaxonomyResponse: r"""getTaxonomy Get taxonomy by slug """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.GetTaxonomyRequest, base_url, '/v1/entity/taxonomies/{taxonomySlug}', request) + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + client = self.sdk_configuration.security_client - client = self._security_client - - http_res = client.request('GET', url) + http_res = client.request('GET', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetTaxonomyResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -45,18 +38,21 @@ def get_taxonomy(self, request: operations.GetTaxonomyRequest) -> operations.Get return res + def list_taxonomies(self) -> operations.ListTaxonomiesResponse: r"""listTaxonomies List taxonomies in an organisation """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity/listTaxonomies' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/entity/listTaxonomies' + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url) + http_res = client.request('GET', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.ListTaxonomiesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -68,21 +64,23 @@ def list_taxonomies(self) -> operations.ListTaxonomiesResponse: return res + def taxonomies_classifications_search(self, request: operations.TaxonomiesClassificationsSearchRequest) -> operations.TaxonomiesClassificationsSearchResponse: r"""taxonomiesClassificationsSearch List taxonomy classifications in an organisation based on taxonomy slug """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/entity/taxonomies/classifications:search' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/entity/taxonomies/classifications:search' headers = {} req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.TaxonomiesClassificationsSearchRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('POST', url, params=query_params, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') @@ -96,19 +94,22 @@ def taxonomies_classifications_search(self, request: operations.TaxonomiesClassi return res + def taxonomy_autocomplete(self, request: operations.TaxonomyAutocompleteRequest) -> operations.TaxonomyAutocompleteResponse: r"""taxonomyAutocomplete Taxonomies autocomplete """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.TaxonomyAutocompleteRequest, base_url, '/v1/entity/taxonomies/{taxonomySlug}:autocomplete', request) - + headers = {} query_params = utils.get_query_params(operations.TaxonomyAutocompleteRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.TaxonomyAutocompleteResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -120,20 +121,22 @@ def taxonomy_autocomplete(self, request: operations.TaxonomyAutocompleteRequest) return res + def update_classifications_for_taxonomy(self, request: operations.UpdateClassificationsForTaxonomyRequest) -> operations.UpdateClassificationsForTaxonomyResponse: r"""updateClassificationsForTaxonomy Update taxonomies in an organisation based in taxonomy slug """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.UpdateClassificationsForTaxonomyRequest, base_url, '/v1/entity/taxonomies/{taxonomySlug}/classifications', request) - headers = {} req_content_type, data, form = utils.serialize_request_body(request, "classifications_update", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('POST', url, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') diff --git a/entity/src/epilot/utils/utils.py b/entity/src/epilot/utils/utils.py index 9d4fba324..6b39ecf74 100755 --- a/entity/src/epilot/utils/utils.py +++ b/entity/src/epilot/utils/utils.py @@ -112,7 +112,7 @@ def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: dict, client.client.headers[header_name] = value elif scheme_type == 'http': if sub_type == 'bearer': - client.client.headers[header_name] = value + client.client.headers[header_name] = value.lower().startswith('bearer ') and value or f'Bearer {value}' else: raise Exception('not supported') else: @@ -141,7 +141,8 @@ def _parse_basic_auth_scheme(client: SecurityClient, scheme: dataclass): client.client.headers['Authorization'] = f'Basic {base64.b64encode(data).decode()}' -def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass, gbls: dict[str, dict[str, dict[str, Any]]] = None) -> str: +def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass, + gbls: dict[str, dict[str, dict[str, Any]]] = None) -> str: path_param_fields: Tuple[Field, ...] = fields(clazz) for field in path_param_fields: request_metadata = field.metadata.get('request') @@ -152,62 +153,71 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass if param_metadata is None: continue - if param_metadata.get('style', 'simple') == 'simple': - param = getattr( - path_params, field.name) if path_params is not None else None - param = _populate_from_globals( - field.name, param, 'pathParam', gbls) - - if param is None: - continue - - if isinstance(param, list): - pp_vals: list[str] = [] - for pp_val in param: - if pp_val is None: - continue - pp_vals.append(_val_to_string(pp_val)) - path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - elif isinstance(param, dict): - pp_vals: list[str] = [] - for pp_key in param: - if param[pp_key] is None: - continue - if param_metadata.get('explode'): - pp_vals.append( - f"{pp_key}={_val_to_string(param[pp_key])}") - else: - pp_vals.append( - f"{pp_key},{_val_to_string(param[pp_key])}") - path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - elif not isinstance(param, (str, int, float, complex, bool)): - pp_vals: list[str] = [] - param_fields: Tuple[Field, ...] = fields(param) - for param_field in param_fields: - param_value_metadata = param_field.metadata.get( - 'path_param') - if not param_value_metadata: - continue + param = getattr( + path_params, field.name) if path_params is not None else None + param = _populate_from_globals( + field.name, param, 'pathParam', gbls) - parm_name = param_value_metadata.get( - 'field_name', field.name) + if param is None: + continue - param_field_val = getattr(param, param_field.name) - if param_field_val is None: - continue - if param_metadata.get('explode'): - pp_vals.append( - f"{parm_name}={_val_to_string(param_field_val)}") - else: - pp_vals.append( - f"{parm_name},{_val_to_string(param_field_val)}") - path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - else: + f_name = param_metadata.get("field_name", field.name) + serialization = param_metadata.get('serialization', '') + if serialization != '': + serialized_params = _get_serialized_params( + param_metadata, f_name, param) + for key, value in serialized_params.items(): path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', _val_to_string(param), 1) + '{' + key + '}', value, 1) + else: + if param_metadata.get('style', 'simple') == 'simple': + if isinstance(param, list): + pp_vals: list[str] = [] + for pp_val in param: + if pp_val is None: + continue + pp_vals.append(_val_to_string(pp_val)) + path = path.replace( + '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) + elif isinstance(param, dict): + pp_vals: list[str] = [] + for pp_key in param: + if param[pp_key] is None: + continue + if param_metadata.get('explode'): + pp_vals.append( + f"{pp_key}={_val_to_string(param[pp_key])}") + else: + pp_vals.append( + f"{pp_key},{_val_to_string(param[pp_key])}") + path = path.replace( + '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) + elif not isinstance(param, (str, int, float, complex, bool)): + pp_vals: list[str] = [] + param_fields: Tuple[Field, ...] = fields(param) + for param_field in param_fields: + param_value_metadata = param_field.metadata.get( + 'path_param') + if not param_value_metadata: + continue + + parm_name = param_value_metadata.get( + 'field_name', field.name) + + param_field_val = getattr(param, param_field.name) + if param_field_val is None: + continue + if param_metadata.get('explode'): + pp_vals.append( + f"{parm_name}={_val_to_string(param_field_val)}") + else: + pp_vals.append( + f"{parm_name},{_val_to_string(param_field_val)}") + path = path.replace( + '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) + else: + path = path.replace( + '{' + param_metadata.get('field_name', field.name) + '}', _val_to_string(param), 1) return server_url.removesuffix("/") + path @@ -224,7 +234,8 @@ def template_url(url_with_params: str, params: dict[str, str]) -> str: return url_with_params -def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[str, dict[str, Any]]] = None) -> dict[str, list[str]]: +def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[str, dict[str, Any]]] = None) -> dict[ + str, list[str]]: params: dict[str, list[str]] = {} param_fields: Tuple[Field, ...] = fields(clazz) @@ -246,16 +257,23 @@ def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[ f_name = metadata.get("field_name") serialization = metadata.get('serialization', '') if serialization != '': - params = params | _get_serialized_query_params( - metadata, f_name, value) + serialized_parms = _get_serialized_params(metadata, f_name, value) + for key, value in serialized_parms.items(): + if key in params: + params[key].extend(value) + else: + params[key] = [value] else: style = metadata.get('style', 'form') if style == 'deepObject': params = params | _get_deep_object_query_params( metadata, f_name, value) elif style == 'form': - params = params | _get_form_query_params( - metadata, f_name, value) + params = params | _get_delimited_query_params( + metadata, f_name, value, ",") + elif style == 'pipeDelimited': + params = params | _get_delimited_query_params( + metadata, f_name, value, "|") else: raise Exception('not yet implemented') return params @@ -282,8 +300,8 @@ def get_headers(headers_params: dataclass) -> dict[str, str]: return headers -def _get_serialized_query_params(metadata: dict, field_name: str, obj: any) -> dict[str, list[str]]: - params: dict[str, list[str]] = {} +def _get_serialized_params(metadata: dict, field_name: str, obj: any) -> dict[str, str]: + params: dict[str, str] = {} serialization = metadata.get('serialization', '') if serialization == 'json': @@ -314,12 +332,15 @@ def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> if val is None: continue - if params.get(f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]') is None: - params[f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ + if params.get( + f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]') is None: + params[ + f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ ] params[ - f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'].append(_val_to_string(val)) + f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'].append( + _val_to_string(val)) else: params[ f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ @@ -355,25 +376,28 @@ def _get_query_param_field_name(obj_field: Field) -> str: return obj_param_metadata.get("field_name", obj_field.name) -def _get_form_query_params(metadata: dict, field_name: str, obj: any) -> dict[str, list[str]]: - return _populate_form(field_name, metadata.get("explode", True), obj, _get_query_param_field_name) +def _get_delimited_query_params(metadata: dict, field_name: str, obj: any, delimiter: str) -> dict[ + str, list[str]]: + return _populate_form(field_name, metadata.get("explode", True), obj, _get_query_param_field_name, delimiter) SERIALIZATION_METHOD_TO_CONTENT_TYPE = { - 'json': 'application/json', - 'form': 'application/x-www-form-urlencoded', + 'json': 'application/json', + 'form': 'application/x-www-form-urlencoded', 'multipart': 'multipart/form-data', - 'raw': 'application/octet-stream', - 'string': 'text/plain', + 'raw': 'application/octet-stream', + 'string': 'text/plain', } -def serialize_request_body(request: dataclass, request_field_name: str, serialization_method: str) -> Tuple[str, any, any]: +def serialize_request_body(request: dataclass, request_field_name: str, serialization_method: str) -> Tuple[ + str, any, any]: if request is None: return None, None, None, None if not is_dataclass(request) or not hasattr(request, request_field_name): - return serialize_content_type(request_field_name, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], request) + return serialize_content_type(request_field_name, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], + request) request_val = getattr(request, request_field_name) @@ -388,7 +412,8 @@ def serialize_request_body(request: dataclass, request_field_name: str, serializ if request_metadata is None: raise Exception('invalid request type') - return serialize_content_type(request_field_name, request_metadata.get('media_type', 'application/octet-stream'), request_val) + return serialize_content_type(request_field_name, request_metadata.get('media_type', 'application/octet-stream'), + request_val) def serialize_content_type(field_name: str, media_type: str, request: dataclass) -> Tuple[str, any, list[list[any]]]: @@ -461,7 +486,7 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, def serialize_dict(original: dict, explode: bool, field_name, existing: Optional[dict[str, list[str]]]) -> dict[ - str, list[str]]: + str, list[str]]: if existing is None: existing = [] @@ -501,7 +526,7 @@ def serialize_form_data(field_name: str, data: dataclass) -> dict[str, any]: else: if metadata.get('style', 'form') == 'form': form = form | _populate_form( - field_name, metadata.get('explode', True), val, _get_form_field_name) + field_name, metadata.get('explode', True), val, _get_form_field_name, ",") else: raise Exception( f'Invalid form style for field {field.name}') @@ -523,7 +548,8 @@ def _get_form_field_name(obj_field: Field) -> str: return obj_param_metadata.get("field_name", obj_field.name) -def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_func: Callable) -> dict[str, list[str]]: +def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_func: Callable, delimiter: str) -> \ + dict[str, list[str]]: params: dict[str, list[str]] = {} if obj is None: @@ -546,10 +572,10 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f params[obj_field_name] = [_val_to_string(val)] else: items.append( - f'{obj_field_name},{_val_to_string(val)}') + f'{obj_field_name}{delimiter}{_val_to_string(val)}') if len(items) > 0: - params[field_name] = [','.join(items)] + params[field_name] = [delimiter.join(items)] elif isinstance(obj, dict): items = [] for key, value in obj.items(): @@ -559,10 +585,10 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f if explode: params[key] = _val_to_string(value) else: - items.append(f'{key},{_val_to_string(value)}') + items.append(f'{key}{delimiter}{_val_to_string(value)}') if len(items) > 0: - params[field_name] = [','.join(items)] + params[field_name] = [delimiter.join(items)] elif isinstance(obj, list): items = [] @@ -578,7 +604,7 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f items.append(_val_to_string(value)) if len(items) > 0: - params[field_name] = [','.join([str(item) for item in items])] + params[field_name] = [delimiter.join([str(item) for item in items])] else: params[field_name] = [_val_to_string(obj)] @@ -718,7 +744,7 @@ def _val_to_string(val): if isinstance(val, datetime): return val.isoformat().replace('+00:00', 'Z') if isinstance(val, Enum): - return val.value + return str(val.value) return str(val) From 9dcb70993b3b31642365e0f148616180be1814a7 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 10 Jun 2023 01:42:31 +0000 Subject: [PATCH 02/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.0 --- entity/README.md | 88 +- entity/RELEASES.md | 8 +- entity/docs/activity/README.md | 146 --- entity/docs/entityimport/README.md | 41 - entity/docs/export/README.md | 52 - .../models/operations/addrelationsrequest.md | 11 + .../models/operations/addrelationsresponse.md | 11 + .../operations/attachactivityrequest.md | 9 + .../operations/attachactivityresponse.md | 11 + .../autocomplete200applicationjson.md | 11 + .../models/operations/autocompleterequest.md | 11 + .../models/operations/autocompleteresponse.md | 11 + .../operations/createactivityrequest.md | 9 + .../operations/createactivityresponse.md | 11 + .../models/operations/createentityrequest.md | 11 + .../models/operations/createentityresponse.md | 11 + .../operations/createsavedviewresponse.md | 11 + .../models/operations/deleteentityrequest.md | 10 + .../models/operations/deleteentityresponse.md | 10 + .../operations/deleterelationrequest.md | 12 + .../operations/deleterelationresponse.md | 10 + .../operations/deletesavedviewrequest.md | 8 + .../operations/deletesavedviewresponse.md | 10 + .../models/operations/deleteschemarequest.md | 8 + .../models/operations/deleteschemaresponse.md | 10 + .../operations/exportentitiesrequest.md | 11 + .../operations/exportentitiesresponse.md | 10 + .../models/operations/getactivityrequest.md | 10 + .../models/operations/getactivityresponse.md | 11 + .../operations/getentity200applicationjson.md | 11 + ...getentityactivityfeed200applicationjson.md | 11 + .../getentityactivityfeedrequest.md | 14 + .../getentityactivityfeedresponse.md | 11 + .../models/operations/getentityrequest.md | 10 + .../models/operations/getentityresponse.md | 11 + .../models/operations/getrelationsrequest.md | 11 + .../models/operations/getrelationsresponse.md | 11 + .../operations/getrelationsv2request.md | 15 + .../operations/getrelationsv2response.md | 11 + .../getsavedview200applicationjson.md | 10 + .../models/operations/getsavedviewrequest.md | 8 + .../models/operations/getsavedviewresponse.md | 11 + .../models/operations/getschemarequest.md | 9 + .../models/operations/getschemaresponse.md | 11 + .../getschemaversions200applicationjson.md | 11 + .../operations/getschemaversionsrequest.md | 12 + .../operations/getschemaversionsresponse.md | 11 + .../models/operations/gettaxonomyrequest.md | 8 + .../models/operations/gettaxonomyresponse.md | 11 + .../operations/importentitiesrequest.md | 9 + .../operations/importentitiesresponse.md | 10 + .../listsavedviews200applicationjson.md | 10 + .../operations/listsavedviewsresponse.md | 11 + .../listschemablueprints200applicationjson.md | 10 + .../listschemablueprintsresponse.md | 11 + .../listschemas200applicationjson.md | 10 + .../models/operations/listschemasrequest.md | 8 + .../models/operations/listschemasresponse.md | 11 + .../listtaxonomies200applicationjson.md | 10 + .../operations/listtaxonomiesresponse.md | 11 + ...ssificationsforschema200applicationjson.md | 10 + ...taxonomyclassificationsforschemarequest.md | 11 + ...axonomyclassificationsforschemaresponse.md | 11 + .../models/operations/patchentityrequest.md | 13 + .../models/operations/patchentityresponse.md | 11 + .../models/operations/putschemarequest.md | 10 + .../models/operations/putschemaresponse.md | 11 + .../operations/searchentitiesresponse.md | 12 + ...classificationssearch200applicationjson.md | 10 + .../taxonomiesclassificationssearchrequest.md | 9 + ...onomiesclassificationssearchrequestbody.md | 8 + ...taxonomiesclassificationssearchresponse.md | 11 + .../taxonomyautocomplete200applicationjson.md | 10 + .../operations/taxonomyautocompleterequest.md | 10 + .../taxonomyautocompleteresponse.md | 11 + ...ificationsfortaxonomy200applicationjson.md | 12 + ...onsfortaxonomy200applicationjsondeleted.md | 7 + ...updateclassificationsfortaxonomyrequest.md | 9 + ...pdateclassificationsfortaxonomyresponse.md | 11 + .../models/operations/updateentityrequest.md | 12 + .../models/operations/updateentityresponse.md | 11 + .../operations/updaterelationrequest.md | 13 + .../operations/updaterelationrequestbody.md | 8 + .../operations/updaterelationresponse.md | 11 + .../operations/updatesavedviewrequest.md | 9 + .../operations/updatesavedviewresponse.md | 11 + .../models/operations/upsertentityrequest.md | 12 + .../operations/upsertentityrequestbody.md | 9 + .../models/operations/upsertentityresponse.md | 11 + entity/docs/models/shared/activity.md | 11 + entity/docs/models/shared/activityitem.md | 18 + .../models/shared/addressrelationattribute.md | 35 + .../addressrelationattributeconstraints.md | 11 + .../addressrelationattributeinfohelpers.md | 13 + .../shared/addressrelationattributetype.md | 8 + .../docs/models/shared/automationattribute.md | 34 + .../shared/automationattributeconstraints.md | 11 + .../shared/automationattributeinfohelpers.md | 13 + .../models/shared/automationattributetype.md | 8 + entity/docs/models/shared/booleanattribute.md | 34 + .../shared/booleanattributeconstraints.md | 11 + .../shared/booleanattributeinfohelpers.md | 13 + .../models/shared/booleanattributetype.md | 8 + .../models/shared/classificationsupdate.md | 10 + .../docs/models/shared/computedattribute.md | 34 + .../shared/computedattributeconstraints.md | 11 + .../shared/computedattributeinfohelpers.md | 13 + .../models/shared/computedattributetype.md | 8 + entity/docs/models/shared/consentattribute.md | 36 + .../shared/consentattributeconstraints.md | 11 + .../shared/consentattributeinfohelpers.md | 13 + .../models/shared/consentattributetype.md | 8 + entity/docs/models/shared/countryattribute.md | 34 + .../shared/countryattributeconstraints.md | 11 + .../shared/countryattributeinfohelpers.md | 13 + .../models/shared/countryattributetype.md | 8 + .../docs/models/shared/currencyattribute.md | 36 + .../shared/currencyattributeconstraints.md | 11 + .../shared/currencyattributecurrency1.md | 13 + .../shared/currencyattributeinfohelpers.md | 13 + .../models/shared/currencyattributetype.md | 8 + entity/docs/models/shared/dateattribute.md | 34 + .../models/shared/dateattributeconstraints.md | 11 + .../models/shared/dateattributeinfohelpers.md | 13 + .../docs/models/shared/dateattributetype.md | 9 + entity/docs/models/shared/entitycapability.md | 17 + .../docs/models/shared/entitydefaultcreate.md | 10 + .../entitydefaultcreatetablemenuoptions.md | 9 + .../shared/entitydefaultcreateviewtype.md | 8 + .../docs/models/shared/entitydefaultedit.md | 10 + .../entitydefaultedittablemenuoptions.md | 9 + .../shared/entitydefaulteditviewtype.md | 8 + .../docs/models/shared/entitydefaulttable.md | 13 + .../entitydefaulttabledropdownitems1.md | 11 + .../entitydefaulttabledropdownitems1type.md | 8 + .../entitydefaulttabledropdownitems2.md | 12 + .../entitydefaulttabledropdownitems2type.md | 8 + .../shared/entitydefaulttablenavbaractions.md | 9 + .../entitydefaulttablenavbaractionsoptions.md | 9 + ...ydefaulttablenavbaractionsoptionsparams.md | 7 + .../shared/entitydefaulttableviewtype.md | 8 + .../docs/models/shared/entityimportparams.md | 11 + .../shared/entityimportparamss3reference.md | 11 + entity/docs/models/shared/entityoperation.md | 14 + .../docs/models/shared/entityoperationdiff.md | 10 + .../models/shared/entityoperationoperation.md | 10 + .../models/shared/entityoperationparams.md | 9 + entity/docs/models/shared/entityschema.md | 27 + .../shared/entityschemagroupsettings.md | 16 + ...tityschemagroupsettingsinfotooltiptitle.md | 9 + entity/docs/models/shared/entityschemaitem.md | 32 + .../shared/entityschemaitemgroupsettings.md | 16 + ...schemaitemgroupsettingsinfotooltiptitle.md | 9 + .../models/shared/entityschemaitemsource.md | 9 + .../models/shared/entityschemaitemuiconfig.md | 13 + .../entityschemaitemuiconfiglistitem.md | 8 + .../shared/entityschemaitemuiconfigsharing.md | 8 + .../models/shared/entityschemauiconfig.md | 13 + .../shared/entityschemauiconfiglistitem.md | 8 + .../shared/entityschemauiconfigsharing.md | 8 + .../docs/models/shared/entitysearchparams.md | 15 + .../models/shared/entitysearchparamsaggs.md | 9 + .../docs/models/shared/entitysearchresults.md | 12 + .../shared/entitysearchresultsaggregations.md | 7 + .../docs/models/shared/entityviewdisabled.md | 8 + .../shared/entityviewdisabledviewtype.md | 8 + entity/docs/models/shared/fileattribute.md | 39 + .../models/shared/fileattributeconstraints.md | 11 + .../fileattributedefaultaccesscontrol.md | 9 + .../models/shared/fileattributeinfohelpers.md | 13 + .../docs/models/shared/fileattributetype.md | 9 + entity/docs/models/shared/getrelationsresp.md | 11 + .../shared/getrelationsrespwithpagination.md | 11 + .../docs/models/shared/internalattribute.md | 34 + .../shared/internalattributeconstraints.md | 11 + .../shared/internalattributeinfohelpers.md | 13 + .../models/shared/internalattributetype.md | 8 + .../models/shared/internaluserattribute.md | 34 + .../internaluserattributeconstraints.md | 11 + .../internaluserattributeinfohelpers.md | 13 + .../shared/internaluserattributetype.md | 8 + .../models/shared/invitationemailattribute.md | 34 + .../invitationemailattributeconstraints.md | 11 + .../invitationemailattributeinfohelpers.md | 13 + .../shared/invitationemailattributetype.md | 8 + entity/docs/models/shared/linkattribute.md | 34 + .../models/shared/linkattributeconstraints.md | 11 + .../models/shared/linkattributeinfohelpers.md | 13 + .../docs/models/shared/linkattributetype.md | 8 + .../models/shared/multiselectattribute.md | 38 + .../shared/multiselectattributeconstraints.md | 11 + .../shared/multiselectattributeinfohelpers.md | 13 + .../shared/multiselectattributeoptions2.md | 9 + .../models/shared/multiselectattributetype.md | 9 + entity/docs/models/shared/numberattribute.md | 35 + .../shared/numberattributeconstraints.md | 11 + .../shared/numberattributeinfohelpers.md | 13 + .../docs/models/shared/numberattributetype.md | 8 + .../models/shared/orderedlistattribute.md | 34 + .../shared/orderedlistattributeconstraints.md | 11 + .../shared/orderedlistattributeinfohelpers.md | 13 + .../models/shared/orderedlistattributetype.md | 8 + .../models/shared/partnerstatusattribute.md | 34 + .../partnerstatusattributeconstraints.md | 11 + .../partnerstatusattributeinfohelpers.md | 13 + .../shared/partnerstatusattributetype.md | 8 + .../shared/paymentmethodrelationattribute.md | 35 + ...ymentmethodrelationattributeconstraints.md | 11 + ...ymentmethodrelationattributeinfohelpers.md | 13 + .../paymentmethodrelationattributetype.md | 8 + entity/docs/models/shared/purposeattribute.md | 38 + .../shared/purposeattributeconstraints.md | 11 + .../shared/purposeattributeinfohelpers.md | 13 + .../models/shared/purposeattributetype.md | 8 + .../docs/models/shared/redirectentityview.md | 9 + .../shared/redirectentityviewviewtype.md | 8 + .../docs/models/shared/relationattribute.md | 48 + .../models/shared/relationattributeactions.md | 13 + .../relationattributeactionsactiontype.md | 19 + .../shared/relationattributeconstraints.md | 11 + .../shared/relationattributedrawersize.md | 10 + .../shared/relationattributeeditmode.md | 8 + .../shared/relationattributeinfohelpers.md | 13 + .../relationattributerelationaffinitymode.md | 11 + .../shared/relationattributerelationtype.md | 9 + .../models/shared/relationattributetype.md | 8 + entity/docs/models/shared/relationitem.md | 13 + .../docs/models/shared/repeatableattribute.md | 38 + .../shared/repeatableattributeconstraints.md | 11 + .../shared/repeatableattributeinfohelpers.md | 13 + ...repeatableattributerelationaffinitymode.md | 11 + .../models/shared/repeatableattributetype.md | 15 + entity/docs/models/shared/savedview.md | 15 + .../docs/models/shared/savedviewcreatedby1.md | 10 + entity/docs/models/shared/savedviewitem.md | 18 + .../models/shared/savedviewitemcreatedby1.md | 10 + entity/docs/models/shared/searchmappings.md | 10 + .../docs/models/shared/searchmappingstype.md | 16 + entity/docs/models/shared/security.md | 9 + entity/docs/models/shared/selectattribute.md | 36 + .../shared/selectattributeconstraints.md | 11 + .../shared/selectattributeinfohelpers.md | 13 + .../models/shared/selectattributeoptions1.md | 9 + .../docs/models/shared/selectattributetype.md | 9 + .../docs/models/shared/sequenceattribute.md | 36 + .../shared/sequenceattributeconstraints.md | 11 + .../shared/sequenceattributeinfohelpers.md | 13 + .../models/shared/sequenceattributetype.md | 8 + entity/docs/models/shared/statusattribute.md | 35 + .../shared/statusattributeconstraints.md | 11 + .../shared/statusattributeinfohelpers.md | 13 + .../models/shared/statusattributeoptions2.md | 9 + .../docs/models/shared/statusattributetype.md | 8 + entity/docs/models/shared/summaryattribute.md | 27 + entity/docs/models/shared/summaryfield.md | 11 + entity/docs/models/shared/tagsattribute.md | 36 + .../models/shared/tagsattributeconstraints.md | 11 + .../models/shared/tagsattributeinfohelpers.md | 13 + .../docs/models/shared/tagsattributetype.md | 8 + entity/docs/models/shared/taxonomy.md | 14 + .../models/shared/taxonomyclassification.md | 12 + entity/docs/models/shared/textattribute.md | 35 + .../models/shared/textattributeconstraints.md | 11 + .../models/shared/textattributeinfohelpers.md | 13 + .../docs/models/shared/textattributetype.md | 8 + .../models/shared/userrelationattribute.md | 35 + .../userrelationattributeconstraints.md | 11 + .../userrelationattributeinfohelpers.md | 13 + .../shared/userrelationattributetype.md | 8 + entity/docs/relations/README.md | 196 --- entity/docs/savedviews/README.md | 171 --- entity/docs/schemas/README.md | 1016 --------------- entity/docs/sdks/activity/README.md | 194 +++ entity/docs/{ => sdks}/entities/README.md | 126 +- entity/docs/sdks/entityimport/README.md | 53 + entity/docs/{ => sdks}/epilot/README.md | 0 entity/docs/sdks/export/README.md | 63 + entity/docs/sdks/relations/README.md | 281 ++++ entity/docs/sdks/savedviews/README.md | 231 ++++ entity/docs/sdks/schemas/README.md | 1128 +++++++++++++++++ entity/docs/sdks/taxonomy/README.md | 294 +++++ entity/docs/taxonomy/README.md | 213 ---- entity/files.gen | 284 ++++- entity/gen.yaml | 6 +- entity/setup.py | 2 +- .../src/epilot/models/operations/__init__.py | 2 +- .../epilot/models/operations/addrelations.py | 9 +- .../models/operations/attachactivity.py | 9 +- .../epilot/models/operations/autocomplete.py | 13 +- .../models/operations/createactivity.py | 9 +- .../epilot/models/operations/createentity.py | 9 +- .../models/operations/createsavedview.py | 5 +- .../epilot/models/operations/deleteentity.py | 9 +- .../models/operations/deleterelation.py | 9 +- .../models/operations/deletesavedview.py | 9 +- .../epilot/models/operations/deleteschema.py | 9 +- .../models/operations/exportentities.py | 9 +- .../epilot/models/operations/getactivity.py | 9 +- .../src/epilot/models/operations/getentity.py | 13 +- .../operations/getentityactivityfeed.py | 13 +- .../epilot/models/operations/getrelations.py | 9 +- .../models/operations/getrelationsv2.py | 9 +- .../epilot/models/operations/getsavedview.py | 13 +- .../src/epilot/models/operations/getschema.py | 9 +- .../models/operations/getschemaversions.py | 13 +- .../epilot/models/operations/gettaxonomy.py | 9 +- .../models/operations/importentities.py | 9 +- .../models/operations/listsavedviews.py | 9 +- .../models/operations/listschemablueprints.py | 9 +- .../epilot/models/operations/listschemas.py | 13 +- .../models/operations/listtaxonomies.py | 9 +- .../listtaxonomyclassificationsforschema.py | 13 +- .../epilot/models/operations/patchentity.py | 9 +- .../src/epilot/models/operations/putschema.py | 9 +- .../models/operations/searchentities.py | 5 +- .../taxonomiesclassificationssearch.py | 17 +- .../models/operations/taxonomyautocomplete.py | 13 +- .../updateclassificationsfortaxonomy.py | 23 +- .../epilot/models/operations/updateentity.py | 9 +- .../models/operations/updaterelation.py | 13 +- .../models/operations/updatesavedview.py | 9 +- .../epilot/models/operations/upsertentity.py | 13 +- entity/src/epilot/models/shared/__init__.py | 2 +- entity/src/epilot/models/shared/activity.py | 5 +- .../src/epilot/models/shared/activityitem.py | 5 +- .../models/shared/addressrelationattribute.py | 20 +- .../models/shared/automationattribute.py | 20 +- .../epilot/models/shared/booleanattribute.py | 20 +- .../models/shared/classificationsupdate.py | 5 +- .../epilot/models/shared/computedattribute.py | 20 +- .../epilot/models/shared/consentattribute.py | 20 +- .../epilot/models/shared/countryattribute.py | 20 +- .../epilot/models/shared/currencyattribute.py | 24 +- .../src/epilot/models/shared/dateattribute.py | 20 +- .../epilot/models/shared/entitycapability.py | 5 +- .../models/shared/entitydefaultcreate.py | 9 +- .../epilot/models/shared/entitydefaultedit.py | 9 +- .../models/shared/entitydefaulttable.py | 29 +- .../models/shared/entityimportparams.py | 9 +- .../epilot/models/shared/entityoperation.py | 13 +- .../src/epilot/models/shared/entityschema.py | 25 +- .../epilot/models/shared/entityschemaitem.py | 29 +- .../models/shared/entitysearchparams.py | 16 +- .../models/shared/entitysearchresults.py | 13 +- .../models/shared/entityviewdisabled.py | 5 +- .../src/epilot/models/shared/fileattribute.py | 20 +- .../epilot/models/shared/getrelationsresp.py | 5 +- .../shared/getrelationsrespwithpagination.py | 5 +- .../epilot/models/shared/internalattribute.py | 20 +- .../models/shared/internaluserattribute.py | 20 +- .../models/shared/invitationemailattribute.py | 20 +- .../src/epilot/models/shared/linkattribute.py | 20 +- .../models/shared/multiselectattribute.py | 24 +- .../epilot/models/shared/numberattribute.py | 20 +- .../models/shared/orderedlistattribute.py | 20 +- .../models/shared/partnerstatusattribute.py | 20 +- .../shared/paymentmethodrelationattribute.py | 20 +- .../epilot/models/shared/purposeattribute.py | 20 +- .../models/shared/redirectentityview.py | 5 +- .../epilot/models/shared/relationattribute.py | 24 +- .../src/epilot/models/shared/relationitem.py | 5 +- .../models/shared/repeatableattribute.py | 20 +- entity/src/epilot/models/shared/savedview.py | 9 +- .../src/epilot/models/shared/savedviewitem.py | 9 +- .../epilot/models/shared/searchmappings.py | 5 +- entity/src/epilot/models/shared/security.py | 5 +- .../epilot/models/shared/selectattribute.py | 24 +- .../epilot/models/shared/sequenceattribute.py | 20 +- .../epilot/models/shared/statusattribute.py | 24 +- .../epilot/models/shared/summaryattribute.py | 5 +- .../src/epilot/models/shared/summaryfield.py | 5 +- .../src/epilot/models/shared/tagsattribute.py | 20 +- entity/src/epilot/models/shared/taxonomy.py | 5 +- .../models/shared/taxonomyclassification.py | 5 +- .../src/epilot/models/shared/textattribute.py | 20 +- .../models/shared/userrelationattribute.py | 20 +- entity/src/epilot/sdkconfiguration.py | 4 +- 377 files changed, 7105 insertions(+), 2229 deletions(-) delete mode 100755 entity/docs/activity/README.md delete mode 100755 entity/docs/entityimport/README.md delete mode 100755 entity/docs/export/README.md create mode 100755 entity/docs/models/operations/addrelationsrequest.md create mode 100755 entity/docs/models/operations/addrelationsresponse.md create mode 100755 entity/docs/models/operations/attachactivityrequest.md create mode 100755 entity/docs/models/operations/attachactivityresponse.md create mode 100755 entity/docs/models/operations/autocomplete200applicationjson.md create mode 100755 entity/docs/models/operations/autocompleterequest.md create mode 100755 entity/docs/models/operations/autocompleteresponse.md create mode 100755 entity/docs/models/operations/createactivityrequest.md create mode 100755 entity/docs/models/operations/createactivityresponse.md create mode 100755 entity/docs/models/operations/createentityrequest.md create mode 100755 entity/docs/models/operations/createentityresponse.md create mode 100755 entity/docs/models/operations/createsavedviewresponse.md create mode 100755 entity/docs/models/operations/deleteentityrequest.md create mode 100755 entity/docs/models/operations/deleteentityresponse.md create mode 100755 entity/docs/models/operations/deleterelationrequest.md create mode 100755 entity/docs/models/operations/deleterelationresponse.md create mode 100755 entity/docs/models/operations/deletesavedviewrequest.md create mode 100755 entity/docs/models/operations/deletesavedviewresponse.md create mode 100755 entity/docs/models/operations/deleteschemarequest.md create mode 100755 entity/docs/models/operations/deleteschemaresponse.md create mode 100755 entity/docs/models/operations/exportentitiesrequest.md create mode 100755 entity/docs/models/operations/exportentitiesresponse.md create mode 100755 entity/docs/models/operations/getactivityrequest.md create mode 100755 entity/docs/models/operations/getactivityresponse.md create mode 100755 entity/docs/models/operations/getentity200applicationjson.md create mode 100755 entity/docs/models/operations/getentityactivityfeed200applicationjson.md create mode 100755 entity/docs/models/operations/getentityactivityfeedrequest.md create mode 100755 entity/docs/models/operations/getentityactivityfeedresponse.md create mode 100755 entity/docs/models/operations/getentityrequest.md create mode 100755 entity/docs/models/operations/getentityresponse.md create mode 100755 entity/docs/models/operations/getrelationsrequest.md create mode 100755 entity/docs/models/operations/getrelationsresponse.md create mode 100755 entity/docs/models/operations/getrelationsv2request.md create mode 100755 entity/docs/models/operations/getrelationsv2response.md create mode 100755 entity/docs/models/operations/getsavedview200applicationjson.md create mode 100755 entity/docs/models/operations/getsavedviewrequest.md create mode 100755 entity/docs/models/operations/getsavedviewresponse.md create mode 100755 entity/docs/models/operations/getschemarequest.md create mode 100755 entity/docs/models/operations/getschemaresponse.md create mode 100755 entity/docs/models/operations/getschemaversions200applicationjson.md create mode 100755 entity/docs/models/operations/getschemaversionsrequest.md create mode 100755 entity/docs/models/operations/getschemaversionsresponse.md create mode 100755 entity/docs/models/operations/gettaxonomyrequest.md create mode 100755 entity/docs/models/operations/gettaxonomyresponse.md create mode 100755 entity/docs/models/operations/importentitiesrequest.md create mode 100755 entity/docs/models/operations/importentitiesresponse.md create mode 100755 entity/docs/models/operations/listsavedviews200applicationjson.md create mode 100755 entity/docs/models/operations/listsavedviewsresponse.md create mode 100755 entity/docs/models/operations/listschemablueprints200applicationjson.md create mode 100755 entity/docs/models/operations/listschemablueprintsresponse.md create mode 100755 entity/docs/models/operations/listschemas200applicationjson.md create mode 100755 entity/docs/models/operations/listschemasrequest.md create mode 100755 entity/docs/models/operations/listschemasresponse.md create mode 100755 entity/docs/models/operations/listtaxonomies200applicationjson.md create mode 100755 entity/docs/models/operations/listtaxonomiesresponse.md create mode 100755 entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md create mode 100755 entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md create mode 100755 entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md create mode 100755 entity/docs/models/operations/patchentityrequest.md create mode 100755 entity/docs/models/operations/patchentityresponse.md create mode 100755 entity/docs/models/operations/putschemarequest.md create mode 100755 entity/docs/models/operations/putschemaresponse.md create mode 100755 entity/docs/models/operations/searchentitiesresponse.md create mode 100755 entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md create mode 100755 entity/docs/models/operations/taxonomiesclassificationssearchrequest.md create mode 100755 entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md create mode 100755 entity/docs/models/operations/taxonomiesclassificationssearchresponse.md create mode 100755 entity/docs/models/operations/taxonomyautocomplete200applicationjson.md create mode 100755 entity/docs/models/operations/taxonomyautocompleterequest.md create mode 100755 entity/docs/models/operations/taxonomyautocompleteresponse.md create mode 100755 entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md create mode 100755 entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md create mode 100755 entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md create mode 100755 entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md create mode 100755 entity/docs/models/operations/updateentityrequest.md create mode 100755 entity/docs/models/operations/updateentityresponse.md create mode 100755 entity/docs/models/operations/updaterelationrequest.md create mode 100755 entity/docs/models/operations/updaterelationrequestbody.md create mode 100755 entity/docs/models/operations/updaterelationresponse.md create mode 100755 entity/docs/models/operations/updatesavedviewrequest.md create mode 100755 entity/docs/models/operations/updatesavedviewresponse.md create mode 100755 entity/docs/models/operations/upsertentityrequest.md create mode 100755 entity/docs/models/operations/upsertentityrequestbody.md create mode 100755 entity/docs/models/operations/upsertentityresponse.md create mode 100755 entity/docs/models/shared/activity.md create mode 100755 entity/docs/models/shared/activityitem.md create mode 100755 entity/docs/models/shared/addressrelationattribute.md create mode 100755 entity/docs/models/shared/addressrelationattributeconstraints.md create mode 100755 entity/docs/models/shared/addressrelationattributeinfohelpers.md create mode 100755 entity/docs/models/shared/addressrelationattributetype.md create mode 100755 entity/docs/models/shared/automationattribute.md create mode 100755 entity/docs/models/shared/automationattributeconstraints.md create mode 100755 entity/docs/models/shared/automationattributeinfohelpers.md create mode 100755 entity/docs/models/shared/automationattributetype.md create mode 100755 entity/docs/models/shared/booleanattribute.md create mode 100755 entity/docs/models/shared/booleanattributeconstraints.md create mode 100755 entity/docs/models/shared/booleanattributeinfohelpers.md create mode 100755 entity/docs/models/shared/booleanattributetype.md create mode 100755 entity/docs/models/shared/classificationsupdate.md create mode 100755 entity/docs/models/shared/computedattribute.md create mode 100755 entity/docs/models/shared/computedattributeconstraints.md create mode 100755 entity/docs/models/shared/computedattributeinfohelpers.md create mode 100755 entity/docs/models/shared/computedattributetype.md create mode 100755 entity/docs/models/shared/consentattribute.md create mode 100755 entity/docs/models/shared/consentattributeconstraints.md create mode 100755 entity/docs/models/shared/consentattributeinfohelpers.md create mode 100755 entity/docs/models/shared/consentattributetype.md create mode 100755 entity/docs/models/shared/countryattribute.md create mode 100755 entity/docs/models/shared/countryattributeconstraints.md create mode 100755 entity/docs/models/shared/countryattributeinfohelpers.md create mode 100755 entity/docs/models/shared/countryattributetype.md create mode 100755 entity/docs/models/shared/currencyattribute.md create mode 100755 entity/docs/models/shared/currencyattributeconstraints.md create mode 100755 entity/docs/models/shared/currencyattributecurrency1.md create mode 100755 entity/docs/models/shared/currencyattributeinfohelpers.md create mode 100755 entity/docs/models/shared/currencyattributetype.md create mode 100755 entity/docs/models/shared/dateattribute.md create mode 100755 entity/docs/models/shared/dateattributeconstraints.md create mode 100755 entity/docs/models/shared/dateattributeinfohelpers.md create mode 100755 entity/docs/models/shared/dateattributetype.md create mode 100755 entity/docs/models/shared/entitycapability.md create mode 100755 entity/docs/models/shared/entitydefaultcreate.md create mode 100755 entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md create mode 100755 entity/docs/models/shared/entitydefaultcreateviewtype.md create mode 100755 entity/docs/models/shared/entitydefaultedit.md create mode 100755 entity/docs/models/shared/entitydefaultedittablemenuoptions.md create mode 100755 entity/docs/models/shared/entitydefaulteditviewtype.md create mode 100755 entity/docs/models/shared/entitydefaulttable.md create mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems1.md create mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems1type.md create mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems2.md create mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems2type.md create mode 100755 entity/docs/models/shared/entitydefaulttablenavbaractions.md create mode 100755 entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md create mode 100755 entity/docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md create mode 100755 entity/docs/models/shared/entitydefaulttableviewtype.md create mode 100755 entity/docs/models/shared/entityimportparams.md create mode 100755 entity/docs/models/shared/entityimportparamss3reference.md create mode 100755 entity/docs/models/shared/entityoperation.md create mode 100755 entity/docs/models/shared/entityoperationdiff.md create mode 100755 entity/docs/models/shared/entityoperationoperation.md create mode 100755 entity/docs/models/shared/entityoperationparams.md create mode 100755 entity/docs/models/shared/entityschema.md create mode 100755 entity/docs/models/shared/entityschemagroupsettings.md create mode 100755 entity/docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md create mode 100755 entity/docs/models/shared/entityschemaitem.md create mode 100755 entity/docs/models/shared/entityschemaitemgroupsettings.md create mode 100755 entity/docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md create mode 100755 entity/docs/models/shared/entityschemaitemsource.md create mode 100755 entity/docs/models/shared/entityschemaitemuiconfig.md create mode 100755 entity/docs/models/shared/entityschemaitemuiconfiglistitem.md create mode 100755 entity/docs/models/shared/entityschemaitemuiconfigsharing.md create mode 100755 entity/docs/models/shared/entityschemauiconfig.md create mode 100755 entity/docs/models/shared/entityschemauiconfiglistitem.md create mode 100755 entity/docs/models/shared/entityschemauiconfigsharing.md create mode 100755 entity/docs/models/shared/entitysearchparams.md create mode 100755 entity/docs/models/shared/entitysearchparamsaggs.md create mode 100755 entity/docs/models/shared/entitysearchresults.md create mode 100755 entity/docs/models/shared/entitysearchresultsaggregations.md create mode 100755 entity/docs/models/shared/entityviewdisabled.md create mode 100755 entity/docs/models/shared/entityviewdisabledviewtype.md create mode 100755 entity/docs/models/shared/fileattribute.md create mode 100755 entity/docs/models/shared/fileattributeconstraints.md create mode 100755 entity/docs/models/shared/fileattributedefaultaccesscontrol.md create mode 100755 entity/docs/models/shared/fileattributeinfohelpers.md create mode 100755 entity/docs/models/shared/fileattributetype.md create mode 100755 entity/docs/models/shared/getrelationsresp.md create mode 100755 entity/docs/models/shared/getrelationsrespwithpagination.md create mode 100755 entity/docs/models/shared/internalattribute.md create mode 100755 entity/docs/models/shared/internalattributeconstraints.md create mode 100755 entity/docs/models/shared/internalattributeinfohelpers.md create mode 100755 entity/docs/models/shared/internalattributetype.md create mode 100755 entity/docs/models/shared/internaluserattribute.md create mode 100755 entity/docs/models/shared/internaluserattributeconstraints.md create mode 100755 entity/docs/models/shared/internaluserattributeinfohelpers.md create mode 100755 entity/docs/models/shared/internaluserattributetype.md create mode 100755 entity/docs/models/shared/invitationemailattribute.md create mode 100755 entity/docs/models/shared/invitationemailattributeconstraints.md create mode 100755 entity/docs/models/shared/invitationemailattributeinfohelpers.md create mode 100755 entity/docs/models/shared/invitationemailattributetype.md create mode 100755 entity/docs/models/shared/linkattribute.md create mode 100755 entity/docs/models/shared/linkattributeconstraints.md create mode 100755 entity/docs/models/shared/linkattributeinfohelpers.md create mode 100755 entity/docs/models/shared/linkattributetype.md create mode 100755 entity/docs/models/shared/multiselectattribute.md create mode 100755 entity/docs/models/shared/multiselectattributeconstraints.md create mode 100755 entity/docs/models/shared/multiselectattributeinfohelpers.md create mode 100755 entity/docs/models/shared/multiselectattributeoptions2.md create mode 100755 entity/docs/models/shared/multiselectattributetype.md create mode 100755 entity/docs/models/shared/numberattribute.md create mode 100755 entity/docs/models/shared/numberattributeconstraints.md create mode 100755 entity/docs/models/shared/numberattributeinfohelpers.md create mode 100755 entity/docs/models/shared/numberattributetype.md create mode 100755 entity/docs/models/shared/orderedlistattribute.md create mode 100755 entity/docs/models/shared/orderedlistattributeconstraints.md create mode 100755 entity/docs/models/shared/orderedlistattributeinfohelpers.md create mode 100755 entity/docs/models/shared/orderedlistattributetype.md create mode 100755 entity/docs/models/shared/partnerstatusattribute.md create mode 100755 entity/docs/models/shared/partnerstatusattributeconstraints.md create mode 100755 entity/docs/models/shared/partnerstatusattributeinfohelpers.md create mode 100755 entity/docs/models/shared/partnerstatusattributetype.md create mode 100755 entity/docs/models/shared/paymentmethodrelationattribute.md create mode 100755 entity/docs/models/shared/paymentmethodrelationattributeconstraints.md create mode 100755 entity/docs/models/shared/paymentmethodrelationattributeinfohelpers.md create mode 100755 entity/docs/models/shared/paymentmethodrelationattributetype.md create mode 100755 entity/docs/models/shared/purposeattribute.md create mode 100755 entity/docs/models/shared/purposeattributeconstraints.md create mode 100755 entity/docs/models/shared/purposeattributeinfohelpers.md create mode 100755 entity/docs/models/shared/purposeattributetype.md create mode 100755 entity/docs/models/shared/redirectentityview.md create mode 100755 entity/docs/models/shared/redirectentityviewviewtype.md create mode 100755 entity/docs/models/shared/relationattribute.md create mode 100755 entity/docs/models/shared/relationattributeactions.md create mode 100755 entity/docs/models/shared/relationattributeactionsactiontype.md create mode 100755 entity/docs/models/shared/relationattributeconstraints.md create mode 100755 entity/docs/models/shared/relationattributedrawersize.md create mode 100755 entity/docs/models/shared/relationattributeeditmode.md create mode 100755 entity/docs/models/shared/relationattributeinfohelpers.md create mode 100755 entity/docs/models/shared/relationattributerelationaffinitymode.md create mode 100755 entity/docs/models/shared/relationattributerelationtype.md create mode 100755 entity/docs/models/shared/relationattributetype.md create mode 100755 entity/docs/models/shared/relationitem.md create mode 100755 entity/docs/models/shared/repeatableattribute.md create mode 100755 entity/docs/models/shared/repeatableattributeconstraints.md create mode 100755 entity/docs/models/shared/repeatableattributeinfohelpers.md create mode 100755 entity/docs/models/shared/repeatableattributerelationaffinitymode.md create mode 100755 entity/docs/models/shared/repeatableattributetype.md create mode 100755 entity/docs/models/shared/savedview.md create mode 100755 entity/docs/models/shared/savedviewcreatedby1.md create mode 100755 entity/docs/models/shared/savedviewitem.md create mode 100755 entity/docs/models/shared/savedviewitemcreatedby1.md create mode 100755 entity/docs/models/shared/searchmappings.md create mode 100755 entity/docs/models/shared/searchmappingstype.md create mode 100755 entity/docs/models/shared/security.md create mode 100755 entity/docs/models/shared/selectattribute.md create mode 100755 entity/docs/models/shared/selectattributeconstraints.md create mode 100755 entity/docs/models/shared/selectattributeinfohelpers.md create mode 100755 entity/docs/models/shared/selectattributeoptions1.md create mode 100755 entity/docs/models/shared/selectattributetype.md create mode 100755 entity/docs/models/shared/sequenceattribute.md create mode 100755 entity/docs/models/shared/sequenceattributeconstraints.md create mode 100755 entity/docs/models/shared/sequenceattributeinfohelpers.md create mode 100755 entity/docs/models/shared/sequenceattributetype.md create mode 100755 entity/docs/models/shared/statusattribute.md create mode 100755 entity/docs/models/shared/statusattributeconstraints.md create mode 100755 entity/docs/models/shared/statusattributeinfohelpers.md create mode 100755 entity/docs/models/shared/statusattributeoptions2.md create mode 100755 entity/docs/models/shared/statusattributetype.md create mode 100755 entity/docs/models/shared/summaryattribute.md create mode 100755 entity/docs/models/shared/summaryfield.md create mode 100755 entity/docs/models/shared/tagsattribute.md create mode 100755 entity/docs/models/shared/tagsattributeconstraints.md create mode 100755 entity/docs/models/shared/tagsattributeinfohelpers.md create mode 100755 entity/docs/models/shared/tagsattributetype.md create mode 100755 entity/docs/models/shared/taxonomy.md create mode 100755 entity/docs/models/shared/taxonomyclassification.md create mode 100755 entity/docs/models/shared/textattribute.md create mode 100755 entity/docs/models/shared/textattributeconstraints.md create mode 100755 entity/docs/models/shared/textattributeinfohelpers.md create mode 100755 entity/docs/models/shared/textattributetype.md create mode 100755 entity/docs/models/shared/userrelationattribute.md create mode 100755 entity/docs/models/shared/userrelationattributeconstraints.md create mode 100755 entity/docs/models/shared/userrelationattributeinfohelpers.md create mode 100755 entity/docs/models/shared/userrelationattributetype.md delete mode 100755 entity/docs/relations/README.md delete mode 100755 entity/docs/savedviews/README.md delete mode 100755 entity/docs/schemas/README.md create mode 100755 entity/docs/sdks/activity/README.md rename entity/docs/{ => sdks}/entities/README.md (50%) create mode 100755 entity/docs/sdks/entityimport/README.md rename entity/docs/{ => sdks}/epilot/README.md (100%) create mode 100755 entity/docs/sdks/export/README.md create mode 100755 entity/docs/sdks/relations/README.md create mode 100755 entity/docs/sdks/savedviews/README.md create mode 100755 entity/docs/sdks/schemas/README.md create mode 100755 entity/docs/sdks/taxonomy/README.md delete mode 100755 entity/docs/taxonomy/README.md diff --git a/entity/README.md b/entity/README.md index 7e67227b7..717785c1d 100755 --- a/entity/README.md +++ b/entity/README.md @@ -40,65 +40,65 @@ if res.activity_item is not None: ## Available Resources and Operations -### [activity](docs/activity/README.md) +### [activity](docs/sdks/activity/README.md) -* [attach_activity](docs/activity/README.md#attach_activity) - attachActivity -* [create_activity](docs/activity/README.md#create_activity) - createActivity -* [get_activity](docs/activity/README.md#get_activity) - getActivity -* [get_entity_activity_feed](docs/activity/README.md#get_entity_activity_feed) - getEntityActivityFeed +* [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 -### [entities](docs/entities/README.md) +### [entities](docs/sdks/entities/README.md) -* [autocomplete](docs/entities/README.md#autocomplete) - autocomplete -* [create_entity](docs/entities/README.md#create_entity) - createEntity -* [delete_entity](docs/entities/README.md#delete_entity) - deleteEntity -* [get_entity](docs/entities/README.md#get_entity) - getEntity -* [patch_entity](docs/entities/README.md#patch_entity) - patchEntity -* [search_entities](docs/entities/README.md#search_entities) - searchEntities -* [update_entity](docs/entities/README.md#update_entity) - updateEntity -* [upsert_entity](docs/entities/README.md#upsert_entity) - upsertEntity +* [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 -### [entity_import](docs/entityimport/README.md) +### [entity_import](docs/sdks/entityimport/README.md) -* [import_entities](docs/entityimport/README.md#import_entities) - Import Entities +* [import_entities](docs/sdks/entityimport/README.md#import_entities) - Import Entities -### [export](docs/export/README.md) +### [export](docs/sdks/export/README.md) -* [export_entities](docs/export/README.md#export_entities) - exportEntities +* [export_entities](docs/sdks/export/README.md#export_entities) - exportEntities -### [relations](docs/relations/README.md) +### [relations](docs/sdks/relations/README.md) -* [add_relations](docs/relations/README.md#add_relations) - addRelations -* [delete_relation](docs/relations/README.md#delete_relation) - deleteRelation -* [get_relations](docs/relations/README.md#get_relations) - getRelations -* [get_relations_v2](docs/relations/README.md#get_relations_v2) - getRelationsV2 -* [update_relation](docs/relations/README.md#update_relation) - updateRelation +* [add_relations](docs/sdks/relations/README.md#add_relations) - addRelations +* [delete_relation](docs/sdks/relations/README.md#delete_relation) - deleteRelation +* [get_relations](docs/sdks/relations/README.md#get_relations) - getRelations +* [get_relations_v2](docs/sdks/relations/README.md#get_relations_v2) - getRelationsV2 +* [update_relation](docs/sdks/relations/README.md#update_relation) - updateRelation -### [saved_views](docs/savedviews/README.md) +### [saved_views](docs/sdks/savedviews/README.md) -* [create_saved_view](docs/savedviews/README.md#create_saved_view) - createSavedView -* [delete_saved_view](docs/savedviews/README.md#delete_saved_view) - deleteSavedView -* [get_saved_view](docs/savedviews/README.md#get_saved_view) - getSavedView -* [list_saved_views](docs/savedviews/README.md#list_saved_views) - listSavedViews -* [update_saved_view](docs/savedviews/README.md#update_saved_view) - updateSavedView +* [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_saved_views](docs/sdks/savedviews/README.md#list_saved_views) - listSavedViews +* [update_saved_view](docs/sdks/savedviews/README.md#update_saved_view) - updateSavedView -### [schemas](docs/schemas/README.md) +### [schemas](docs/sdks/schemas/README.md) -* [delete_schema](docs/schemas/README.md#delete_schema) - deleteSchema -* [get_schema](docs/schemas/README.md#get_schema) - getSchema -* [get_schema_versions](docs/schemas/README.md#get_schema_versions) - getSchemaVersions -* [list_schema_blueprints](docs/schemas/README.md#list_schema_blueprints) - listSchemaBlueprints -* [list_schemas](docs/schemas/README.md#list_schemas) - listSchemas -* [list_taxonomy_classifications_for_schema](docs/schemas/README.md#list_taxonomy_classifications_for_schema) - listTaxonomyClassificationsForSchema -* [put_schema](docs/schemas/README.md#put_schema) - putSchema +* [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 -### [taxonomy](docs/taxonomy/README.md) +### [taxonomy](docs/sdks/taxonomy/README.md) -* [get_taxonomy](docs/taxonomy/README.md#get_taxonomy) - getTaxonomy -* [list_taxonomies](docs/taxonomy/README.md#list_taxonomies) - listTaxonomies -* [taxonomies_classifications_search](docs/taxonomy/README.md#taxonomies_classifications_search) - taxonomiesClassificationsSearch -* [taxonomy_autocomplete](docs/taxonomy/README.md#taxonomy_autocomplete) - taxonomyAutocomplete -* [update_classifications_for_taxonomy](docs/taxonomy/README.md#update_classifications_for_taxonomy) - updateClassificationsForTaxonomy +* [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 ### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index e9aab3607..48129aa6b 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -40,4 +40,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.45.2 (2.37.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.45.2 (2.37.2) https://github.com/speakeasy-api/speakeasy + +## 2023-06-10 01:42:07 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.47.0 (2.39.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/docs/activity/README.md b/entity/docs/activity/README.md deleted file mode 100755 index 1d45f2759..000000000 --- a/entity/docs/activity/README.md +++ /dev/null @@ -1,146 +0,0 @@ -# activity - -## Overview - -Entity Events - -### Available Operations - -* [attach_activity](#attach_activity) - attachActivity -* [create_activity](#create_activity) - createActivity -* [get_activity](#get_activity) - getActivity -* [get_entity_activity_feed](#get_entity_activity_feed) - getEntityActivityFeed - -## attach_activity - -Attach existing activity to entity activity feeds - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.AttachActivityRequest( - entities=[ - 'c5955907-aff1-4a3a-afa9-467739251aa5', - ], - id='01F130Q52Q6MWSNS8N2AVXV4JN', -) - -res = s.activity.attach_activity(req) - -if res.activity_item is not None: - # handle response -``` - -## create_activity - -Create an activity that can be displayed in activity feeds. - -- All activites are published as events on the event bus -- Entity mutations are always part of an activity - - -### Example Usage - -```python -import epilot -from epilot.models import operations, shared - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.CreateActivityRequest( - activity=shared.Activity( - message='{{caller}} did something with {{entity payload.entity.id}}.', - payload={ - "quo": 'sequi', - }, - title='My custom activity', - type='MyCustomActivity', - ), - entities=[ - '5ad019da-1ffe-478f-897b-0074f15471b5', - 'e6e13b99-d488-4e1e-91e4-50ad2abd4426', - '9802d502-a94b-4b4f-a3c9-69e9a3efa77d', - 'fb14cd66-ae39-45ef-b9ba-88f3a6699707', - ], -) - -res = s.activity.create_activity(req) - -if res.activity_item is not None: - # handle response -``` - -## get_activity - -Get activity by id - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.GetActivityRequest( - id='01F130Q52Q6MWSNS8N2AVXV4JN', - operations_from=301575, - operations_size=716075, -) - -res = s.activity.get_activity(req) - -if res.activity_item is not None: - # handle response -``` - -## get_entity_activity_feed - -Get activity feed for an entity - - -### Example Usage - -```python -import epilot -import dateutil.parser -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.GetEntityActivityFeedRequest( - after=dateutil.parser.isoparse('2022-06-04T18:23:50.695Z'), - before=dateutil.parser.isoparse('2022-08-14T00:52:14.624Z'), - from_=618016, - id='b6e21419-5989-40af-a563-e2516fe4c8b7', - size=100226, - slug='contact', - type='SyncActivity', -) - -res = s.activity.get_entity_activity_feed(req) - -if res.get_entity_activity_feed_200_application_json_object is not None: - # handle response -``` diff --git a/entity/docs/entityimport/README.md b/entity/docs/entityimport/README.md deleted file mode 100755 index 067f8ae66..000000000 --- a/entity/docs/entityimport/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# entity_import - -### Available Operations - -* [import_entities](#import_entities) - Import Entities - -## import_entities - -This endpoint enables the import of entities into the platform. -The entities should be provided in a CSV format inside an S3 bucket. -This API will return the `job_id`` which can be used to fetch the status of the import process. - - -### Example Usage - -```python -import epilot -from epilot.models import operations, shared - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.ImportEntitiesRequest( - entity_import_params=shared.EntityImportParams( - s3_reference=shared.EntityImportParamsS3Reference( - bucket='my-bucket', - key='imports/my-import.json', - ), - schema='contact', - ), - job_id='abc123', -) - -res = s.entity_import.import_entities(req) - -if res.status_code == 200: - # handle response -``` diff --git a/entity/docs/export/README.md b/entity/docs/export/README.md deleted file mode 100755 index 1643205ea..000000000 --- a/entity/docs/export/README.md +++ /dev/null @@ -1,52 +0,0 @@ -# export - -## Overview - -Export and Import entities via files - -### Available Operations - -* [export_entities](#export_entities) - exportEntities - -## export_entities - -create export file of entities - -### Example Usage - -```python -import epilot -from epilot.models import operations, shared - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.ExportEntitiesRequest( - entity_search_params=shared.EntitySearchParams( - aggs={ - "tempore": 'accusamus', - }, - fields_=[ - 'enim', - 'dolorem', - ], - from_=957451, - hydrate=False, - include_scores=False, - q='_schema:contact AND status:active', - size=518201, - sort='_created_at:desc', - ), - is_template=False, - job_id='abc123', - language='nihil', -) - -res = s.export.export_entities(req) - -if res.status_code == 200: - # handle response -``` diff --git a/entity/docs/models/operations/addrelationsrequest.md b/entity/docs/models/operations/addrelationsrequest.md new file mode 100755 index 000000000..639381cd2 --- /dev/null +++ b/entity/docs/models/operations/addrelationsrequest.md @@ -0,0 +1,11 @@ +# AddRelationsRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request_body` | list[[shared.RelationItem](../../models/shared/relationitem.md)] | :heavy_minus_sign: | N/A | | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/addrelationsresponse.md b/entity/docs/models/operations/addrelationsresponse.md new file mode 100755 index 000000000..f8413504b --- /dev/null +++ b/entity/docs/models/operations/addrelationsresponse.md @@ -0,0 +1,11 @@ +# AddRelationsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `relation_item` | [Optional[shared.RelationItem]](../../models/shared/relationitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/attachactivityrequest.md b/entity/docs/models/operations/attachactivityrequest.md new file mode 100755 index 000000000..871cb14d9 --- /dev/null +++ b/entity/docs/models/operations/attachactivityrequest.md @@ -0,0 +1,9 @@ +# AttachActivityRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `entities` | list[*str*] | :heavy_minus_sign: | Comma-separated list of entities which the activity primarily concerns | | +| `id` | *str* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | \ No newline at end of file diff --git a/entity/docs/models/operations/attachactivityresponse.md b/entity/docs/models/operations/attachactivityresponse.md new file mode 100755 index 000000000..a77362bd2 --- /dev/null +++ b/entity/docs/models/operations/attachactivityresponse.md @@ -0,0 +1,11 @@ +# AttachActivityResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/autocomplete200applicationjson.md b/entity/docs/models/operations/autocomplete200applicationjson.md new file mode 100755 index 000000000..a2806b21c --- /dev/null +++ b/entity/docs/models/operations/autocomplete200applicationjson.md @@ -0,0 +1,11 @@ +# Autocomplete200ApplicationJSON + +Success + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `results` | list[*Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/operations/autocompleterequest.md b/entity/docs/models/operations/autocompleterequest.md new file mode 100755 index 000000000..788da2934 --- /dev/null +++ b/entity/docs/models/operations/autocompleterequest.md @@ -0,0 +1,11 @@ +# AutocompleteRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | +| `attribute` | *str* | :heavy_check_mark: | Autocomplete attribute | _tags | +| `input` | *Optional[str]* | :heavy_minus_sign: | Input to autocomplete | | +| `size` | *Optional[int]* | :heavy_minus_sign: | Maximum number of results to return | | +| `slug` | *Optional[str]* | :heavy_minus_sign: | Limit results to entity schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/autocompleteresponse.md b/entity/docs/models/operations/autocompleteresponse.md new file mode 100755 index 000000000..be4114d93 --- /dev/null +++ b/entity/docs/models/operations/autocompleteresponse.md @@ -0,0 +1,11 @@ +# AutocompleteResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `autocomplete_200_application_json_object` | [Optional[Autocomplete200ApplicationJSON]](../../models/operations/autocomplete200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/createactivityrequest.md b/entity/docs/models/operations/createactivityrequest.md new file mode 100755 index 000000000..eaf600128 --- /dev/null +++ b/entity/docs/models/operations/createactivityrequest.md @@ -0,0 +1,9 @@ +# CreateActivityRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `activity` | [Optional[shared.Activity]](../../models/shared/activity.md) | :heavy_minus_sign: | N/A | +| `entities` | list[*str*] | :heavy_minus_sign: | Comma-separated list of entities which the activity primarily concerns | \ No newline at end of file diff --git a/entity/docs/models/operations/createactivityresponse.md b/entity/docs/models/operations/createactivityresponse.md new file mode 100755 index 000000000..0970e2bfb --- /dev/null +++ b/entity/docs/models/operations/createactivityresponse.md @@ -0,0 +1,11 @@ +# CreateActivityResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityrequest.md b/entity/docs/models/operations/createentityrequest.md new file mode 100755 index 000000000..90b2700ee --- /dev/null +++ b/entity/docs/models/operations/createentityrequest.md @@ -0,0 +1,11 @@ +# CreateEntityRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityresponse.md b/entity/docs/models/operations/createentityresponse.md new file mode 100755 index 000000000..ed297bcb1 --- /dev/null +++ b/entity/docs/models/operations/createentityresponse.md @@ -0,0 +1,11 @@ +# CreateEntityResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/createsavedviewresponse.md b/entity/docs/models/operations/createsavedviewresponse.md new file mode 100755 index 000000000..1dee22cff --- /dev/null +++ b/entity/docs/models/operations/createsavedviewresponse.md @@ -0,0 +1,11 @@ +# CreateSavedViewResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `saved_view_item` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteentityrequest.md b/entity/docs/models/operations/deleteentityrequest.md new file mode 100755 index 000000000..2d034cf52 --- /dev/null +++ b/entity/docs/models/operations/deleteentityrequest.md @@ -0,0 +1,10 @@ +# DeleteEntityRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteentityresponse.md b/entity/docs/models/operations/deleteentityresponse.md new file mode 100755 index 000000000..0eac5c5a8 --- /dev/null +++ b/entity/docs/models/operations/deleteentityresponse.md @@ -0,0 +1,10 @@ +# DeleteEntityResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/deleterelationrequest.md b/entity/docs/models/operations/deleterelationrequest.md new file mode 100755 index 000000000..87257128d --- /dev/null +++ b/entity/docs/models/operations/deleterelationrequest.md @@ -0,0 +1,12 @@ +# DeleteRelationRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `attribute` | *str* | :heavy_check_mark: | The attribute that express meaning | | +| `entity_id` | *str* | :heavy_check_mark: | The attribute that express meaning | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleterelationresponse.md b/entity/docs/models/operations/deleterelationresponse.md new file mode 100755 index 000000000..56949700d --- /dev/null +++ b/entity/docs/models/operations/deleterelationresponse.md @@ -0,0 +1,10 @@ +# DeleteRelationResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/deletesavedviewrequest.md b/entity/docs/models/operations/deletesavedviewrequest.md new file mode 100755 index 000000000..2d3befa8e --- /dev/null +++ b/entity/docs/models/operations/deletesavedviewrequest.md @@ -0,0 +1,8 @@ +# DeleteSavedViewRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | View id | \ No newline at end of file diff --git a/entity/docs/models/operations/deletesavedviewresponse.md b/entity/docs/models/operations/deletesavedviewresponse.md new file mode 100755 index 000000000..d8a8b0745 --- /dev/null +++ b/entity/docs/models/operations/deletesavedviewresponse.md @@ -0,0 +1,10 @@ +# DeleteSavedViewResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteschemarequest.md b/entity/docs/models/operations/deleteschemarequest.md new file mode 100755 index 000000000..6de6bc920 --- /dev/null +++ b/entity/docs/models/operations/deleteschemarequest.md @@ -0,0 +1,8 @@ +# DeleteSchemaRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteschemaresponse.md b/entity/docs/models/operations/deleteschemaresponse.md new file mode 100755 index 000000000..5422bcac7 --- /dev/null +++ b/entity/docs/models/operations/deleteschemaresponse.md @@ -0,0 +1,10 @@ +# DeleteSchemaResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/exportentitiesrequest.md b/entity/docs/models/operations/exportentitiesrequest.md new file mode 100755 index 000000000..7143d4571 --- /dev/null +++ b/entity/docs/models/operations/exportentitiesrequest.md @@ -0,0 +1,11 @@ +# ExportEntitiesRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `entity_search_params` | [Optional[shared.EntitySearchParams]](../../models/shared/entitysearchparams.md) | :heavy_minus_sign: | N/A | | +| `is_template` | *Optional[bool]* | :heavy_minus_sign: | Pass 'true' to generate import template | | +| `job_id` | *Optional[str]* | :heavy_minus_sign: | Export Job Id to get the result | abc123 | +| `language` | *Optional[str]* | :heavy_minus_sign: | Export headers translation language | | \ No newline at end of file diff --git a/entity/docs/models/operations/exportentitiesresponse.md b/entity/docs/models/operations/exportentitiesresponse.md new file mode 100755 index 000000000..ada438178 --- /dev/null +++ b/entity/docs/models/operations/exportentitiesresponse.md @@ -0,0 +1,10 @@ +# ExportEntitiesResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getactivityrequest.md b/entity/docs/models/operations/getactivityrequest.md new file mode 100755 index 000000000..b0e3dff9a --- /dev/null +++ b/entity/docs/models/operations/getactivityrequest.md @@ -0,0 +1,10 @@ +# GetActivityRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `id` | *str* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `operations_from` | *Optional[int]* | :heavy_minus_sign: | Pagination offset for operations
| | +| `operations_size` | *Optional[int]* | :heavy_minus_sign: | Maximum number of operations to include in response (default: 10)
| | \ No newline at end of file diff --git a/entity/docs/models/operations/getactivityresponse.md b/entity/docs/models/operations/getactivityresponse.md new file mode 100755 index 000000000..179ae8ae2 --- /dev/null +++ b/entity/docs/models/operations/getactivityresponse.md @@ -0,0 +1,11 @@ +# GetActivityResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getentity200applicationjson.md b/entity/docs/models/operations/getentity200applicationjson.md new file mode 100755 index 000000000..57b8c20e7 --- /dev/null +++ b/entity/docs/models/operations/getentity200applicationjson.md @@ -0,0 +1,11 @@ +# GetEntity200ApplicationJSON + +Success + + +## Fields + +| Field | Type | Required | Description | +| ---------------------- | ---------------------- | ---------------------- | ---------------------- | +| `entity` | dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `relations` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeed200applicationjson.md b/entity/docs/models/operations/getentityactivityfeed200applicationjson.md new file mode 100755 index 000000000..607e07ad4 --- /dev/null +++ b/entity/docs/models/operations/getentityactivityfeed200applicationjson.md @@ -0,0 +1,11 @@ +# GetEntityActivityFeed200ApplicationJSON + +Success + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `results` | list[[shared.ActivityItem](../../models/shared/activityitem.md)] | :heavy_minus_sign: | N/A | | +| `total` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeedrequest.md b/entity/docs/models/operations/getentityactivityfeedrequest.md new file mode 100755 index 000000000..f5ef71847 --- /dev/null +++ b/entity/docs/models/operations/getentityactivityfeedrequest.md @@ -0,0 +1,14 @@ +# GetEntityActivityFeedRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Get activities after this timestamp | | +| `before` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | get activities before this timestamp | | +| `from_` | *Optional[int]* | :heavy_minus_sign: | start from page | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `size` | *Optional[int]* | :heavy_minus_sign: | max number of results to return | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | +| `type` | *Optional[str]* | :heavy_minus_sign: | Activity type | SyncActivity | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeedresponse.md b/entity/docs/models/operations/getentityactivityfeedresponse.md new file mode 100755 index 000000000..a7b37b7a2 --- /dev/null +++ b/entity/docs/models/operations/getentityactivityfeedresponse.md @@ -0,0 +1,11 @@ +# GetEntityActivityFeedResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `get_entity_activity_feed_200_application_json_object` | [Optional[GetEntityActivityFeed200ApplicationJSON]](../../models/operations/getentityactivityfeed200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityrequest.md b/entity/docs/models/operations/getentityrequest.md new file mode 100755 index 000000000..3b1f862d1 --- /dev/null +++ b/entity/docs/models/operations/getentityrequest.md @@ -0,0 +1,10 @@ +# GetEntityRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityresponse.md b/entity/docs/models/operations/getentityresponse.md new file mode 100755 index 000000000..0078ae03b --- /dev/null +++ b/entity/docs/models/operations/getentityresponse.md @@ -0,0 +1,11 @@ +# GetEntityResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `get_entity_200_application_json_object` | [Optional[GetEntity200ApplicationJSON]](../../models/operations/getentity200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsrequest.md b/entity/docs/models/operations/getrelationsrequest.md new file mode 100755 index 000000000..b0b69507e --- /dev/null +++ b/entity/docs/models/operations/getrelationsrequest.md @@ -0,0 +1,11 @@ +# GetRelationsRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsresponse.md b/entity/docs/models/operations/getrelationsresponse.md new file mode 100755 index 000000000..3eedea582 --- /dev/null +++ b/entity/docs/models/operations/getrelationsresponse.md @@ -0,0 +1,11 @@ +# GetRelationsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `get_relations_resp` | list[*Any*] | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv2request.md b/entity/docs/models/operations/getrelationsv2request.md new file mode 100755 index 000000000..a3f19f6c7 --- /dev/null +++ b/entity/docs/models/operations/getrelationsv2request.md @@ -0,0 +1,15 @@ +# GetRelationsV2Request + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in results | | +| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | +| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | +| `query` | *Optional[str]* | :heavy_minus_sign: | Input to filter search results | | +| `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv2response.md b/entity/docs/models/operations/getrelationsv2response.md new file mode 100755 index 000000000..6e68d54c5 --- /dev/null +++ b/entity/docs/models/operations/getrelationsv2response.md @@ -0,0 +1,11 @@ +# GetRelationsV2Response + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `get_relations_resp_with_pagination` | [Optional[shared.GetRelationsRespWithPagination]](../../models/shared/getrelationsrespwithpagination.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getsavedview200applicationjson.md b/entity/docs/models/operations/getsavedview200applicationjson.md new file mode 100755 index 000000000..882160635 --- /dev/null +++ b/entity/docs/models/operations/getsavedview200applicationjson.md @@ -0,0 +1,10 @@ +# GetSavedView200ApplicationJSON + +Success + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `view` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getsavedviewrequest.md b/entity/docs/models/operations/getsavedviewrequest.md new file mode 100755 index 000000000..926155d37 --- /dev/null +++ b/entity/docs/models/operations/getsavedviewrequest.md @@ -0,0 +1,8 @@ +# GetSavedViewRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *str* | :heavy_check_mark: | View id | \ No newline at end of file diff --git a/entity/docs/models/operations/getsavedviewresponse.md b/entity/docs/models/operations/getsavedviewresponse.md new file mode 100755 index 000000000..e1037d189 --- /dev/null +++ b/entity/docs/models/operations/getsavedviewresponse.md @@ -0,0 +1,11 @@ +# GetSavedViewResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `get_saved_view_200_application_json_object` | [Optional[GetSavedView200ApplicationJSON]](../../models/operations/getsavedview200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemarequest.md b/entity/docs/models/operations/getschemarequest.md new file mode 100755 index 000000000..8c26cdd5c --- /dev/null +++ b/entity/docs/models/operations/getschemarequest.md @@ -0,0 +1,9 @@ +# GetSchemaRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaresponse.md b/entity/docs/models/operations/getschemaresponse.md new file mode 100755 index 000000000..5a1ca705d --- /dev/null +++ b/entity/docs/models/operations/getschemaresponse.md @@ -0,0 +1,11 @@ +# GetSchemaResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `entity_schema_item` | [Optional[shared.EntitySchemaItem]](../../models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversions200applicationjson.md b/entity/docs/models/operations/getschemaversions200applicationjson.md new file mode 100755 index 000000000..c04fd28b3 --- /dev/null +++ b/entity/docs/models/operations/getschemaversions200applicationjson.md @@ -0,0 +1,11 @@ +# GetSchemaVersions200ApplicationJSON + +Success + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `drafts` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | +| `versions` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversionsrequest.md b/entity/docs/models/operations/getschemaversionsrequest.md new file mode 100755 index 000000000..64d754a5d --- /dev/null +++ b/entity/docs/models/operations/getschemaversionsrequest.md @@ -0,0 +1,12 @@ +# GetSchemaVersionsRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `drafts_from` | *Optional[float]* | :heavy_minus_sign: | N/A | | +| `drafts_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | +| `slug` | *str* | :heavy_check_mark: | N/A | contact | +| `versions_from` | *Optional[float]* | :heavy_minus_sign: | N/A | | +| `versions_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversionsresponse.md b/entity/docs/models/operations/getschemaversionsresponse.md new file mode 100755 index 000000000..fd6dbc2c0 --- /dev/null +++ b/entity/docs/models/operations/getschemaversionsresponse.md @@ -0,0 +1,11 @@ +# GetSchemaVersionsResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `get_schema_versions_200_application_json_object` | [Optional[GetSchemaVersions200ApplicationJSON]](../../models/operations/getschemaversions200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/gettaxonomyrequest.md b/entity/docs/models/operations/gettaxonomyrequest.md new file mode 100755 index 000000000..32f13f4e2 --- /dev/null +++ b/entity/docs/models/operations/gettaxonomyrequest.md @@ -0,0 +1,8 @@ +# GetTaxonomyRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | +| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug to return taxonomy for | purpose | \ No newline at end of file diff --git a/entity/docs/models/operations/gettaxonomyresponse.md b/entity/docs/models/operations/gettaxonomyresponse.md new file mode 100755 index 000000000..c16a339e8 --- /dev/null +++ b/entity/docs/models/operations/gettaxonomyresponse.md @@ -0,0 +1,11 @@ +# GetTaxonomyResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `taxonomy` | [Optional[shared.Taxonomy]](../../models/shared/taxonomy.md) | :heavy_minus_sign: | Taxonomy | \ No newline at end of file diff --git a/entity/docs/models/operations/importentitiesrequest.md b/entity/docs/models/operations/importentitiesrequest.md new file mode 100755 index 000000000..29780c4c1 --- /dev/null +++ b/entity/docs/models/operations/importentitiesrequest.md @@ -0,0 +1,9 @@ +# ImportEntitiesRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `entity_import_params` | [Optional[shared.EntityImportParams]](../../models/shared/entityimportparams.md) | :heavy_minus_sign: | N/A | | +| `job_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the import job. This ID is used to track the progress and fetch the result of the import operation. | abc123 | \ No newline at end of file diff --git a/entity/docs/models/operations/importentitiesresponse.md b/entity/docs/models/operations/importentitiesresponse.md new file mode 100755 index 000000000..21ba0c3ff --- /dev/null +++ b/entity/docs/models/operations/importentitiesresponse.md @@ -0,0 +1,10 @@ +# ImportEntitiesResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listsavedviews200applicationjson.md b/entity/docs/models/operations/listsavedviews200applicationjson.md new file mode 100755 index 000000000..1b3bd47f5 --- /dev/null +++ b/entity/docs/models/operations/listsavedviews200applicationjson.md @@ -0,0 +1,10 @@ +# ListSavedViews200ApplicationJSON + +Success + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `results` | list[[shared.SavedViewItem](../../models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listsavedviewsresponse.md b/entity/docs/models/operations/listsavedviewsresponse.md new file mode 100755 index 000000000..6dfa8c87c --- /dev/null +++ b/entity/docs/models/operations/listsavedviewsresponse.md @@ -0,0 +1,11 @@ +# ListSavedViewsResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `list_saved_views_200_application_json_object` | [Optional[ListSavedViews200ApplicationJSON]](../../models/operations/listsavedviews200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemablueprints200applicationjson.md b/entity/docs/models/operations/listschemablueprints200applicationjson.md new file mode 100755 index 000000000..57d194fdb --- /dev/null +++ b/entity/docs/models/operations/listschemablueprints200applicationjson.md @@ -0,0 +1,10 @@ +# ListSchemaBlueprints200ApplicationJSON + +Success + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `results` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemablueprintsresponse.md b/entity/docs/models/operations/listschemablueprintsresponse.md new file mode 100755 index 000000000..d716ace30 --- /dev/null +++ b/entity/docs/models/operations/listschemablueprintsresponse.md @@ -0,0 +1,11 @@ +# ListSchemaBlueprintsResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `list_schema_blueprints_200_application_json_object` | [Optional[ListSchemaBlueprints200ApplicationJSON]](../../models/operations/listschemablueprints200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemas200applicationjson.md b/entity/docs/models/operations/listschemas200applicationjson.md new file mode 100755 index 000000000..fd7595402 --- /dev/null +++ b/entity/docs/models/operations/listschemas200applicationjson.md @@ -0,0 +1,10 @@ +# ListSchemas200ApplicationJSON + +Success + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `results` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemasrequest.md b/entity/docs/models/operations/listschemasrequest.md new file mode 100755 index 000000000..9d5189ba9 --- /dev/null +++ b/entity/docs/models/operations/listschemasrequest.md @@ -0,0 +1,8 @@ +# ListSchemasRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | +| `unpublished` | *Optional[bool]* | :heavy_minus_sign: | Return unpublished draft schemas | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemasresponse.md b/entity/docs/models/operations/listschemasresponse.md new file mode 100755 index 000000000..ed54d27d8 --- /dev/null +++ b/entity/docs/models/operations/listschemasresponse.md @@ -0,0 +1,11 @@ +# ListSchemasResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `list_schemas_200_application_json_object` | [Optional[ListSchemas200ApplicationJSON]](../../models/operations/listschemas200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomies200applicationjson.md b/entity/docs/models/operations/listtaxonomies200applicationjson.md new file mode 100755 index 000000000..57b6fab4c --- /dev/null +++ b/entity/docs/models/operations/listtaxonomies200applicationjson.md @@ -0,0 +1,10 @@ +# ListTaxonomies200ApplicationJSON + +Returns list of taxonomies in an organisation + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `results` | list[[shared.Taxonomy](../../models/shared/taxonomy.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomiesresponse.md b/entity/docs/models/operations/listtaxonomiesresponse.md new file mode 100755 index 000000000..d4badf3e2 --- /dev/null +++ b/entity/docs/models/operations/listtaxonomiesresponse.md @@ -0,0 +1,11 @@ +# ListTaxonomiesResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `list_taxonomies_200_application_json_object` | [Optional[ListTaxonomies200ApplicationJSON]](../../models/operations/listtaxonomies200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomies in an organisation | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md b/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md new file mode 100755 index 000000000..9bee2d403 --- /dev/null +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md @@ -0,0 +1,10 @@ +# ListTaxonomyClassificationsForSchema200ApplicationJSON + +List of taxonomy classifications + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md new file mode 100755 index 000000000..9e1d16f97 --- /dev/null +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md @@ -0,0 +1,11 @@ +# ListTaxonomyClassificationsForSchemaRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `query` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `size` | *Optional[float]* | :heavy_minus_sign: | N/A | | +| `slug` | *str* | :heavy_check_mark: | N/A | contact | +| `taxonomy_slug` | *str* | :heavy_check_mark: | N/A | purpose | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md new file mode 100755 index 000000000..779a9e9d1 --- /dev/null +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md @@ -0,0 +1,11 @@ +# ListTaxonomyClassificationsForSchemaResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `list_taxonomy_classifications_for_schema_200_application_json_object` | [Optional[ListTaxonomyClassificationsForSchema200ApplicationJSON]](../../models/operations/listtaxonomyclassificationsforschema200applicationjson.md) | :heavy_minus_sign: | List of taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/patchentityrequest.md b/entity/docs/models/operations/patchentityrequest.md new file mode 100755 index 000000000..14dd1b0e1 --- /dev/null +++ b/entity/docs/models/operations/patchentityrequest.md @@ -0,0 +1,13 @@ +# PatchEntityRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `request_body` | dict[str, *Any*] | :heavy_check_mark: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for the patch entity to become available in Search API. Useful for large migrations | | +| `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = returns the patch result but doesn't perform the patch. | | +| `id` | *str* | :heavy_check_mark: | Entity Id | | +| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/patchentityresponse.md b/entity/docs/models/operations/patchentityresponse.md new file mode 100755 index 000000000..28fcfc3d0 --- /dev/null +++ b/entity/docs/models/operations/patchentityresponse.md @@ -0,0 +1,11 @@ +# PatchEntityResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/putschemarequest.md b/entity/docs/models/operations/putschemarequest.md new file mode 100755 index 000000000..c9a028b63 --- /dev/null +++ b/entity/docs/models/operations/putschemarequest.md @@ -0,0 +1,10 @@ +# PutSchemaRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `entity_schema` | [Optional[shared.EntitySchema]](../../models/shared/entityschema.md) | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/putschemaresponse.md b/entity/docs/models/operations/putschemaresponse.md new file mode 100755 index 000000000..1455b9a06 --- /dev/null +++ b/entity/docs/models/operations/putschemaresponse.md @@ -0,0 +1,11 @@ +# PutSchemaResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `entity_schema_item` | [Optional[shared.EntitySchemaItem]](../../models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/searchentitiesresponse.md b/entity/docs/models/operations/searchentitiesresponse.md new file mode 100755 index 000000000..ec6a8ae99 --- /dev/null +++ b/entity/docs/models/operations/searchentitiesresponse.md @@ -0,0 +1,12 @@ +# SearchEntitiesResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `entity_search_results` | [Optional[shared.EntitySearchResults]](../../models/shared/entitysearchresults.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `search_entities_200_text_csv_string` | *Optional[str]* | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md b/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md new file mode 100755 index 000000000..5338757ad --- /dev/null +++ b/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md @@ -0,0 +1,10 @@ +# TaxonomiesClassificationsSearch200ApplicationJSON + +Returns list of taxonomy classifications + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md b/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md new file mode 100755 index 000000000..72c3d46d5 --- /dev/null +++ b/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md @@ -0,0 +1,9 @@ +# TaxonomiesClassificationsSearchRequest + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[TaxonomiesClassificationsSearchRequestBody]](../../models/operations/taxonomiesclassificationssearchrequestbody.md) | :heavy_minus_sign: | N/A | +| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md b/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md new file mode 100755 index 000000000..f865d8a3c --- /dev/null +++ b/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md @@ -0,0 +1,8 @@ +# TaxonomiesClassificationsSearchRequestBody + + +## Fields + +| Field | Type | Required | Description | +| -------------------- | -------------------- | -------------------- | -------------------- | +| `classification_ids` | list[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md b/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md new file mode 100755 index 000000000..1313db683 --- /dev/null +++ b/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md @@ -0,0 +1,11 @@ +# TaxonomiesClassificationsSearchResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `taxonomies_classifications_search_200_application_json_object` | [Optional[TaxonomiesClassificationsSearch200ApplicationJSON]](../../models/operations/taxonomiesclassificationssearch200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md b/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md new file mode 100755 index 000000000..697d86e3b --- /dev/null +++ b/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md @@ -0,0 +1,10 @@ +# TaxonomyAutocomplete200ApplicationJSON + +Taxonomy classifications + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocompleterequest.md b/entity/docs/models/operations/taxonomyautocompleterequest.md new file mode 100755 index 000000000..5a8b57d23 --- /dev/null +++ b/entity/docs/models/operations/taxonomyautocompleterequest.md @@ -0,0 +1,10 @@ +# TaxonomyAutocompleteRequest + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | +| `query` | *Optional[str]* | :heavy_minus_sign: | Input to autocomplete | +| `size` | *Optional[float]* | :heavy_minus_sign: | Minimum number of results to return | +| `taxonomy_slug` | *str* | :heavy_check_mark: | Limit results to slug | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocompleteresponse.md b/entity/docs/models/operations/taxonomyautocompleteresponse.md new file mode 100755 index 000000000..1ff7a3962 --- /dev/null +++ b/entity/docs/models/operations/taxonomyautocompleteresponse.md @@ -0,0 +1,11 @@ +# TaxonomyAutocompleteResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `taxonomy_autocomplete_200_application_json_object` | [Optional[TaxonomyAutocomplete200ApplicationJSON]](../../models/operations/taxonomyautocomplete200applicationjson.md) | :heavy_minus_sign: | Taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md new file mode 100755 index 000000000..4518623a3 --- /dev/null +++ b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md @@ -0,0 +1,12 @@ +# UpdateClassificationsForTaxonomy200ApplicationJSON + +Taxonomies classifications + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `created` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | +| `deleted` | [Optional[UpdateClassificationsForTaxonomy200ApplicationJSONDeleted]](../../models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md) | :heavy_minus_sign: | N/A | +| `updated` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md new file mode 100755 index 000000000..7f8d20922 --- /dev/null +++ b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md @@ -0,0 +1,7 @@ +# UpdateClassificationsForTaxonomy200ApplicationJSONDeleted + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md b/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md new file mode 100755 index 000000000..900518fe5 --- /dev/null +++ b/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md @@ -0,0 +1,9 @@ +# UpdateClassificationsForTaxonomyRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `classifications_update` | [Optional[shared.ClassificationsUpdate]](../../models/shared/classificationsupdate.md) | :heavy_minus_sign: | N/A | +| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md b/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md new file mode 100755 index 000000000..c6a7f2e14 --- /dev/null +++ b/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md @@ -0,0 +1,11 @@ +# UpdateClassificationsForTaxonomyResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `update_classifications_for_taxonomy_200_application_json_object` | [Optional[UpdateClassificationsForTaxonomy200ApplicationJSON]](../../models/operations/updateclassificationsfortaxonomy200applicationjson.md) | :heavy_minus_sign: | Taxonomies classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/updateentityrequest.md b/entity/docs/models/operations/updateentityrequest.md new file mode 100755 index 000000000..d16031a1a --- /dev/null +++ b/entity/docs/models/operations/updateentityrequest.md @@ -0,0 +1,12 @@ +# UpdateEntityRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/updateentityresponse.md b/entity/docs/models/operations/updateentityresponse.md new file mode 100755 index 000000000..39082bbbf --- /dev/null +++ b/entity/docs/models/operations/updateentityresponse.md @@ -0,0 +1,11 @@ +# UpdateEntityResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/updaterelationrequest.md b/entity/docs/models/operations/updaterelationrequest.md new file mode 100755 index 000000000..9660a22bb --- /dev/null +++ b/entity/docs/models/operations/updaterelationrequest.md @@ -0,0 +1,13 @@ +# UpdateRelationRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[UpdateRelationRequestBody]](../../models/operations/updaterelationrequestbody.md) | :heavy_minus_sign: | N/A | | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `attribute` | *str* | :heavy_check_mark: | The attribute that express meaning | | +| `entity_id` | *str* | :heavy_check_mark: | The attribute that express meaning | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/updaterelationrequestbody.md b/entity/docs/models/operations/updaterelationrequestbody.md new file mode 100755 index 000000000..f909edeab --- /dev/null +++ b/entity/docs/models/operations/updaterelationrequestbody.md @@ -0,0 +1,8 @@ +# UpdateRelationRequestBody + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `tags` | list[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/updaterelationresponse.md b/entity/docs/models/operations/updaterelationresponse.md new file mode 100755 index 000000000..9dbe52aa1 --- /dev/null +++ b/entity/docs/models/operations/updaterelationresponse.md @@ -0,0 +1,11 @@ +# UpdateRelationResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `relation_item` | [Optional[shared.RelationItem]](../../models/shared/relationitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/updatesavedviewrequest.md b/entity/docs/models/operations/updatesavedviewrequest.md new file mode 100755 index 000000000..6ffa26a00 --- /dev/null +++ b/entity/docs/models/operations/updatesavedviewrequest.md @@ -0,0 +1,9 @@ +# UpdateSavedViewRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `saved_view` | [Optional[shared.SavedView]](../../models/shared/savedview.md) | :heavy_minus_sign: | N/A | +| `id` | *str* | :heavy_check_mark: | View id | \ No newline at end of file diff --git a/entity/docs/models/operations/updatesavedviewresponse.md b/entity/docs/models/operations/updatesavedviewresponse.md new file mode 100755 index 000000000..dd2601088 --- /dev/null +++ b/entity/docs/models/operations/updatesavedviewresponse.md @@ -0,0 +1,11 @@ +# UpdateSavedViewResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `saved_view_item` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityrequest.md b/entity/docs/models/operations/upsertentityrequest.md new file mode 100755 index 000000000..b531e76f2 --- /dev/null +++ b/entity/docs/models/operations/upsertentityrequest.md @@ -0,0 +1,12 @@ +# UpsertEntityRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[UpsertEntityRequestBody]](../../models/operations/upsertentityrequestbody.md) | :heavy_minus_sign: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = return matched entities but don't update them. | | +| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityrequestbody.md b/entity/docs/models/operations/upsertentityrequestbody.md new file mode 100755 index 000000000..f70f81fc7 --- /dev/null +++ b/entity/docs/models/operations/upsertentityrequestbody.md @@ -0,0 +1,9 @@ +# UpsertEntityRequestBody + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `entity` | dict[str, *Any*] | :heavy_check_mark: | N/A | +| `unique_key` | list[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityresponse.md b/entity/docs/models/operations/upsertentityresponse.md new file mode 100755 index 000000000..79729220c --- /dev/null +++ b/entity/docs/models/operations/upsertentityresponse.md @@ -0,0 +1,11 @@ +# UpsertEntityResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/activity.md b/entity/docs/models/shared/activity.md new file mode 100755 index 000000000..f7027948d --- /dev/null +++ b/entity/docs/models/shared/activity.md @@ -0,0 +1,11 @@ +# Activity + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `message` | *str* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | +| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `title` | *str* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | +| `type` | *str* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file diff --git a/entity/docs/models/shared/activityitem.md b/entity/docs/models/shared/activityitem.md new file mode 100755 index 000000000..5fd93b53d --- /dev/null +++ b/entity/docs/models/shared/activityitem.md @@ -0,0 +1,18 @@ +# ActivityItem + +Success + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `caller` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `message` | *str* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | +| `operations` | list[[EntityOperation](../../models/shared/entityoperation.md)] | :heavy_minus_sign: | N/A | | +| `operations_total` | *Optional[int]* | :heavy_minus_sign: | Count of total operations attached to this activity | 1 | +| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | +| `title` | *str* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | +| `type` | *str* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattribute.md b/entity/docs/models/shared/addressrelationattribute.md new file mode 100755 index 000000000..c08767185 --- /dev/null +++ b/entity/docs/models/shared/addressrelationattribute.md @@ -0,0 +1,35 @@ +# AddressRelationAttribute + +Reference to an address attribute of another entity + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[AddressRelationAttributeConstraints]](../../models/shared/addressrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `has_primary` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[AddressRelationAttributeInfoHelpers]](../../models/shared/addressrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[AddressRelationAttributeType]](../../models/shared/addressrelationattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattributeconstraints.md b/entity/docs/models/shared/addressrelationattributeconstraints.md new file mode 100755 index 000000000..60a563a2b --- /dev/null +++ b/entity/docs/models/shared/addressrelationattributeconstraints.md @@ -0,0 +1,11 @@ +# AddressRelationAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattributeinfohelpers.md b/entity/docs/models/shared/addressrelationattributeinfohelpers.md new file mode 100755 index 000000000..64f574691 --- /dev/null +++ b/entity/docs/models/shared/addressrelationattributeinfohelpers.md @@ -0,0 +1,13 @@ +# AddressRelationAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattributetype.md b/entity/docs/models/shared/addressrelationattributetype.md new file mode 100755 index 000000000..591ef24a0 --- /dev/null +++ b/entity/docs/models/shared/addressrelationattributetype.md @@ -0,0 +1,8 @@ +# AddressRelationAttributeType + + +## Values + +| Name | Value | +| ------------------ | ------------------ | +| `RELATION_ADDRESS` | relation_address | \ No newline at end of file diff --git a/entity/docs/models/shared/automationattribute.md b/entity/docs/models/shared/automationattribute.md new file mode 100755 index 000000000..e97b4b423 --- /dev/null +++ b/entity/docs/models/shared/automationattribute.md @@ -0,0 +1,34 @@ +# AutomationAttribute + +Automation entity + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[AutomationAttributeConstraints]](../../models/shared/automationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[AutomationAttributeInfoHelpers]](../../models/shared/automationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[AutomationAttributeType]](../../models/shared/automationattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/automationattributeconstraints.md b/entity/docs/models/shared/automationattributeconstraints.md new file mode 100755 index 000000000..f5497f471 --- /dev/null +++ b/entity/docs/models/shared/automationattributeconstraints.md @@ -0,0 +1,11 @@ +# AutomationAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/automationattributeinfohelpers.md b/entity/docs/models/shared/automationattributeinfohelpers.md new file mode 100755 index 000000000..5dcfbda59 --- /dev/null +++ b/entity/docs/models/shared/automationattributeinfohelpers.md @@ -0,0 +1,13 @@ +# AutomationAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/automationattributetype.md b/entity/docs/models/shared/automationattributetype.md new file mode 100755 index 000000000..f32481040 --- /dev/null +++ b/entity/docs/models/shared/automationattributetype.md @@ -0,0 +1,8 @@ +# AutomationAttributeType + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `AUTOMATION` | automation | \ No newline at end of file diff --git a/entity/docs/models/shared/booleanattribute.md b/entity/docs/models/shared/booleanattribute.md new file mode 100755 index 000000000..751ef8366 --- /dev/null +++ b/entity/docs/models/shared/booleanattribute.md @@ -0,0 +1,34 @@ +# BooleanAttribute + +Yes / No Toggle + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[BooleanAttributeConstraints]](../../models/shared/booleanattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[BooleanAttributeInfoHelpers]](../../models/shared/booleanattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[BooleanAttributeType]](../../models/shared/booleanattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/booleanattributeconstraints.md b/entity/docs/models/shared/booleanattributeconstraints.md new file mode 100755 index 000000000..ed2afa229 --- /dev/null +++ b/entity/docs/models/shared/booleanattributeconstraints.md @@ -0,0 +1,11 @@ +# BooleanAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/booleanattributeinfohelpers.md b/entity/docs/models/shared/booleanattributeinfohelpers.md new file mode 100755 index 000000000..718ce3570 --- /dev/null +++ b/entity/docs/models/shared/booleanattributeinfohelpers.md @@ -0,0 +1,13 @@ +# BooleanAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/booleanattributetype.md b/entity/docs/models/shared/booleanattributetype.md new file mode 100755 index 000000000..42e4baaee --- /dev/null +++ b/entity/docs/models/shared/booleanattributetype.md @@ -0,0 +1,8 @@ +# BooleanAttributeType + + +## Values + +| Name | Value | +| --------- | --------- | +| `BOOLEAN` | boolean | \ No newline at end of file diff --git a/entity/docs/models/shared/classificationsupdate.md b/entity/docs/models/shared/classificationsupdate.md new file mode 100755 index 000000000..b54b24277 --- /dev/null +++ b/entity/docs/models/shared/classificationsupdate.md @@ -0,0 +1,10 @@ +# ClassificationsUpdate + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `create` | list[[TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | +| `delete` | list[*str*] | :heavy_minus_sign: | N/A | +| `update` | list[[TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattribute.md b/entity/docs/models/shared/computedattribute.md new file mode 100755 index 000000000..2a18cb50f --- /dev/null +++ b/entity/docs/models/shared/computedattribute.md @@ -0,0 +1,34 @@ +# ComputedAttribute + +An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[ComputedAttributeConstraints]](../../models/shared/computedattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[ComputedAttributeInfoHelpers]](../../models/shared/computedattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[ComputedAttributeType]](../../models/shared/computedattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattributeconstraints.md b/entity/docs/models/shared/computedattributeconstraints.md new file mode 100755 index 000000000..ac8b5480b --- /dev/null +++ b/entity/docs/models/shared/computedattributeconstraints.md @@ -0,0 +1,11 @@ +# ComputedAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattributeinfohelpers.md b/entity/docs/models/shared/computedattributeinfohelpers.md new file mode 100755 index 000000000..4e4fdeeb4 --- /dev/null +++ b/entity/docs/models/shared/computedattributeinfohelpers.md @@ -0,0 +1,13 @@ +# ComputedAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattributetype.md b/entity/docs/models/shared/computedattributetype.md new file mode 100755 index 000000000..2155a2f01 --- /dev/null +++ b/entity/docs/models/shared/computedattributetype.md @@ -0,0 +1,8 @@ +# ComputedAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `COMPUTED` | computed | \ No newline at end of file diff --git a/entity/docs/models/shared/consentattribute.md b/entity/docs/models/shared/consentattribute.md new file mode 100755 index 000000000..b625fe4c5 --- /dev/null +++ b/entity/docs/models/shared/consentattribute.md @@ -0,0 +1,36 @@ +# ConsentAttribute + +Consent Management + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[ConsentAttributeConstraints]](../../models/shared/consentattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `identifiers` | list[*str*] | :heavy_minus_sign: | N/A | | +| `info_helpers` | [Optional[ConsentAttributeInfoHelpers]](../../models/shared/consentattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `topic` | *str* | :heavy_check_mark: | N/A | | +| `type` | [ConsentAttributeType](../../models/shared/consentattributetype.md) | :heavy_check_mark: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/consentattributeconstraints.md b/entity/docs/models/shared/consentattributeconstraints.md new file mode 100755 index 000000000..9b7fcabd7 --- /dev/null +++ b/entity/docs/models/shared/consentattributeconstraints.md @@ -0,0 +1,11 @@ +# ConsentAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/consentattributeinfohelpers.md b/entity/docs/models/shared/consentattributeinfohelpers.md new file mode 100755 index 000000000..b6c2ee157 --- /dev/null +++ b/entity/docs/models/shared/consentattributeinfohelpers.md @@ -0,0 +1,13 @@ +# ConsentAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/consentattributetype.md b/entity/docs/models/shared/consentattributetype.md new file mode 100755 index 000000000..705bf9776 --- /dev/null +++ b/entity/docs/models/shared/consentattributetype.md @@ -0,0 +1,8 @@ +# ConsentAttributeType + + +## Values + +| Name | Value | +| --------- | --------- | +| `CONSENT` | consent | \ No newline at end of file diff --git a/entity/docs/models/shared/countryattribute.md b/entity/docs/models/shared/countryattribute.md new file mode 100755 index 000000000..66f6ecda5 --- /dev/null +++ b/entity/docs/models/shared/countryattribute.md @@ -0,0 +1,34 @@ +# CountryAttribute + +Country picker + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[CountryAttributeConstraints]](../../models/shared/countryattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[CountryAttributeInfoHelpers]](../../models/shared/countryattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[CountryAttributeType]](../../models/shared/countryattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/countryattributeconstraints.md b/entity/docs/models/shared/countryattributeconstraints.md new file mode 100755 index 000000000..a83f7c531 --- /dev/null +++ b/entity/docs/models/shared/countryattributeconstraints.md @@ -0,0 +1,11 @@ +# CountryAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/countryattributeinfohelpers.md b/entity/docs/models/shared/countryattributeinfohelpers.md new file mode 100755 index 000000000..60ed61091 --- /dev/null +++ b/entity/docs/models/shared/countryattributeinfohelpers.md @@ -0,0 +1,13 @@ +# CountryAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/countryattributetype.md b/entity/docs/models/shared/countryattributetype.md new file mode 100755 index 000000000..d40e0ef82 --- /dev/null +++ b/entity/docs/models/shared/countryattributetype.md @@ -0,0 +1,8 @@ +# CountryAttributeType + + +## Values + +| Name | Value | +| --------- | --------- | +| `COUNTRY` | country | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattribute.md b/entity/docs/models/shared/currencyattribute.md new file mode 100755 index 000000000..9a0b33621 --- /dev/null +++ b/entity/docs/models/shared/currencyattribute.md @@ -0,0 +1,36 @@ +# CurrencyAttribute + +Currency input + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[CurrencyAttributeConstraints]](../../models/shared/currencyattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `currency` | list[*Any*] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | +| `currency_selector_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[CurrencyAttributeInfoHelpers]](../../models/shared/currencyattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [CurrencyAttributeType](../../models/shared/currencyattributetype.md) | :heavy_check_mark: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattributeconstraints.md b/entity/docs/models/shared/currencyattributeconstraints.md new file mode 100755 index 000000000..c98f69494 --- /dev/null +++ b/entity/docs/models/shared/currencyattributeconstraints.md @@ -0,0 +1,11 @@ +# CurrencyAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattributecurrency1.md b/entity/docs/models/shared/currencyattributecurrency1.md new file mode 100755 index 000000000..8a470028f --- /dev/null +++ b/entity/docs/models/shared/currencyattributecurrency1.md @@ -0,0 +1,13 @@ +# CurrencyAttributeCurrency1 + +A currency configuration + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `code` | *str* | :heavy_check_mark: | N/A | +| `description` | *str* | :heavy_check_mark: | N/A | +| `flag` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `symbol` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattributeinfohelpers.md b/entity/docs/models/shared/currencyattributeinfohelpers.md new file mode 100755 index 000000000..de9c3d151 --- /dev/null +++ b/entity/docs/models/shared/currencyattributeinfohelpers.md @@ -0,0 +1,13 @@ +# CurrencyAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattributetype.md b/entity/docs/models/shared/currencyattributetype.md new file mode 100755 index 000000000..037e5d352 --- /dev/null +++ b/entity/docs/models/shared/currencyattributetype.md @@ -0,0 +1,8 @@ +# CurrencyAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CURRENCY` | currency | \ No newline at end of file diff --git a/entity/docs/models/shared/dateattribute.md b/entity/docs/models/shared/dateattribute.md new file mode 100755 index 000000000..bccf15a3f --- /dev/null +++ b/entity/docs/models/shared/dateattribute.md @@ -0,0 +1,34 @@ +# DateAttribute + +Date or Datetime picker + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[DateAttributeConstraints]](../../models/shared/dateattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[DateAttributeInfoHelpers]](../../models/shared/dateattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[DateAttributeType]](../../models/shared/dateattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/dateattributeconstraints.md b/entity/docs/models/shared/dateattributeconstraints.md new file mode 100755 index 000000000..a0fcd4648 --- /dev/null +++ b/entity/docs/models/shared/dateattributeconstraints.md @@ -0,0 +1,11 @@ +# DateAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/dateattributeinfohelpers.md b/entity/docs/models/shared/dateattributeinfohelpers.md new file mode 100755 index 000000000..e8ee4369d --- /dev/null +++ b/entity/docs/models/shared/dateattributeinfohelpers.md @@ -0,0 +1,13 @@ +# DateAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/dateattributetype.md b/entity/docs/models/shared/dateattributetype.md new file mode 100755 index 000000000..f7765ea5c --- /dev/null +++ b/entity/docs/models/shared/dateattributetype.md @@ -0,0 +1,9 @@ +# DateAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DATE` | date | +| `DATETIME` | datetime | \ No newline at end of file diff --git a/entity/docs/models/shared/entitycapability.md b/entity/docs/models/shared/entitycapability.md new file mode 100755 index 000000000..f26fe754c --- /dev/null +++ b/entity/docs/models/shared/entitycapability.md @@ -0,0 +1,17 @@ +# EntityCapability + +Capabilities the Entity has. Turn features on/off for entities. + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `attributes` | list[*Any*] | :heavy_minus_sign: | N/A | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show capability for legacy tenants (ivy) | | +| `name` | *str* | :heavy_check_mark: | Unique name for the capability | customer_messaging | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the setting is enabled | MY_SETTING | +| `title` | *Optional[str]* | :heavy_minus_sign: | Human readable title of the capability | Messaging | +| `ui_hooks` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreate.md b/entity/docs/models/shared/entitydefaultcreate.md new file mode 100755 index 000000000..d4699a2db --- /dev/null +++ b/entity/docs/models/shared/entitydefaultcreate.md @@ -0,0 +1,10 @@ +# EntityDefaultCreate + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | +| `table_menu_options` | [Optional[EntityDefaultCreateTableMenuOptions]](../../models/shared/entitydefaultcreatetablemenuoptions.md) | :heavy_minus_sign: | N/A | +| `view_type` | [Optional[EntityDefaultCreateViewType]](../../models/shared/entitydefaultcreateviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md b/entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md new file mode 100755 index 000000000..045c545d2 --- /dev/null +++ b/entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md @@ -0,0 +1,9 @@ +# EntityDefaultCreateTableMenuOptions + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreateviewtype.md b/entity/docs/models/shared/entitydefaultcreateviewtype.md new file mode 100755 index 000000000..387ef6ef2 --- /dev/null +++ b/entity/docs/models/shared/entitydefaultcreateviewtype.md @@ -0,0 +1,8 @@ +# EntityDefaultCreateViewType + + +## Values + +| Name | Value | +| --------- | --------- | +| `DEFAULT` | default | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultedit.md b/entity/docs/models/shared/entitydefaultedit.md new file mode 100755 index 000000000..0f5e451a1 --- /dev/null +++ b/entity/docs/models/shared/entitydefaultedit.md @@ -0,0 +1,10 @@ +# EntityDefaultEdit + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | +| `table_menu_options` | [Optional[EntityDefaultEditTableMenuOptions]](../../models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | +| `view_type` | [Optional[EntityDefaultEditViewType]](../../models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultedittablemenuoptions.md b/entity/docs/models/shared/entitydefaultedittablemenuoptions.md new file mode 100755 index 000000000..afa2a817e --- /dev/null +++ b/entity/docs/models/shared/entitydefaultedittablemenuoptions.md @@ -0,0 +1,9 @@ +# EntityDefaultEditTableMenuOptions + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulteditviewtype.md b/entity/docs/models/shared/entitydefaulteditviewtype.md new file mode 100755 index 000000000..300ea7dd7 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulteditviewtype.md @@ -0,0 +1,8 @@ +# EntityDefaultEditViewType + + +## Values + +| Name | Value | +| --------- | --------- | +| `DEFAULT` | default | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttable.md b/entity/docs/models/shared/entitydefaulttable.md new file mode 100755 index 000000000..6876c1e58 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttable.md @@ -0,0 +1,13 @@ +# EntityDefaultTable + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `classic_view` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `dropdown_items` | list[*Any*] | :heavy_minus_sign: | N/A | +| `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | +| `navbar_actions` | list[[EntityDefaultTableNavbarActions](../../models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | +| `row_actions` | list[*str*] | :heavy_minus_sign: | N/A | +| `view_type` | [Optional[EntityDefaultTableViewType]](../../models/shared/entitydefaulttableviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md new file mode 100755 index 000000000..1627f2b02 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md @@ -0,0 +1,11 @@ +# EntityDefaultTableDropdownItems1 + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `entity` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | +| `type` | [Optional[EntityDefaultTableDropdownItems1Type]](../../models/shared/entitydefaulttabledropdownitems1type.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md new file mode 100755 index 000000000..dd78cb538 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md @@ -0,0 +1,8 @@ +# EntityDefaultTableDropdownItems1Type + + +## Values + +| Name | Value | +| -------- | -------- | +| `ENTITY` | entity | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md new file mode 100755 index 000000000..0dab288f3 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md @@ -0,0 +1,12 @@ +# EntityDefaultTableDropdownItems2 + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Opportunities | +| `type` | [Optional[EntityDefaultTableDropdownItems2Type]](../../models/shared/entitydefaulttabledropdownitems2type.md) | :heavy_minus_sign: | N/A | | +| `uri` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md new file mode 100755 index 000000000..3e3a26e10 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md @@ -0,0 +1,8 @@ +# EntityDefaultTableDropdownItems2Type + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractions.md b/entity/docs/models/shared/entitydefaulttablenavbaractions.md new file mode 100755 index 000000000..0d1db344c --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttablenavbaractions.md @@ -0,0 +1,9 @@ +# EntityDefaultTableNavbarActions + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `options` | list[[EntityDefaultTableNavbarActionsOptions](../../models/shared/entitydefaulttablenavbaractionsoptions.md)] | :heavy_minus_sign: | N/A | +| `type` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md new file mode 100755 index 000000000..31a355818 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md @@ -0,0 +1,9 @@ +# EntityDefaultTableNavbarActionsOptions + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `label` | *str* | :heavy_check_mark: | N/A | +| `params` | [Optional[EntityDefaultTableNavbarActionsOptionsParams]](../../models/shared/entitydefaulttablenavbaractionsoptionsparams.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md new file mode 100755 index 000000000..eb8baf06b --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md @@ -0,0 +1,7 @@ +# EntityDefaultTableNavbarActionsOptionsParams + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttableviewtype.md b/entity/docs/models/shared/entitydefaulttableviewtype.md new file mode 100755 index 000000000..e42ccf697 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttableviewtype.md @@ -0,0 +1,8 @@ +# EntityDefaultTableViewType + + +## Values + +| Name | Value | +| --------- | --------- | +| `DEFAULT` | default | \ No newline at end of file diff --git a/entity/docs/models/shared/entityimportparams.md b/entity/docs/models/shared/entityimportparams.md new file mode 100755 index 000000000..c61968d20 --- /dev/null +++ b/entity/docs/models/shared/entityimportparams.md @@ -0,0 +1,11 @@ +# EntityImportParams + +The parameters for importing entities. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `s3_reference` | [EntityImportParamsS3Reference](../../models/shared/entityimportparamss3reference.md) | :heavy_check_mark: | The S3 bucket and key where the JSON file for import is located. | | +| `schema` | *str* | :heavy_check_mark: | The schema of the entities being imported. This must match the schema of the entities on the platform. | contact | \ No newline at end of file diff --git a/entity/docs/models/shared/entityimportparamss3reference.md b/entity/docs/models/shared/entityimportparamss3reference.md new file mode 100755 index 000000000..20d56e6ca --- /dev/null +++ b/entity/docs/models/shared/entityimportparamss3reference.md @@ -0,0 +1,11 @@ +# EntityImportParamsS3Reference + +The S3 bucket and key where the JSON file for import is located. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `bucket` | *str* | :heavy_check_mark: | The name of the S3 bucket where the JSON file for import is stored. | my-bucket | +| `key` | *str* | :heavy_check_mark: | The key or path to the JSON file within the S3 bucket. | imports/my-import.json | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperation.md b/entity/docs/models/shared/entityoperation.md new file mode 100755 index 000000000..1019dc921 --- /dev/null +++ b/entity/docs/models/shared/entityoperation.md @@ -0,0 +1,14 @@ +# EntityOperation + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `diff` | [Optional[EntityOperationDiff]](../../models/shared/entityoperationdiff.md) | :heavy_minus_sign: | N/A | | +| `entity` | *str* | :heavy_check_mark: | N/A | | +| `operation` | [EntityOperationOperation](../../models/shared/entityoperationoperation.md) | :heavy_check_mark: | N/A | | +| `org` | *str* | :heavy_check_mark: | N/A | 123 | +| `params` | [Optional[EntityOperationParams]](../../models/shared/entityoperationparams.md) | :heavy_minus_sign: | N/A | | +| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperationdiff.md b/entity/docs/models/shared/entityoperationdiff.md new file mode 100755 index 000000000..5fffbf6d4 --- /dev/null +++ b/entity/docs/models/shared/entityoperationdiff.md @@ -0,0 +1,10 @@ +# EntityOperationDiff + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `added` | dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `deleted` | dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `updated` | dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperationoperation.md b/entity/docs/models/shared/entityoperationoperation.md new file mode 100755 index 000000000..64e866fe6 --- /dev/null +++ b/entity/docs/models/shared/entityoperationoperation.md @@ -0,0 +1,10 @@ +# EntityOperationOperation + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `CREATE_ENTITY` | createEntity | +| `UPDATE_ENTITY` | updateEntity | +| `DELETE_ENTITY` | deleteEntity | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperationparams.md b/entity/docs/models/shared/entityoperationparams.md new file mode 100755 index 000000000..f5ca2dacf --- /dev/null +++ b/entity/docs/models/shared/entityoperationparams.md @@ -0,0 +1,9 @@ +# EntityOperationParams + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `slug` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschema.md b/entity/docs/models/shared/entityschema.md new file mode 100755 index 000000000..f3aeeaa52 --- /dev/null +++ b/entity/docs/models/shared/entityschema.md @@ -0,0 +1,27 @@ +# EntitySchema + +The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `attributes` | list[*Any*] | :heavy_check_mark: | An ordered list of attributes the entity contains | | +| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | +| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | +| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | +| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group_settings` | list[[EntitySchemaGroupSettings](../../models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | +| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | +| `plural` | *str* | :heavy_check_mark: | N/A | Contacts | +| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | +| `ui_config` | [Optional[EntitySchemaUIConfig]](../../models/shared/entityschemauiconfig.md) | :heavy_minus_sign: | N/A | | +| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemagroupsettings.md b/entity/docs/models/shared/entityschemagroupsettings.md new file mode 100755 index 000000000..22ed11aff --- /dev/null +++ b/entity/docs/models/shared/entityschemagroupsettings.md @@ -0,0 +1,16 @@ +# EntitySchemaGroupSettings + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `info_tooltip_title` | [Optional[EntitySchemaGroupSettingsInfoTooltipTitle]](../../models/shared/entityschemagroupsettingsinfotooltiptitle.md) | :heavy_minus_sign: | N/A | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Render order of the group | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the setting is enabled | MY_SETTING | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md b/entity/docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md new file mode 100755 index 000000000..a1ed2ebd0 --- /dev/null +++ b/entity/docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md @@ -0,0 +1,9 @@ +# EntitySchemaGroupSettingsInfoTooltipTitle + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitem.md b/entity/docs/models/shared/entityschemaitem.md new file mode 100755 index 000000000..cb1edcd66 --- /dev/null +++ b/entity/docs/models/shared/entityschemaitem.md @@ -0,0 +1,32 @@ +# EntitySchemaItem + +The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `attributes` | list[*Any*] | :heavy_check_mark: | An ordered list of attributes the entity contains | | +| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | +| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | +| `comment` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | +| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group_settings` | list[[EntitySchemaItemGroupSettings](../../models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | +| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for schema | | +| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | +| `plural` | *str* | :heavy_check_mark: | N/A | Contacts | +| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `source` | [Optional[EntitySchemaItemSource]](../../models/shared/entityschemaitemsource.md) | :heavy_minus_sign: | N/A | | +| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | +| `ui_config` | [Optional[EntitySchemaItemUIConfig]](../../models/shared/entityschemaitemuiconfig.md) | :heavy_minus_sign: | N/A | | +| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemgroupsettings.md b/entity/docs/models/shared/entityschemaitemgroupsettings.md new file mode 100755 index 000000000..764606624 --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemgroupsettings.md @@ -0,0 +1,16 @@ +# EntitySchemaItemGroupSettings + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `info_tooltip_title` | [Optional[EntitySchemaItemGroupSettingsInfoTooltipTitle]](../../models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md) | :heavy_minus_sign: | N/A | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Render order of the group | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the setting is enabled | MY_SETTING | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md b/entity/docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md new file mode 100755 index 000000000..0ed2843a0 --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md @@ -0,0 +1,9 @@ +# EntitySchemaItemGroupSettingsInfoTooltipTitle + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemsource.md b/entity/docs/models/shared/entityschemaitemsource.md new file mode 100755 index 000000000..a217645af --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemsource.md @@ -0,0 +1,9 @@ +# EntitySchemaItemSource + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfig.md b/entity/docs/models/shared/entityschemaitemuiconfig.md new file mode 100755 index 000000000..58331349a --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemuiconfig.md @@ -0,0 +1,13 @@ +# EntitySchemaItemUIConfig + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `create_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `edit_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `list_item` | [Optional[EntitySchemaItemUIConfigListItem]](../../models/shared/entityschemaitemuiconfiglistitem.md) | :heavy_minus_sign: | N/A | +| `sharing` | [Optional[EntitySchemaItemUIConfigSharing]](../../models/shared/entityschemaitemuiconfigsharing.md) | :heavy_minus_sign: | N/A | +| `single_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `table_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md new file mode 100755 index 000000000..845449901 --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md @@ -0,0 +1,8 @@ +# EntitySchemaItemUIConfigListItem + + +## Fields + +| Field | Type | Required | Description | +| -------------------- | -------------------- | -------------------- | -------------------- | +| `summary_attributes` | list[*Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfigsharing.md b/entity/docs/models/shared/entityschemaitemuiconfigsharing.md new file mode 100755 index 000000000..7ef69502f --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemuiconfigsharing.md @@ -0,0 +1,8 @@ +# EntitySchemaItemUIConfigSharing + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| `show_sharing_button` | *Optional[bool]* | :heavy_minus_sign: | Show the sharing button in entity detail view | true | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfig.md b/entity/docs/models/shared/entityschemauiconfig.md new file mode 100755 index 000000000..d3b9ae8e0 --- /dev/null +++ b/entity/docs/models/shared/entityschemauiconfig.md @@ -0,0 +1,13 @@ +# EntitySchemaUIConfig + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `create_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `edit_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `list_item` | [Optional[EntitySchemaUIConfigListItem]](../../models/shared/entityschemauiconfiglistitem.md) | :heavy_minus_sign: | N/A | +| `sharing` | [Optional[EntitySchemaUIConfigSharing]](../../models/shared/entityschemauiconfigsharing.md) | :heavy_minus_sign: | N/A | +| `single_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | +| `table_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfiglistitem.md b/entity/docs/models/shared/entityschemauiconfiglistitem.md new file mode 100755 index 000000000..b2d3ad383 --- /dev/null +++ b/entity/docs/models/shared/entityschemauiconfiglistitem.md @@ -0,0 +1,8 @@ +# EntitySchemaUIConfigListItem + + +## Fields + +| Field | Type | Required | Description | +| -------------------- | -------------------- | -------------------- | -------------------- | +| `summary_attributes` | list[*Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfigsharing.md b/entity/docs/models/shared/entityschemauiconfigsharing.md new file mode 100755 index 000000000..89afd2b7f --- /dev/null +++ b/entity/docs/models/shared/entityschemauiconfigsharing.md @@ -0,0 +1,8 @@ +# EntitySchemaUIConfigSharing + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| `show_sharing_button` | *Optional[bool]* | :heavy_minus_sign: | Show the sharing button in entity detail view | true | \ No newline at end of file diff --git a/entity/docs/models/shared/entitysearchparams.md b/entity/docs/models/shared/entitysearchparams.md new file mode 100755 index 000000000..44d3afaba --- /dev/null +++ b/entity/docs/models/shared/entitysearchparams.md @@ -0,0 +1,15 @@ +# EntitySearchParams + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `aggs` | [Optional[EntitySearchParamsAggs]](../../models/shared/entitysearchparamsaggs.md) | :heavy_minus_sign: | Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics. | | +| `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in search results | | +| `from_` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | +| `include_scores` | *Optional[bool]* | :heavy_minus_sign: | Adds a `_score` number field to results that can be used to rank by match score | | +| `q` | *str* | :heavy_check_mark: | Lucene queries supported with ElasticSearch | _schema:contact AND status:active | +| `size` | *Optional[int]* | :heavy_minus_sign: | Max search size is 1000 with higher values defaulting to 1000 | | +| `sort` | *Optional[str]* | :heavy_minus_sign: | N/A | _created_at:desc | \ No newline at end of file diff --git a/entity/docs/models/shared/entitysearchparamsaggs.md b/entity/docs/models/shared/entitysearchparamsaggs.md new file mode 100755 index 000000000..a8169ca29 --- /dev/null +++ b/entity/docs/models/shared/entitysearchparamsaggs.md @@ -0,0 +1,9 @@ +# EntitySearchParamsAggs + +Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics. + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/entitysearchresults.md b/entity/docs/models/shared/entitysearchresults.md new file mode 100755 index 000000000..04ed9600f --- /dev/null +++ b/entity/docs/models/shared/entitysearchresults.md @@ -0,0 +1,12 @@ +# EntitySearchResults + +Success + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `aggregations` | [Optional[EntitySearchResultsAggregations]](../../models/shared/entitysearchresultsaggregations.md) | :heavy_minus_sign: | N/A | | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `results` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitysearchresultsaggregations.md b/entity/docs/models/shared/entitysearchresultsaggregations.md new file mode 100755 index 000000000..bd756a579 --- /dev/null +++ b/entity/docs/models/shared/entitysearchresultsaggregations.md @@ -0,0 +1,7 @@ +# EntitySearchResultsAggregations + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/entityviewdisabled.md b/entity/docs/models/shared/entityviewdisabled.md new file mode 100755 index 000000000..bce87a9f8 --- /dev/null +++ b/entity/docs/models/shared/entityviewdisabled.md @@ -0,0 +1,8 @@ +# EntityViewDisabled + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `view_type` | [Optional[EntityViewDisabledViewType]](../../models/shared/entityviewdisabledviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityviewdisabledviewtype.md b/entity/docs/models/shared/entityviewdisabledviewtype.md new file mode 100755 index 000000000..332085008 --- /dev/null +++ b/entity/docs/models/shared/entityviewdisabledviewtype.md @@ -0,0 +1,8 @@ +# EntityViewDisabledViewType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DISABLED` | disabled | \ No newline at end of file diff --git a/entity/docs/models/shared/fileattribute.md b/entity/docs/models/shared/fileattribute.md new file mode 100755 index 000000000..2be65e745 --- /dev/null +++ b/entity/docs/models/shared/fileattribute.md @@ -0,0 +1,39 @@ +# FileAttribute + +File or Image Attachment + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `allowed_extensions` | list[*str*] | :heavy_minus_sign: | List of file extensions (without the dot suffix) | | +| `constraints` | [Optional[FileAttributeConstraints]](../../models/shared/fileattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_access_control` | [Optional[FileAttributeDefaultAccessControl]](../../models/shared/fileattributedefaultaccesscontrol.md) | :heavy_minus_sign: | N/A | | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `display_images_landscaped` | *Optional[bool]* | :heavy_minus_sign: | Controls how the images are presented to the user during upload on the Entity Details view. | | +| `enable_description` | *Optional[bool]* | :heavy_minus_sign: | When set to true, an i18n description will be used alongside the attribute label.
This description should be set through the platform locales in the form: `file.{attribute_name}.description_text`.
| | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[FileAttributeInfoHelpers]](../../models/shared/fileattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `multiple` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [FileAttributeType](../../models/shared/fileattributetype.md) | :heavy_check_mark: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/fileattributeconstraints.md b/entity/docs/models/shared/fileattributeconstraints.md new file mode 100755 index 000000000..85ae5cf02 --- /dev/null +++ b/entity/docs/models/shared/fileattributeconstraints.md @@ -0,0 +1,11 @@ +# FileAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/fileattributedefaultaccesscontrol.md b/entity/docs/models/shared/fileattributedefaultaccesscontrol.md new file mode 100755 index 000000000..135eb731b --- /dev/null +++ b/entity/docs/models/shared/fileattributedefaultaccesscontrol.md @@ -0,0 +1,9 @@ +# FileAttributeDefaultAccessControl + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `PUBLIC_READ` | public-read | +| `PRIVATE` | private | \ No newline at end of file diff --git a/entity/docs/models/shared/fileattributeinfohelpers.md b/entity/docs/models/shared/fileattributeinfohelpers.md new file mode 100755 index 000000000..c30e599a0 --- /dev/null +++ b/entity/docs/models/shared/fileattributeinfohelpers.md @@ -0,0 +1,13 @@ +# FileAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/fileattributetype.md b/entity/docs/models/shared/fileattributetype.md new file mode 100755 index 000000000..59df0b90d --- /dev/null +++ b/entity/docs/models/shared/fileattributetype.md @@ -0,0 +1,9 @@ +# FileAttributeType + + +## Values + +| Name | Value | +| ------- | ------- | +| `IMAGE` | image | +| `FILE` | file | \ No newline at end of file diff --git a/entity/docs/models/shared/getrelationsresp.md b/entity/docs/models/shared/getrelationsresp.md new file mode 100755 index 000000000..bd700b4b3 --- /dev/null +++ b/entity/docs/models/shared/getrelationsresp.md @@ -0,0 +1,11 @@ +# GetRelationsResp + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `tags` | list[*str*] | :heavy_minus_sign: | N/A | +| `attribute` | *str* | :heavy_check_mark: | N/A | +| `entity_id` | *str* | :heavy_check_mark: | N/A | +| `reverse` | *Optional[bool]* | :heavy_minus_sign: | Whether this is a reverse relation | \ No newline at end of file diff --git a/entity/docs/models/shared/getrelationsrespwithpagination.md b/entity/docs/models/shared/getrelationsrespwithpagination.md new file mode 100755 index 000000000..fed10afc1 --- /dev/null +++ b/entity/docs/models/shared/getrelationsrespwithpagination.md @@ -0,0 +1,11 @@ +# GetRelationsRespWithPagination + +Success + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `relations` | list[*Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattribute.md b/entity/docs/models/shared/internalattribute.md new file mode 100755 index 000000000..e8bf81c0b --- /dev/null +++ b/entity/docs/models/shared/internalattribute.md @@ -0,0 +1,34 @@ +# InternalAttribute + +No UI representation + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[InternalAttributeConstraints]](../../models/shared/internalattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[InternalAttributeInfoHelpers]](../../models/shared/internalattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[InternalAttributeType]](../../models/shared/internalattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattributeconstraints.md b/entity/docs/models/shared/internalattributeconstraints.md new file mode 100755 index 000000000..365f823b4 --- /dev/null +++ b/entity/docs/models/shared/internalattributeconstraints.md @@ -0,0 +1,11 @@ +# InternalAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattributeinfohelpers.md b/entity/docs/models/shared/internalattributeinfohelpers.md new file mode 100755 index 000000000..0c48f90d5 --- /dev/null +++ b/entity/docs/models/shared/internalattributeinfohelpers.md @@ -0,0 +1,13 @@ +# InternalAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattributetype.md b/entity/docs/models/shared/internalattributetype.md new file mode 100755 index 000000000..ce3397a2e --- /dev/null +++ b/entity/docs/models/shared/internalattributetype.md @@ -0,0 +1,8 @@ +# InternalAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INTERNAL` | internal | \ No newline at end of file diff --git a/entity/docs/models/shared/internaluserattribute.md b/entity/docs/models/shared/internaluserattribute.md new file mode 100755 index 000000000..c72abf5ba --- /dev/null +++ b/entity/docs/models/shared/internaluserattribute.md @@ -0,0 +1,34 @@ +# InternalUserAttribute + +Epilot internal user info + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[InternalUserAttributeConstraints]](../../models/shared/internaluserattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[InternalUserAttributeInfoHelpers]](../../models/shared/internaluserattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[InternalUserAttributeType]](../../models/shared/internaluserattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internaluserattributeconstraints.md b/entity/docs/models/shared/internaluserattributeconstraints.md new file mode 100755 index 000000000..c9a52dfcc --- /dev/null +++ b/entity/docs/models/shared/internaluserattributeconstraints.md @@ -0,0 +1,11 @@ +# InternalUserAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/internaluserattributeinfohelpers.md b/entity/docs/models/shared/internaluserattributeinfohelpers.md new file mode 100755 index 000000000..ae2de7df5 --- /dev/null +++ b/entity/docs/models/shared/internaluserattributeinfohelpers.md @@ -0,0 +1,13 @@ +# InternalUserAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/internaluserattributetype.md b/entity/docs/models/shared/internaluserattributetype.md new file mode 100755 index 000000000..f6f08a50c --- /dev/null +++ b/entity/docs/models/shared/internaluserattributetype.md @@ -0,0 +1,8 @@ +# InternalUserAttributeType + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `INTERNAL_USER` | internal_user | \ No newline at end of file diff --git a/entity/docs/models/shared/invitationemailattribute.md b/entity/docs/models/shared/invitationemailattribute.md new file mode 100755 index 000000000..7aee429b4 --- /dev/null +++ b/entity/docs/models/shared/invitationemailattribute.md @@ -0,0 +1,34 @@ +# InvitationEmailAttribute + +Email address for send invitation + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[InvitationEmailAttributeConstraints]](../../models/shared/invitationemailattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[InvitationEmailAttributeInfoHelpers]](../../models/shared/invitationemailattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[InvitationEmailAttributeType]](../../models/shared/invitationemailattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/invitationemailattributeconstraints.md b/entity/docs/models/shared/invitationemailattributeconstraints.md new file mode 100755 index 000000000..ce38d18b1 --- /dev/null +++ b/entity/docs/models/shared/invitationemailattributeconstraints.md @@ -0,0 +1,11 @@ +# InvitationEmailAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/invitationemailattributeinfohelpers.md b/entity/docs/models/shared/invitationemailattributeinfohelpers.md new file mode 100755 index 000000000..0025670ad --- /dev/null +++ b/entity/docs/models/shared/invitationemailattributeinfohelpers.md @@ -0,0 +1,13 @@ +# InvitationEmailAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/invitationemailattributetype.md b/entity/docs/models/shared/invitationemailattributetype.md new file mode 100755 index 000000000..ddd4ae2c4 --- /dev/null +++ b/entity/docs/models/shared/invitationemailattributetype.md @@ -0,0 +1,8 @@ +# InvitationEmailAttributeType + + +## Values + +| Name | Value | +| ------------------ | ------------------ | +| `INVITATION_EMAIL` | invitation_email | \ No newline at end of file diff --git a/entity/docs/models/shared/linkattribute.md b/entity/docs/models/shared/linkattribute.md new file mode 100755 index 000000000..11efa0568 --- /dev/null +++ b/entity/docs/models/shared/linkattribute.md @@ -0,0 +1,34 @@ +# LinkAttribute + +Link with title and href + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[LinkAttributeConstraints]](../../models/shared/linkattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[LinkAttributeInfoHelpers]](../../models/shared/linkattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[LinkAttributeType]](../../models/shared/linkattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/linkattributeconstraints.md b/entity/docs/models/shared/linkattributeconstraints.md new file mode 100755 index 000000000..189c29348 --- /dev/null +++ b/entity/docs/models/shared/linkattributeconstraints.md @@ -0,0 +1,11 @@ +# LinkAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/linkattributeinfohelpers.md b/entity/docs/models/shared/linkattributeinfohelpers.md new file mode 100755 index 000000000..419161104 --- /dev/null +++ b/entity/docs/models/shared/linkattributeinfohelpers.md @@ -0,0 +1,13 @@ +# LinkAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/linkattributetype.md b/entity/docs/models/shared/linkattributetype.md new file mode 100755 index 000000000..5da92ba14 --- /dev/null +++ b/entity/docs/models/shared/linkattributetype.md @@ -0,0 +1,8 @@ +# LinkAttributeType + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattribute.md b/entity/docs/models/shared/multiselectattribute.md new file mode 100755 index 000000000..85537955c --- /dev/null +++ b/entity/docs/models/shared/multiselectattribute.md @@ -0,0 +1,38 @@ +# MultiSelectAttribute + +Multi Choice Selection + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `allow_any` | *Optional[bool]* | :heavy_minus_sign: | Allow arbitrary input values in addition to provided options | | +| `allow_extra_options` | *Optional[bool]* | :heavy_minus_sign: | controls if the 360 ui will allow the user to enter a value which is not defined by the options | | +| `constraints` | [Optional[MultiSelectAttributeConstraints]](../../models/shared/multiselectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `disable_case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | controls if the matching of values against the options is case sensitive or not | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[MultiSelectAttributeInfoHelpers]](../../models/shared/multiselectattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `options` | list[*Any*] | :heavy_minus_sign: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[MultiSelectAttributeType]](../../models/shared/multiselectattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattributeconstraints.md b/entity/docs/models/shared/multiselectattributeconstraints.md new file mode 100755 index 000000000..e84f6ea22 --- /dev/null +++ b/entity/docs/models/shared/multiselectattributeconstraints.md @@ -0,0 +1,11 @@ +# MultiSelectAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattributeinfohelpers.md b/entity/docs/models/shared/multiselectattributeinfohelpers.md new file mode 100755 index 000000000..d52b88263 --- /dev/null +++ b/entity/docs/models/shared/multiselectattributeinfohelpers.md @@ -0,0 +1,13 @@ +# MultiSelectAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattributeoptions2.md b/entity/docs/models/shared/multiselectattributeoptions2.md new file mode 100755 index 000000000..48fc585d5 --- /dev/null +++ b/entity/docs/models/shared/multiselectattributeoptions2.md @@ -0,0 +1,9 @@ +# MultiSelectAttributeOptions2 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattributetype.md b/entity/docs/models/shared/multiselectattributetype.md new file mode 100755 index 000000000..e3bc2b901 --- /dev/null +++ b/entity/docs/models/shared/multiselectattributetype.md @@ -0,0 +1,9 @@ +# MultiSelectAttributeType + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `MULTISELECT` | multiselect | +| `CHECKBOX` | checkbox | \ No newline at end of file diff --git a/entity/docs/models/shared/numberattribute.md b/entity/docs/models/shared/numberattribute.md new file mode 100755 index 000000000..799ee73e0 --- /dev/null +++ b/entity/docs/models/shared/numberattribute.md @@ -0,0 +1,35 @@ +# NumberAttribute + +Numeric input + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[NumberAttributeConstraints]](../../models/shared/numberattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `format` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[NumberAttributeInfoHelpers]](../../models/shared/numberattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[NumberAttributeType]](../../models/shared/numberattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/numberattributeconstraints.md b/entity/docs/models/shared/numberattributeconstraints.md new file mode 100755 index 000000000..1bffe1823 --- /dev/null +++ b/entity/docs/models/shared/numberattributeconstraints.md @@ -0,0 +1,11 @@ +# NumberAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/numberattributeinfohelpers.md b/entity/docs/models/shared/numberattributeinfohelpers.md new file mode 100755 index 000000000..2a696125d --- /dev/null +++ b/entity/docs/models/shared/numberattributeinfohelpers.md @@ -0,0 +1,13 @@ +# NumberAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/numberattributetype.md b/entity/docs/models/shared/numberattributetype.md new file mode 100755 index 000000000..a355b2afb --- /dev/null +++ b/entity/docs/models/shared/numberattributetype.md @@ -0,0 +1,8 @@ +# NumberAttributeType + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/entity/docs/models/shared/orderedlistattribute.md b/entity/docs/models/shared/orderedlistattribute.md new file mode 100755 index 000000000..f046bff3d --- /dev/null +++ b/entity/docs/models/shared/orderedlistattribute.md @@ -0,0 +1,34 @@ +# OrderedListAttribute + +Type of attribute to render N number of ordered fields + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[OrderedListAttributeConstraints]](../../models/shared/orderedlistattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[OrderedListAttributeInfoHelpers]](../../models/shared/orderedlistattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[OrderedListAttributeType]](../../models/shared/orderedlistattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/orderedlistattributeconstraints.md b/entity/docs/models/shared/orderedlistattributeconstraints.md new file mode 100755 index 000000000..853d23d25 --- /dev/null +++ b/entity/docs/models/shared/orderedlistattributeconstraints.md @@ -0,0 +1,11 @@ +# OrderedListAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/orderedlistattributeinfohelpers.md b/entity/docs/models/shared/orderedlistattributeinfohelpers.md new file mode 100755 index 000000000..8007ab547 --- /dev/null +++ b/entity/docs/models/shared/orderedlistattributeinfohelpers.md @@ -0,0 +1,13 @@ +# OrderedListAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/orderedlistattributetype.md b/entity/docs/models/shared/orderedlistattributetype.md new file mode 100755 index 000000000..7954fba64 --- /dev/null +++ b/entity/docs/models/shared/orderedlistattributetype.md @@ -0,0 +1,8 @@ +# OrderedListAttributeType + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `ORDERED_LIST` | ordered_list | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerstatusattribute.md b/entity/docs/models/shared/partnerstatusattribute.md new file mode 100755 index 000000000..086850fae --- /dev/null +++ b/entity/docs/models/shared/partnerstatusattribute.md @@ -0,0 +1,34 @@ +# PartnerStatusAttribute + +Partner Status + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[PartnerStatusAttributeConstraints]](../../models/shared/partnerstatusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[PartnerStatusAttributeInfoHelpers]](../../models/shared/partnerstatusattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[PartnerStatusAttributeType]](../../models/shared/partnerstatusattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerstatusattributeconstraints.md b/entity/docs/models/shared/partnerstatusattributeconstraints.md new file mode 100755 index 000000000..ac28254a5 --- /dev/null +++ b/entity/docs/models/shared/partnerstatusattributeconstraints.md @@ -0,0 +1,11 @@ +# PartnerStatusAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerstatusattributeinfohelpers.md b/entity/docs/models/shared/partnerstatusattributeinfohelpers.md new file mode 100755 index 000000000..be687b4f0 --- /dev/null +++ b/entity/docs/models/shared/partnerstatusattributeinfohelpers.md @@ -0,0 +1,13 @@ +# PartnerStatusAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerstatusattributetype.md b/entity/docs/models/shared/partnerstatusattributetype.md new file mode 100755 index 000000000..f9be21824 --- /dev/null +++ b/entity/docs/models/shared/partnerstatusattributetype.md @@ -0,0 +1,8 @@ +# PartnerStatusAttributeType + + +## Values + +| Name | Value | +| ---------------- | ---------------- | +| `PARTNER_STATUS` | partner_status | \ No newline at end of file diff --git a/entity/docs/models/shared/paymentmethodrelationattribute.md b/entity/docs/models/shared/paymentmethodrelationattribute.md new file mode 100755 index 000000000..87b23230b --- /dev/null +++ b/entity/docs/models/shared/paymentmethodrelationattribute.md @@ -0,0 +1,35 @@ +# PaymentMethodRelationAttribute + +Reference to a payment method attribute of another entity + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[PaymentMethodRelationAttributeConstraints]](../../models/shared/paymentmethodrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `has_primary` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[PaymentMethodRelationAttributeInfoHelpers]](../../models/shared/paymentmethodrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[PaymentMethodRelationAttributeType]](../../models/shared/paymentmethodrelationattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/paymentmethodrelationattributeconstraints.md b/entity/docs/models/shared/paymentmethodrelationattributeconstraints.md new file mode 100755 index 000000000..07b884cb9 --- /dev/null +++ b/entity/docs/models/shared/paymentmethodrelationattributeconstraints.md @@ -0,0 +1,11 @@ +# PaymentMethodRelationAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/paymentmethodrelationattributeinfohelpers.md b/entity/docs/models/shared/paymentmethodrelationattributeinfohelpers.md new file mode 100755 index 000000000..1e28c23c7 --- /dev/null +++ b/entity/docs/models/shared/paymentmethodrelationattributeinfohelpers.md @@ -0,0 +1,13 @@ +# PaymentMethodRelationAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/paymentmethodrelationattributetype.md b/entity/docs/models/shared/paymentmethodrelationattributetype.md new file mode 100755 index 000000000..3a5cdf1c9 --- /dev/null +++ b/entity/docs/models/shared/paymentmethodrelationattributetype.md @@ -0,0 +1,8 @@ +# PaymentMethodRelationAttributeType + + +## Values + +| Name | Value | +| ------------------------- | ------------------------- | +| `RELATION_PAYMENT_METHOD` | relation_payment_method | \ No newline at end of file diff --git a/entity/docs/models/shared/purposeattribute.md b/entity/docs/models/shared/purposeattribute.md new file mode 100755 index 000000000..b07583ddb --- /dev/null +++ b/entity/docs/models/shared/purposeattribute.md @@ -0,0 +1,38 @@ +# PurposeAttribute + +Entity Taxonomy + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[PurposeAttributeConstraints]](../../models/shared/purposeattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `info_helpers` | [Optional[PurposeAttributeInfoHelpers]](../../models/shared/purposeattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | Wallbox PV | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `parents` | list[*str*] | :heavy_minus_sign: | N/A | | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[PurposeAttributeType]](../../models/shared/purposeattributetype.md) | :heavy_minus_sign: | N/A | | +| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/purposeattributeconstraints.md b/entity/docs/models/shared/purposeattributeconstraints.md new file mode 100755 index 000000000..33b4d8587 --- /dev/null +++ b/entity/docs/models/shared/purposeattributeconstraints.md @@ -0,0 +1,11 @@ +# PurposeAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/purposeattributeinfohelpers.md b/entity/docs/models/shared/purposeattributeinfohelpers.md new file mode 100755 index 000000000..c721110fa --- /dev/null +++ b/entity/docs/models/shared/purposeattributeinfohelpers.md @@ -0,0 +1,13 @@ +# PurposeAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/purposeattributetype.md b/entity/docs/models/shared/purposeattributetype.md new file mode 100755 index 000000000..a46263d3b --- /dev/null +++ b/entity/docs/models/shared/purposeattributetype.md @@ -0,0 +1,8 @@ +# PurposeAttributeType + + +## Values + +| Name | Value | +| --------- | --------- | +| `PURPOSE` | purpose | \ No newline at end of file diff --git a/entity/docs/models/shared/redirectentityview.md b/entity/docs/models/shared/redirectentityview.md new file mode 100755 index 000000000..7146cfa18 --- /dev/null +++ b/entity/docs/models/shared/redirectentityview.md @@ -0,0 +1,9 @@ +# RedirectEntityView + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `route` | *Optional[str]* | :heavy_minus_sign: | N/A | /app/pricing-hub/product/:entityId | +| `view_type` | [Optional[RedirectEntityViewViewType]](../../models/shared/redirectentityviewviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/redirectentityviewviewtype.md b/entity/docs/models/shared/redirectentityviewviewtype.md new file mode 100755 index 000000000..f1f49db52 --- /dev/null +++ b/entity/docs/models/shared/redirectentityviewviewtype.md @@ -0,0 +1,8 @@ +# RedirectEntityViewViewType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `REDIRECT` | redirect | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattribute.md b/entity/docs/models/shared/relationattribute.md new file mode 100755 index 000000000..12919256f --- /dev/null +++ b/entity/docs/models/shared/relationattribute.md @@ -0,0 +1,48 @@ +# RelationAttribute + +Entity Relationship + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `actions` | list[[RelationAttributeActions](../../models/shared/relationattributeactions.md)] | :heavy_minus_sign: | N/A | | +| `add_button_label` | *Optional[str]* | :heavy_minus_sign: | Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is. | | +| `allowed_schemas` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[RelationAttributeConstraints]](../../models/shared/relationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `details_view_mode_enabled` | *Optional[bool]* | :heavy_minus_sign: | Enables the preview, edition, and creation of relation items on a Master-Details view mode. | | +| `drawer_size` | [Optional[RelationAttributeDrawerSize]](../../models/shared/relationattributedrawersize.md) | :heavy_minus_sign: | N/A | | +| `edit_mode` | [Optional[RelationAttributeEditMode]](../../models/shared/relationattributeeditmode.md) | :heavy_minus_sign: | N/A | | +| `enable_relation_picker` | *Optional[bool]* | :heavy_minus_sign: | When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link. | | +| `enable_relation_tags` | *Optional[bool]* | :heavy_minus_sign: | When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item. | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `has_primary` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `info_helpers` | [Optional[RelationAttributeInfoHelpers]](../../models/shared/relationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `relation_affinity_mode` | [Optional[RelationAttributeRelationAffinityMode]](../../models/shared/relationattributerelationaffinitymode.md) | :heavy_minus_sign: | Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity. | | +| `relation_type` | [Optional[RelationAttributeRelationType]](../../models/shared/relationattributerelationtype.md) | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `reverse_attributes` | dict[str, *str*] | :heavy_minus_sign: | Map of schema slug to target relation attribute | | +| `search_placeholder` | *Optional[str]* | :heavy_minus_sign: | Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is. | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `summary_fields` | list[*Any*] | :heavy_minus_sign: | N/A | | +| `type` | [Optional[RelationAttributeType]](../../models/shared/relationattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributeactions.md b/entity/docs/models/shared/relationattributeactions.md new file mode 100755 index 000000000..bd8afb4b9 --- /dev/null +++ b/entity/docs/models/shared/relationattributeactions.md @@ -0,0 +1,13 @@ +# RelationAttributeActions + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `action_type` | [Optional[RelationAttributeActionsActionType]](../../models/shared/relationattributeactionsactiontype.md) | :heavy_minus_sign: | The action type. Currently supported actions:

\| action \| description \|
\|--------\|-------------\|
\| add_existing \| Enables the user to pick an existing entity to link as relation \|
\| create_new \| Enables the user to create a new entity using the first/main `allowed_schemas` schema
\| create_from_existing \| Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation \|
| +| `default` | *Optional[bool]* | :heavy_minus_sign: | Sets the action as the default action, visible as the main action button. | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the feature flag that enables this action | +| `label` | *Optional[str]* | :heavy_minus_sign: | The action label or action translation key (i18n) | +| `new_entity_item` | dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the setting flag that enables this action | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributeactionsactiontype.md b/entity/docs/models/shared/relationattributeactionsactiontype.md new file mode 100755 index 000000000..9f08335d9 --- /dev/null +++ b/entity/docs/models/shared/relationattributeactionsactiontype.md @@ -0,0 +1,19 @@ +# RelationAttributeActionsActionType + +The action type. Currently supported actions: + +| action | description | +|--------|-------------| +| add_existing | Enables the user to pick an existing entity to link as relation | +| create_new | Enables the user to create a new entity using the first/main `allowed_schemas` schema +| create_from_existing | Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation | + + + +## Values + +| Name | Value | +| ---------------------- | ---------------------- | +| `ADD_EXISTING` | add_existing | +| `CREATE_NEW` | create_new | +| `CREATE_FROM_EXISTING` | create_from_existing | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributeconstraints.md b/entity/docs/models/shared/relationattributeconstraints.md new file mode 100755 index 000000000..76fa43cd8 --- /dev/null +++ b/entity/docs/models/shared/relationattributeconstraints.md @@ -0,0 +1,11 @@ +# RelationAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributedrawersize.md b/entity/docs/models/shared/relationattributedrawersize.md new file mode 100755 index 000000000..5a1acde1f --- /dev/null +++ b/entity/docs/models/shared/relationattributedrawersize.md @@ -0,0 +1,10 @@ +# RelationAttributeDrawerSize + + +## Values + +| Name | Value | +| -------- | -------- | +| `SMALL` | small | +| `MEDIUM` | medium | +| `LARGE` | large | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributeeditmode.md b/entity/docs/models/shared/relationattributeeditmode.md new file mode 100755 index 000000000..cc0a9a767 --- /dev/null +++ b/entity/docs/models/shared/relationattributeeditmode.md @@ -0,0 +1,8 @@ +# RelationAttributeEditMode + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `LIST_VIEW` | list-view | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributeinfohelpers.md b/entity/docs/models/shared/relationattributeinfohelpers.md new file mode 100755 index 000000000..480e9b4f5 --- /dev/null +++ b/entity/docs/models/shared/relationattributeinfohelpers.md @@ -0,0 +1,13 @@ +# RelationAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributerelationaffinitymode.md b/entity/docs/models/shared/relationattributerelationaffinitymode.md new file mode 100755 index 000000000..48f87b7f4 --- /dev/null +++ b/entity/docs/models/shared/relationattributerelationaffinitymode.md @@ -0,0 +1,11 @@ +# RelationAttributeRelationAffinityMode + +Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity. + + +## Values + +| Name | Value | +| -------- | -------- | +| `WEAK` | weak | +| `STRONG` | strong | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributerelationtype.md b/entity/docs/models/shared/relationattributerelationtype.md new file mode 100755 index 000000000..59aade06d --- /dev/null +++ b/entity/docs/models/shared/relationattributerelationtype.md @@ -0,0 +1,9 @@ +# RelationAttributeRelationType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `HAS_MANY` | has_many | +| `HAS_ONE` | has_one | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributetype.md b/entity/docs/models/shared/relationattributetype.md new file mode 100755 index 000000000..233bc4c95 --- /dev/null +++ b/entity/docs/models/shared/relationattributetype.md @@ -0,0 +1,8 @@ +# RelationAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `RELATION` | relation | \ No newline at end of file diff --git a/entity/docs/models/shared/relationitem.md b/entity/docs/models/shared/relationitem.md new file mode 100755 index 000000000..87511ed41 --- /dev/null +++ b/entity/docs/models/shared/relationitem.md @@ -0,0 +1,13 @@ +# RelationItem + +Success + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `tags` | list[*str*] | :heavy_minus_sign: | N/A | +| `attribute` | *str* | :heavy_check_mark: | N/A | +| `entity_id` | *str* | :heavy_check_mark: | N/A | +| `reverse` | *Optional[bool]* | :heavy_minus_sign: | Whether this is a reverse relation | \ No newline at end of file diff --git a/entity/docs/models/shared/repeatableattribute.md b/entity/docs/models/shared/repeatableattribute.md new file mode 100755 index 000000000..f9d592c2c --- /dev/null +++ b/entity/docs/models/shared/repeatableattribute.md @@ -0,0 +1,38 @@ +# RepeatableAttribute + +Repeatable (add N number of fields) + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[RepeatableAttributeConstraints]](../../models/shared/repeatableattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `enable_relation_picker` | *Optional[bool]* | :heavy_minus_sign: | when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link. | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `has_primary` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[RepeatableAttributeInfoHelpers]](../../models/shared/repeatableattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `relation_affinity_mode` | [Optional[RepeatableAttributeRelationAffinityMode]](../../models/shared/repeatableattributerelationaffinitymode.md) | :heavy_minus_sign: | Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity. | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `repeatable` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[RepeatableAttributeType]](../../models/shared/repeatableattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/repeatableattributeconstraints.md b/entity/docs/models/shared/repeatableattributeconstraints.md new file mode 100755 index 000000000..662421814 --- /dev/null +++ b/entity/docs/models/shared/repeatableattributeconstraints.md @@ -0,0 +1,11 @@ +# RepeatableAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/repeatableattributeinfohelpers.md b/entity/docs/models/shared/repeatableattributeinfohelpers.md new file mode 100755 index 000000000..71fe6ae23 --- /dev/null +++ b/entity/docs/models/shared/repeatableattributeinfohelpers.md @@ -0,0 +1,13 @@ +# RepeatableAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/repeatableattributerelationaffinitymode.md b/entity/docs/models/shared/repeatableattributerelationaffinitymode.md new file mode 100755 index 000000000..0cb1310df --- /dev/null +++ b/entity/docs/models/shared/repeatableattributerelationaffinitymode.md @@ -0,0 +1,11 @@ +# RepeatableAttributeRelationAffinityMode + +Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity. + + +## Values + +| Name | Value | +| -------- | -------- | +| `WEAK` | weak | +| `STRONG` | strong | \ No newline at end of file diff --git a/entity/docs/models/shared/repeatableattributetype.md b/entity/docs/models/shared/repeatableattributetype.md new file mode 100755 index 000000000..9094b0e8c --- /dev/null +++ b/entity/docs/models/shared/repeatableattributetype.md @@ -0,0 +1,15 @@ +# RepeatableAttributeType + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `STRING` | string | +| `PHONE` | phone | +| `EMAIL` | email | +| `ADDRESS` | address | +| `RELATION` | relation | +| `PAYMENT` | payment | +| `PRICE_COMPONENT` | price_component | +| `DATE` | date | \ No newline at end of file diff --git a/entity/docs/models/shared/savedview.md b/entity/docs/models/shared/savedview.md new file mode 100755 index 000000000..b51d00a51 --- /dev/null +++ b/entity/docs/models/shared/savedview.md @@ -0,0 +1,15 @@ +# SavedView + +A saved entity view + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `created_by` | *Any* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | +| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | +| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | +| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewcreatedby1.md b/entity/docs/models/shared/savedviewcreatedby1.md new file mode 100755 index 000000000..e8778b9ca --- /dev/null +++ b/entity/docs/models/shared/savedviewcreatedby1.md @@ -0,0 +1,10 @@ +# SavedViewCreatedBy1 + +A user that created the view + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `user_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 10598 | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewitem.md b/entity/docs/models/shared/savedviewitem.md new file mode 100755 index 000000000..ab01479e2 --- /dev/null +++ b/entity/docs/models/shared/savedviewitem.md @@ -0,0 +1,18 @@ +# SavedViewItem + +A saved entity view + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `created_by` | *Any* | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | +| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | +| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | +| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | +| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewitemcreatedby1.md b/entity/docs/models/shared/savedviewitemcreatedby1.md new file mode 100755 index 000000000..406549b18 --- /dev/null +++ b/entity/docs/models/shared/savedviewitemcreatedby1.md @@ -0,0 +1,10 @@ +# SavedViewItemCreatedBy1 + +A user that created the view + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `user_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 10598 | \ No newline at end of file diff --git a/entity/docs/models/shared/searchmappings.md b/entity/docs/models/shared/searchmappings.md new file mode 100755 index 000000000..117bd6494 --- /dev/null +++ b/entity/docs/models/shared/searchmappings.md @@ -0,0 +1,10 @@ +# SearchMappings + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `fields_` | dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `index` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[SearchMappingsType]](../../models/shared/searchmappingstype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/searchmappingstype.md b/entity/docs/models/shared/searchmappingstype.md new file mode 100755 index 000000000..f351ee36c --- /dev/null +++ b/entity/docs/models/shared/searchmappingstype.md @@ -0,0 +1,16 @@ +# SearchMappingsType + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `KEYWORD` | keyword | +| `TEXT` | text | +| `BOOLEAN` | boolean | +| `INTEGER` | integer | +| `LONG` | long | +| `FLOAT` | float | +| `DATE` | date | +| `FLATTENED` | flattened | +| `NESTED` | nested | \ No newline at end of file diff --git a/entity/docs/models/shared/security.md b/entity/docs/models/shared/security.md new file mode 100755 index 000000000..7e7da0ee3 --- /dev/null +++ b/entity/docs/models/shared/security.md @@ -0,0 +1,9 @@ +# Security + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `epilot_auth` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `epilot_org` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattribute.md b/entity/docs/models/shared/selectattribute.md new file mode 100755 index 000000000..215cc660e --- /dev/null +++ b/entity/docs/models/shared/selectattribute.md @@ -0,0 +1,36 @@ +# SelectAttribute + +Dropdown select + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `allow_any` | *Optional[bool]* | :heavy_minus_sign: | Allow arbitrary input values in addition to provided options | | +| `constraints` | [Optional[SelectAttributeConstraints]](../../models/shared/selectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[SelectAttributeInfoHelpers]](../../models/shared/selectattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `options` | list[*Any*] | :heavy_minus_sign: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[SelectAttributeType]](../../models/shared/selectattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattributeconstraints.md b/entity/docs/models/shared/selectattributeconstraints.md new file mode 100755 index 000000000..b875f98c0 --- /dev/null +++ b/entity/docs/models/shared/selectattributeconstraints.md @@ -0,0 +1,11 @@ +# SelectAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattributeinfohelpers.md b/entity/docs/models/shared/selectattributeinfohelpers.md new file mode 100755 index 000000000..f2120ea3f --- /dev/null +++ b/entity/docs/models/shared/selectattributeinfohelpers.md @@ -0,0 +1,13 @@ +# SelectAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattributeoptions1.md b/entity/docs/models/shared/selectattributeoptions1.md new file mode 100755 index 000000000..0bb8bf0c4 --- /dev/null +++ b/entity/docs/models/shared/selectattributeoptions1.md @@ -0,0 +1,9 @@ +# SelectAttributeOptions1 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattributetype.md b/entity/docs/models/shared/selectattributetype.md new file mode 100755 index 000000000..0e5254caf --- /dev/null +++ b/entity/docs/models/shared/selectattributetype.md @@ -0,0 +1,9 @@ +# SelectAttributeType + + +## Values + +| Name | Value | +| -------- | -------- | +| `SELECT` | select | +| `RADIO` | radio | \ No newline at end of file diff --git a/entity/docs/models/shared/sequenceattribute.md b/entity/docs/models/shared/sequenceattribute.md new file mode 100755 index 000000000..8d06662ee --- /dev/null +++ b/entity/docs/models/shared/sequenceattribute.md @@ -0,0 +1,36 @@ +# SequenceAttribute + +Sequence of unique identifiers + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[SequenceAttributeConstraints]](../../models/shared/sequenceattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[SequenceAttributeInfoHelpers]](../../models/shared/sequenceattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `prefix` | *Optional[str]* | :heavy_minus_sign: | Prefix added before the sequence number | OR- | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `start_number` | *Optional[int]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[SequenceAttributeType]](../../models/shared/sequenceattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/sequenceattributeconstraints.md b/entity/docs/models/shared/sequenceattributeconstraints.md new file mode 100755 index 000000000..f9777f631 --- /dev/null +++ b/entity/docs/models/shared/sequenceattributeconstraints.md @@ -0,0 +1,11 @@ +# SequenceAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/sequenceattributeinfohelpers.md b/entity/docs/models/shared/sequenceattributeinfohelpers.md new file mode 100755 index 000000000..73c184393 --- /dev/null +++ b/entity/docs/models/shared/sequenceattributeinfohelpers.md @@ -0,0 +1,13 @@ +# SequenceAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/sequenceattributetype.md b/entity/docs/models/shared/sequenceattributetype.md new file mode 100755 index 000000000..e2592e106 --- /dev/null +++ b/entity/docs/models/shared/sequenceattributetype.md @@ -0,0 +1,8 @@ +# SequenceAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `SEQUENCE` | sequence | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattribute.md b/entity/docs/models/shared/statusattribute.md new file mode 100755 index 000000000..c9ca8d84d --- /dev/null +++ b/entity/docs/models/shared/statusattribute.md @@ -0,0 +1,35 @@ +# StatusAttribute + +Status select + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[StatusAttributeConstraints]](../../models/shared/statusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[StatusAttributeInfoHelpers]](../../models/shared/statusattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `options` | list[*Any*] | :heavy_minus_sign: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[StatusAttributeType]](../../models/shared/statusattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattributeconstraints.md b/entity/docs/models/shared/statusattributeconstraints.md new file mode 100755 index 000000000..65e581f09 --- /dev/null +++ b/entity/docs/models/shared/statusattributeconstraints.md @@ -0,0 +1,11 @@ +# StatusAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattributeinfohelpers.md b/entity/docs/models/shared/statusattributeinfohelpers.md new file mode 100755 index 000000000..712bfc8df --- /dev/null +++ b/entity/docs/models/shared/statusattributeinfohelpers.md @@ -0,0 +1,13 @@ +# StatusAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattributeoptions2.md b/entity/docs/models/shared/statusattributeoptions2.md new file mode 100755 index 000000000..38643452f --- /dev/null +++ b/entity/docs/models/shared/statusattributeoptions2.md @@ -0,0 +1,9 @@ +# StatusAttributeOptions2 + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattributetype.md b/entity/docs/models/shared/statusattributetype.md new file mode 100755 index 000000000..8a9b3b5f1 --- /dev/null +++ b/entity/docs/models/shared/statusattributetype.md @@ -0,0 +1,8 @@ +# StatusAttributeType + + +## Values + +| Name | Value | +| -------- | -------- | +| `STATUS` | status | \ No newline at end of file diff --git a/entity/docs/models/shared/summaryattribute.md b/entity/docs/models/shared/summaryattribute.md new file mode 100755 index 000000000..0eb07aab0 --- /dev/null +++ b/entity/docs/models/shared/summaryattribute.md @@ -0,0 +1,27 @@ +# SummaryAttribute + +Represents an expanded version of an attribute to be displayed in the list item summary. +This configuration can be used in the following way: +```js +{ + "label": "Price components" + "value": "{{item.prices.length}} price components" + "show_as_tag": true + "render_condition": "is_composite_price = "true"" +} +``` +The value field supports handlebar expressions from which you can pick any field from the entity state. + + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | Binds summary field visibility to the feature flag state. | +| `label` | *str* | :heavy_check_mark: | Label to be shown on the top of the value. | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | Binds summary field visibility to the setting flag state. | +| `show_as_tag` | *Optional[bool]* | :heavy_minus_sign: | Displays the value within a tag chip. | +| `tag_color` | *Optional[str]* | :heavy_minus_sign: | CSS hex color or CSS color name for the tag chip. | +| `value` | *str* | :heavy_check_mark: | A static value or an handlebar expression. | \ No newline at end of file diff --git a/entity/docs/models/shared/summaryfield.md b/entity/docs/models/shared/summaryfield.md new file mode 100755 index 000000000..db5c1e954 --- /dev/null +++ b/entity/docs/models/shared/summaryfield.md @@ -0,0 +1,11 @@ +# SummaryField + +Summary Fields are displayed inside list view as a resume of the relation entity. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | +| `display_as` | *Optional[str]* | :heavy_minus_sign: | An hint on how to display the summary field | +| `field` | *Optional[str]* | :heavy_minus_sign: | The field from the entity attributes to display | \ No newline at end of file diff --git a/entity/docs/models/shared/tagsattribute.md b/entity/docs/models/shared/tagsattribute.md new file mode 100755 index 000000000..d9429d68f --- /dev/null +++ b/entity/docs/models/shared/tagsattribute.md @@ -0,0 +1,36 @@ +# TagsAttribute + +Tags + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[TagsAttributeConstraints]](../../models/shared/tagsattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[TagsAttributeInfoHelpers]](../../models/shared/tagsattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `options` | list[*str*] | :heavy_minus_sign: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `suggestions` | list[*str*] | :heavy_minus_sign: | N/A | | +| `type` | [Optional[TagsAttributeType]](../../models/shared/tagsattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/tagsattributeconstraints.md b/entity/docs/models/shared/tagsattributeconstraints.md new file mode 100755 index 000000000..46c6a22d8 --- /dev/null +++ b/entity/docs/models/shared/tagsattributeconstraints.md @@ -0,0 +1,11 @@ +# TagsAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/tagsattributeinfohelpers.md b/entity/docs/models/shared/tagsattributeinfohelpers.md new file mode 100755 index 000000000..9c3dda202 --- /dev/null +++ b/entity/docs/models/shared/tagsattributeinfohelpers.md @@ -0,0 +1,13 @@ +# TagsAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/tagsattributetype.md b/entity/docs/models/shared/tagsattributetype.md new file mode 100755 index 000000000..cf2593e33 --- /dev/null +++ b/entity/docs/models/shared/tagsattributetype.md @@ -0,0 +1,8 @@ +# TagsAttributeType + + +## Values + +| Name | Value | +| ------ | ------ | +| `TAGS` | tags | \ No newline at end of file diff --git a/entity/docs/models/shared/taxonomy.md b/entity/docs/models/shared/taxonomy.md new file mode 100755 index 000000000..00013a4e9 --- /dev/null +++ b/entity/docs/models/shared/taxonomy.md @@ -0,0 +1,14 @@ +# Taxonomy + +Taxonomy + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag | Purpose | +| `plural` | *Optional[str]* | :heavy_minus_sign: | Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags | Purposes | +| `slug` | *str* | :heavy_check_mark: | URL-friendly name for taxonomy | purpose | +| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/taxonomyclassification.md b/entity/docs/models/shared/taxonomyclassification.md new file mode 100755 index 000000000..3a7f5794f --- /dev/null +++ b/entity/docs/models/shared/taxonomyclassification.md @@ -0,0 +1,12 @@ +# TaxonomyClassification + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | Wallbox PV | +| `parents` | list[*str*] | :heavy_minus_sign: | N/A | | +| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/textattribute.md b/entity/docs/models/shared/textattribute.md new file mode 100755 index 000000000..391f340eb --- /dev/null +++ b/entity/docs/models/shared/textattribute.md @@ -0,0 +1,35 @@ +# TextAttribute + +Textarea or text input + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[TextAttributeConstraints]](../../models/shared/textattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[TextAttributeInfoHelpers]](../../models/shared/textattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `multiline` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[TextAttributeType]](../../models/shared/textattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/textattributeconstraints.md b/entity/docs/models/shared/textattributeconstraints.md new file mode 100755 index 000000000..5a2b92009 --- /dev/null +++ b/entity/docs/models/shared/textattributeconstraints.md @@ -0,0 +1,11 @@ +# TextAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/textattributeinfohelpers.md b/entity/docs/models/shared/textattributeinfohelpers.md new file mode 100755 index 000000000..5f8f15b04 --- /dev/null +++ b/entity/docs/models/shared/textattributeinfohelpers.md @@ -0,0 +1,13 @@ +# TextAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/textattributetype.md b/entity/docs/models/shared/textattributetype.md new file mode 100755 index 000000000..88054505a --- /dev/null +++ b/entity/docs/models/shared/textattributetype.md @@ -0,0 +1,8 @@ +# TextAttributeType + + +## Values + +| Name | Value | +| -------- | -------- | +| `STRING` | string | \ No newline at end of file diff --git a/entity/docs/models/shared/userrelationattribute.md b/entity/docs/models/shared/userrelationattribute.md new file mode 100755 index 000000000..0ff8d0527 --- /dev/null +++ b/entity/docs/models/shared/userrelationattribute.md @@ -0,0 +1,35 @@ +# UserRelationAttribute + +User Relationship + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[UserRelationAttributeConstraints]](../../models/shared/userrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[UserRelationAttributeInfoHelpers]](../../models/shared/userrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `multiple` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[UserRelationAttributeType]](../../models/shared/userrelationattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/userrelationattributeconstraints.md b/entity/docs/models/shared/userrelationattributeconstraints.md new file mode 100755 index 000000000..beed4d3a6 --- /dev/null +++ b/entity/docs/models/shared/userrelationattributeconstraints.md @@ -0,0 +1,11 @@ +# UserRelationAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/userrelationattributeinfohelpers.md b/entity/docs/models/shared/userrelationattributeinfohelpers.md new file mode 100755 index 000000000..7298822e4 --- /dev/null +++ b/entity/docs/models/shared/userrelationattributeinfohelpers.md @@ -0,0 +1,13 @@ +# UserRelationAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/userrelationattributetype.md b/entity/docs/models/shared/userrelationattributetype.md new file mode 100755 index 000000000..3cca95f1e --- /dev/null +++ b/entity/docs/models/shared/userrelationattributetype.md @@ -0,0 +1,8 @@ +# UserRelationAttributeType + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `RELATION_USER` | relation_user | \ No newline at end of file diff --git a/entity/docs/relations/README.md b/entity/docs/relations/README.md deleted file mode 100755 index 6057713b0..000000000 --- a/entity/docs/relations/README.md +++ /dev/null @@ -1,196 +0,0 @@ -# relations - -## Overview - -Entity Relationships - -### Available Operations - -* [add_relations](#add_relations) - addRelations -* [delete_relation](#delete_relation) - deleteRelation -* [get_relations](#get_relations) - getRelations -* [get_relations_v2](#get_relations_v2) - getRelationsV2 -* [update_relation](#update_relation) - updateRelation - -## add_relations - -Relates one or more entities to parent entity by adding items to a relation attribute - -### Example Usage - -```python -import epilot -from epilot.models import operations, shared - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.AddRelationsRequest( - request_body=[ - shared.RelationItem( - tags=[ - 'neque', - 'sed', - 'vel', - ], - attribute='libero', - entity_id='5a73429c-db1a-4842-abb6-79d2322715bf', - reverse=False, - ), - ], - async_=False, - id='0cbb1e31-b8b9-40f3-843a-1108e0adcf4b', - slug='contact', -) - -res = s.relations.add_relations(req) - -if res.relation_item is not None: - # handle response -``` - -## delete_relation - -Removes relation between two entities - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.DeleteRelationRequest( - async_=False, - attribute='cupiditate', - entity_id='qui', - id='1879fce9-53f7-43ef-bfbc-7abd74dd39c0', - slug='contact', -) - -res = s.relations.delete_relation(req) - -if res.status_code == 200: - # handle response -``` - -## get_relations - -Returns 1st level direct relations for an entity. - -You can control whether to return the full entity or just the relation item with the `?hydrate` query param. - -Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. - - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.GetRelationsRequest( - hydrate=False, - id='f5d2cff7-c70a-4456-a6d4-36813f16d9f5', - include_reverse=False, - slug='contact', -) - -res = s.relations.get_relations(req) - -if res.get_relations_resp is not None: - # handle response -``` - -## get_relations_v2 - -Returns 1st level direct relations for an entity with pagination. - -You can control whether to return the full entity or just the relation item with the `?hydrate` query param. - -Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. - - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.GetRelationsV2Request( - fields_=[ - 'quisquam', - 'saepe', - 'ea', - 'impedit', - ], - from_=359271, - hydrate=False, - id='56146c3e-250f-4b00-8c42-e141aac366c8', - include_reverse=False, - query='assumenda', - size=860552, - slug='contact', -) - -res = s.relations.get_relations_v2(req) - -if res.get_relations_resp_with_pagination is not None: - # handle response -``` - -## update_relation - -Updates an existing relation between two entities. - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.UpdateRelationRequest( - request_body=operations.UpdateRelationRequestBody( - tags=[ - 'libero', - 'quasi', - ], - ), - async_=False, - attribute='tempora', - entity_id='numquam', - id='29074747-78a7-4bd4-a6d2-8c10ab3cdca4', - slug='contact', -) - -res = s.relations.update_relation(req) - -if res.relation_item is not None: - # handle response -``` diff --git a/entity/docs/savedviews/README.md b/entity/docs/savedviews/README.md deleted file mode 100755 index d3cf90ee7..000000000 --- a/entity/docs/savedviews/README.md +++ /dev/null @@ -1,171 +0,0 @@ -# saved_views - -## Overview - -Saved Views for Entities - -### Available Operations - -* [create_saved_view](#create_saved_view) - createSavedView -* [delete_saved_view](#delete_saved_view) - deleteSavedView -* [get_saved_view](#get_saved_view) - getSavedView -* [list_saved_views](#list_saved_views) - listSavedViews -* [update_saved_view](#update_saved_view) - updateSavedView - -## create_saved_view - -Creates a new saved view - -### Example Usage - -```python -import epilot -from epilot.models import shared - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = shared.SavedView( - created_by=shared.SavedViewCreatedBy1( - user_id='10598', - ), - name='View listing German', - org='66', - shared=True, - slug=[ - 'contact', - 'contact', - ], - ui_config={ - "cupiditate": 'consequatur', - }, -) - -res = s.saved_views.create_saved_view(req) - -if res.saved_view_item is not None: - # handle response -``` - -## delete_saved_view - -Deletes a saved view - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.DeleteSavedViewRequest( - id='4e523c7e-0bc7-4178-a479-6f2a70c68828', -) - -res = s.saved_views.delete_saved_view(req) - -if res.status_code == 200: - # handle response -``` - -## get_saved_view - -Gets Saved View configuration by id. - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.GetSavedViewRequest( - id='2aa48256-2f22-42e9-817e-e17cbe61e6b7', -) - -res = s.saved_views.get_saved_view(req) - -if res.get_saved_view_200_application_json_object is not None: - # handle response -``` - -## list_saved_views - -Get the Saved Views based on the schema - -### Example Usage - -```python -import epilot - - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - - -res = s.saved_views.list_saved_views() - -if res.list_saved_views_200_application_json_object is not None: - # handle response -``` - -## update_saved_view - -Updates a saved view - -### Example Usage - -```python -import epilot -from epilot.models import operations, shared - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.UpdateSavedViewRequest( - saved_view=shared.SavedView( - created_by={ - "minima": 'distinctio', - "eligendi": 'sit', - "culpa": 'tempore', - }, - name='View listing German', - org='66', - shared=True, - slug=[ - 'contact', - ], - ui_config={ - "consequuntur": 'consequatur', - "minus": 'quaerat', - "sapiente": 'consectetur', - "esse": 'blanditiis', - }, - ), - id='9fd871f9-9dd2-4efd-921a-a6f1e674bdb0', -) - -res = s.saved_views.update_saved_view(req) - -if res.saved_view_item is not None: - # handle response -``` diff --git a/entity/docs/schemas/README.md b/entity/docs/schemas/README.md deleted file mode 100755 index c9627d945..000000000 --- a/entity/docs/schemas/README.md +++ /dev/null @@ -1,1016 +0,0 @@ -# schemas - -## Overview - -Model Entities - -### Available Operations - -* [delete_schema](#delete_schema) - deleteSchema -* [get_schema](#get_schema) - getSchema -* [get_schema_versions](#get_schema_versions) - getSchemaVersions -* [list_schema_blueprints](#list_schema_blueprints) - listSchemaBlueprints -* [list_schemas](#list_schemas) - listSchemas -* [list_taxonomy_classifications_for_schema](#list_taxonomy_classifications_for_schema) - listTaxonomyClassificationsForSchema -* [put_schema](#put_schema) - putSchema - -## delete_schema - -Delete a schema, or a specific version of a schema - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.DeleteSchemaRequest( - slug='contact', -) - -res = s.schemas.delete_schema(req) - -if res.status_code == 200: - # handle response -``` - -## get_schema - -By default gets the latest version of the Schema and to get the specific version of schema pass the id. - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.GetSchemaRequest( - id='4f157560-82d6-48ea-99f1-d17051339d08', - slug='contact', -) - -res = s.schemas.get_schema(req) - -if res.entity_schema_item is not None: - # handle response -``` - -## get_schema_versions - -Get all versions of this schema ordered by the latest versions including drafts. - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.GetSchemaVersionsRequest( - drafts_from=156.06, - drafts_size=5130.75, - slug='contact', - versions_from=4287.96, - versions_size=6498.32, -) - -res = s.schemas.get_schema_versions(req) - -if res.get_schema_versions_200_application_json_object is not None: - # handle response -``` - -## list_schema_blueprints - -List canonical versions of all available schemas - -### Example Usage - -```python -import epilot - - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - - -res = s.schemas.list_schema_blueprints() - -if res.list_schema_blueprints_200_application_json_object is not None: - # handle response -``` - -## list_schemas - -Get the latest versions of all schemas - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.ListSchemasRequest( - unpublished=False, -) - -res = s.schemas.list_schemas(req) - -if res.list_schemas_200_application_json_object is not None: - # handle response -``` - -## list_taxonomy_classifications_for_schema - -List taxonomy classifications for a given schema - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.ListTaxonomyClassificationsForSchemaRequest( - query='ab', - size=5445.91, - slug='contact', - taxonomy_slug='purpose', -) - -res = s.schemas.list_taxonomy_classifications_for_schema(req) - -if res.list_taxonomy_classifications_for_schema_200_application_json_object is not None: - # handle response -``` - -## put_schema - -Create or update a schema with a new version - -### Example Usage - -```python -import epilot -import dateutil.parser -from epilot.models import operations, shared - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.PutSchemaRequest( - entity_schema=shared.EntitySchema( - attributes=[ - shared.TextAttribute( - purpose=[ - '94c26071-f93f-45f0-a42d-ac7af515cc41', - ], - constraints={ - "fuga": 'id', - }, - default_value='suscipit', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='velit', - hidden=False, - hide_label=False, - icon='culpa', - info_helpers=shared.TextAttributeInfoHelpers( - hint_custom_component='est', - hint_text='recusandae', - hint_text_key='totam', - hint_tooltip_placement='top', - ), - label='fugiat', - layout='full_width', - multiline=False, - name='Dora Luettgen', - order=0, - placeholder='possimus', - preview_value_formatter='facilis', - protected=False, - readonly=False, - render_condition='cum', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.TextAttributeType.STRING, - value_formatter='commodi', - ), - shared.PaymentMethodRelationAttribute( - purpose=[ - 'fd5e60b3-75ed-44f6-bbee-41f33317fe35', - 'b60eb1ea-4265-455b-a3c2-8744ed53b88f', - ], - constraints={ - "culpa": 'corrupti', - }, - default_value='pariatur', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='totam', - has_primary=False, - hidden=False, - hide_label=False, - icon='hic', - info_helpers=shared.PaymentMethodRelationAttributeInfoHelpers( - hint_custom_component='exercitationem', - hint_text='nobis', - hint_text_key='sit', - hint_tooltip_placement='top', - ), - label='rerum', - layout='full_width', - name='Faith Cole', - order=0, - placeholder='voluptate', - preview_value_formatter='expedita', - protected=False, - readonly=False, - render_condition='ab', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.PaymentMethodRelationAttributeType.RELATION_PAYMENT_METHOD, - value_formatter='iste', - ), - ], - blueprint='4a276b26-916f-4e1f-88f4-294e3698f447', - capabilities=[ - shared.EntityCapability( - purpose=[ - '03e8b445-e80c-4a55-afd2-0e457e1858b6', - 'a89fbe3a-5aa8-4e48-a4d0-ab4075088e51', - ], - attributes=[ - shared.UserRelationAttribute( - purpose=[ - '065e904f-3b11-494b-8abf-603a79f9dfe0', - ], - constraints={ - "quidem": 'reprehenderit', - "facere": 'fuga', - "praesentium": 'mollitia', - }, - default_value='veniam', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='voluptatem', - hidden=False, - hide_label=False, - icon='quisquam', - info_helpers=shared.UserRelationAttributeInfoHelpers( - hint_custom_component='repudiandae', - hint_text='quasi', - hint_text_key='atque', - hint_tooltip_placement='top', - ), - label='reprehenderit', - layout='full_width', - multiple=False, - name='Jimmie Hoppe', - order=0, - placeholder='et', - preview_value_formatter='esse', - protected=False, - readonly=False, - render_condition='amet', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.UserRelationAttributeType.RELATION_USER, - value_formatter='assumenda', - ), - shared.AddressRelationAttribute( - purpose=[ - '9eee9526-f8d9-486e-881e-ad4f0e101256', - '3f94e29e-973e-4922-a57a-15be3e060807', - 'e2b6e3ab-8845-4f05-97a6-0ff2a54a31e9', - ], - constraints={ - "molestiae": 'ex', - "ut": 'culpa', - }, - default_value='adipisci', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='debitis', - has_primary=False, - hidden=False, - hide_label=False, - icon='laudantium', - info_helpers=shared.AddressRelationAttributeInfoHelpers( - hint_custom_component='eum', - hint_text='nemo', - hint_text_key='recusandae', - hint_tooltip_placement='top', - ), - label='esse', - layout='full_width', - name='Alvin Kemmer', - order=0, - placeholder='aspernatur', - preview_value_formatter='ullam', - protected=False, - readonly=False, - render_condition='quasi', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.AddressRelationAttributeType.RELATION_ADDRESS, - value_formatter='animi', - ), - shared.RelationAttribute( - purpose=[ - '9da660ff-57bf-4aad-8f9e-fc1b4512c103', - '2648dc2f-6151-499e-bfd0-e9fe6c632ca3', - 'aed01179-9631-42fd-a047-71778ff61d01', - ], - actions=[ - shared.RelationAttributeActions( - action_type=shared.RelationAttributeActionsActionType.ADD_EXISTING, - default=False, - feature_flag='esse', - label='ex', - new_entity_item={ - "aliquid": 'ipsa', - }, - setting_flag='laborum', - ), - shared.RelationAttributeActions( - action_type=shared.RelationAttributeActionsActionType.ADD_EXISTING, - default=False, - feature_flag='nostrum', - label='fugiat', - new_entity_item={ - "aliquid": 'officia', - "suscipit": 'aliquid', - "perferendis": 'eum', - }, - setting_flag='voluptas', - ), - ], - add_button_label='iste', - allowed_schemas=[ - 'contact', - 'contact', - 'contact', - ], - constraints={ - "error": 'possimus', - }, - default_value='voluptates', - deprecated=False, - details_view_mode_enabled=False, - drawer_size=shared.RelationAttributeDrawerSize.MEDIUM, - edit_mode=shared.RelationAttributeEditMode.LIST_VIEW, - enable_relation_picker=False, - enable_relation_tags=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='laborum', - has_primary=False, - hidden=False, - hide_label=False, - icon='libero', - info_helpers=shared.RelationAttributeInfoHelpers( - hint_custom_component='ad', - hint_text='deleniti', - hint_text_key='enim', - hint_tooltip_placement='top', - ), - label='vitae', - layout='full_width', - name='Ruben Ryan', - order=0, - placeholder='ad', - preview_value_formatter='expedita', - protected=False, - readonly=False, - relation_affinity_mode=shared.RelationAttributeRelationAffinityMode.WEAK, - relation_type=shared.RelationAttributeRelationType.HAS_ONE, - render_condition='cum', - required=False, - reverse_attributes={ - "beatae": 'contact.account', - "voluptatum": 'contact.account', - }, - search_placeholder='omnis', - setting_flag='MY_SETTING', - show_in_table=False, - summary_fields=[ - shared.SummaryField( - display_as='est', - field='culpa', - ), - ], - type=shared.RelationAttributeType.RELATION, - value_formatter='voluptatem', - ), - ], - feature_flag='FF_MY_FEATURE_FLAG', - legacy=False, - name='customer_messaging', - setting_flag='MY_SETTING', - title='Messaging', - ui_hooks=[ - { - "architecto": 'fuga', - "pariatur": 'debitis', - "voluptatem": 'alias', - "deleniti": 'earum', - }, - { - "sapiente": 'rem', - "minus": 'nemo', - }, - { - "ratione": 'ullam', - "perferendis": 'illum', - "totam": 'impedit', - "quibusdam": 'nam', - }, - { - "culpa": 'dolor', - "aliquam": 'inventore', - }, - ], - ), - shared.EntityCapability( - purpose=[ - '14301042-1813-4d52-88ec-e7e253b66845', - '1c6c6e20-5e16-4dea-b3fe-c9578a645842', - '73a8418d-1623-409f-b092-9921aefb9f58', - ], - attributes=[ - shared.SequenceAttribute( - purpose=[ - '86e68e4b-e056-4013-b59d-a757a59ecfef', - '66ef1caa-3383-4c2b-ab47-7373c8d72f64', - 'd1db1f2c-4310-4661-a963-49e1cf9e06e3', - 'a437000a-e6b6-4bc9-b8f7-59eac55a9741', - ], - constraints={ - "consectetur": 'vitae', - "inventore": 'dolorem', - "ad": 'qui', - "iste": 'ex', - }, - default_value='nemo', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='soluta', - hidden=False, - hide_label=False, - icon='libero', - info_helpers=shared.SequenceAttributeInfoHelpers( - hint_custom_component='rem', - hint_text='dolorum', - hint_text_key='odio', - hint_tooltip_placement='top', - ), - label='fugit', - layout='full_width', - name='Mr. Anne Kautzer', - order=0, - placeholder='neque', - prefix='OR-', - preview_value_formatter='exercitationem', - protected=False, - readonly=False, - render_condition='itaque', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - start_number=88248, - type=shared.SequenceAttributeType.SEQUENCE, - value_formatter='ipsum', - ), - shared.NumberAttribute( - purpose=[ - 'bc2259b1-abda-48c0-b0e1-084cb0672d1a', - 'd879eeb9-665b-485e-bbd0-2bae0be2d782', - '259e3ea4-b519-47f9-a443-da7ce52b895c', - '537c6454-efb0-4b34-896c-3ca5acfbe2fd', - ], - constraints={ - "reprehenderit": 'aperiam', - "odio": 'minima', - }, - default_value='in', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - format='ducimus', - group='excepturi', - hidden=False, - hide_label=False, - icon='dolores', - info_helpers=shared.NumberAttributeInfoHelpers( - hint_custom_component='error', - hint_text='veritatis', - hint_text_key='ducimus', - hint_tooltip_placement='top', - ), - label='voluptate', - layout='full_width', - name='Bradford Murazik', - order=0, - placeholder='quaerat', - preview_value_formatter='commodi', - protected=False, - readonly=False, - render_condition='officiis', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.NumberAttributeType.NUMBER, - value_formatter='placeat', - ), - shared.InternalAttribute( - purpose=[ - '73409e3e-b1e5-4a2b-92eb-07f116db9954', - '5fc95fa8-8970-4e18-9dbb-30fcb33ea055', - ], - constraints={ - "architecto": 'cupiditate', - "molestiae": 'eligendi', - "possimus": 'non', - }, - default_value='magnam', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='itaque', - hidden=False, - hide_label=False, - icon='sed', - info_helpers=shared.InternalAttributeInfoHelpers( - hint_custom_component='asperiores', - hint_text='veniam', - hint_text_key='consequuntur', - hint_tooltip_placement='top', - ), - label='facere', - layout='full_width', - name='Fred Stracke', - order=0, - placeholder='ab', - preview_value_formatter='velit', - protected=False, - readonly=False, - render_condition='facilis', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.InternalAttributeType.INTERNAL, - value_formatter='tempore', - ), - shared.UserRelationAttribute( - purpose=[ - '48b656bc-db35-4ff2-a4b2-7537a8cd9e73', - '19c177d5-25f7-47b1-94ee-b52ff785fc37', - '814d4c98-e0c2-4bb8-9eb7-5dad636c6005', - '03d8bb31-180f-4739-ae9e-057eb809e281', - ], - constraints={ - "velit": 'dolor', - }, - default_value='sunt', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='a', - hidden=False, - hide_label=False, - icon='dolor', - info_helpers=shared.UserRelationAttributeInfoHelpers( - hint_custom_component='occaecati', - hint_text='atque', - hint_text_key='beatae', - hint_tooltip_placement='top', - ), - label='at', - layout='full_width', - multiple=False, - name='Mr. Bethany Koch', - order=0, - placeholder='ea', - preview_value_formatter='aperiam', - protected=False, - readonly=False, - render_condition='dignissimos', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.UserRelationAttributeType.RELATION_USER, - value_formatter='repellat', - ), - ], - feature_flag='FF_MY_FEATURE_FLAG', - legacy=False, - name='customer_messaging', - setting_flag='MY_SETTING', - title='Messaging', - ui_hooks=[ - { - "provident": 'consectetur', - "eligendi": 'dignissimos', - "consectetur": 'soluta', - "natus": 'temporibus', - }, - ], - ), - shared.EntityCapability( - purpose=[ - '3f2ceda7-e23f-4225-b411-faf4b7544e47', - '2e802857-a5b4-4046-ba7d-575f1400e764', - 'ad7334ec-1b78-41b3-aa08-088d100efada', - ], - attributes=[ - shared.TextAttribute( - purpose=[ - 'ef0422eb-2164-4cf9-ab83-66c723ffda9e', - ], - constraints={ - "nisi": 'rerum', - }, - default_value='recusandae', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='voluptates', - hidden=False, - hide_label=False, - icon='non', - info_helpers=shared.TextAttributeInfoHelpers( - hint_custom_component='rem', - hint_text='quia', - hint_text_key='ullam', - hint_tooltip_placement='top', - ), - label='quisquam', - layout='full_width', - multiline=False, - name='Dr. Shari Roob Sr.', - order=0, - placeholder='enim', - preview_value_formatter='optio', - protected=False, - readonly=False, - render_condition='rem', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.TextAttributeType.STRING, - value_formatter='perferendis', - ), - ], - feature_flag='FF_MY_FEATURE_FLAG', - legacy=False, - name='customer_messaging', - setting_flag='MY_SETTING', - title='Messaging', - ui_hooks=[ - { - "a": 'iste', - "dicta": 'quos', - "ullam": 'dolore', - "modi": 'itaque', - }, - { - "modi": 'consequuntur', - "assumenda": 'vero', - "doloribus": 'impedit', - "porro": 'accusamus', - }, - { - "reiciendis": 'ab', - "sint": 'nihil', - "esse": 'iure', - }, - ], - ), - shared.EntityCapability( - purpose=[ - '3e63562a-7b40-48f0-9e3d-48fdaf313a1f', - '5fd94259-c0b3-46f2-9ea9-44f3b756c11f', - ], - attributes=[ - shared.ComputedAttribute( - purpose=[ - '7a512624-3835-4bbc-85a2-3a45cefc5fde', - ], - constraints={ - "alias": 'culpa', - }, - default_value='ipsa', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='nobis', - hidden=False, - hide_label=False, - icon='necessitatibus', - info_helpers=shared.ComputedAttributeInfoHelpers( - hint_custom_component='quia', - hint_text='dicta', - hint_text_key='vel', - hint_tooltip_placement='top', - ), - label='perspiciatis', - layout='full_width', - name='Mr. Derrick Brakus V', - order=0, - placeholder='cumque', - preview_value_formatter='iure', - protected=False, - readonly=False, - render_condition='quibusdam', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.ComputedAttributeType.COMPUTED, - value_formatter='quod', - ), - shared.RelationAttribute( - purpose=[ - '34762799-bfbb-4e69-89fb-2bb4ecae6c3d', - '5db3adeb-d5da-4ea4-8506-a8aa94c02644', - 'cf5e9d9a-4578-4adc-9ac6-00dec001ac80', - '2e2ec09f-f8f0-4f81-aff3-477c13e902c1', - ], - actions=[ - shared.RelationAttributeActions( - action_type=shared.RelationAttributeActionsActionType.ADD_EXISTING, - default=False, - feature_flag='odit', - label='corporis', - new_entity_item={ - "alias": 'error', - "vel": 'accusantium', - "id": 'laboriosam', - }, - setting_flag='ex', - ), - shared.RelationAttributeActions( - action_type=shared.RelationAttributeActionsActionType.CREATE_NEW, - default=False, - feature_flag='veritatis', - label='ullam', - new_entity_item={ - "similique": 'incidunt', - }, - setting_flag='quam', - ), - ], - add_button_label='magni', - allowed_schemas=[ - 'contact', - 'contact', - 'contact', - ], - constraints={ - "omnis": 'sed', - "nesciunt": 'maxime', - "quis": 'cupiditate', - "aliquam": 'excepturi', - }, - default_value='maiores', - deprecated=False, - details_view_mode_enabled=False, - drawer_size=shared.RelationAttributeDrawerSize.MEDIUM, - edit_mode=shared.RelationAttributeEditMode.LIST_VIEW, - enable_relation_picker=False, - enable_relation_tags=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='velit', - has_primary=False, - hidden=False, - hide_label=False, - icon='reiciendis', - info_helpers=shared.RelationAttributeInfoHelpers( - hint_custom_component='amet', - hint_text='nemo', - hint_text_key='ipsa', - hint_tooltip_placement='top', - ), - label='quisquam', - layout='full_width', - name='Morris Kreiger', - order=0, - placeholder='a', - preview_value_formatter='nobis', - protected=False, - readonly=False, - relation_affinity_mode=shared.RelationAttributeRelationAffinityMode.STRONG, - relation_type=shared.RelationAttributeRelationType.HAS_MANY, - render_condition='dicta', - required=False, - reverse_attributes={ - "commodi": 'contact.account', - "eveniet": 'contact.account', - "porro": 'contact.account', - "tempore": 'contact.account', - }, - search_placeholder='quidem', - setting_flag='MY_SETTING', - show_in_table=False, - summary_fields=[ - shared.SummaryField( - display_as='fugit', - field='eius', - ), - 'eligendi', - ], - type=shared.RelationAttributeType.RELATION, - value_formatter='asperiores', - ), - ], - feature_flag='FF_MY_FEATURE_FLAG', - legacy=False, - name='customer_messaging', - setting_flag='MY_SETTING', - title='Messaging', - ui_hooks=[ - { - "sint": 'repellat', - "a": 'animi', - "maiores": 'itaque', - }, - { - "deserunt": 'corporis', - "velit": 'officiis', - "enim": 'officia', - "saepe": 'eum', - }, - ], - ), - ], - dialog_config={ - "accusantium": 'officia', - "impedit": 'quasi', - "blanditiis": 'eius', - "quisquam": 'eos', - }, - draft=False, - enable_setting=[ - '360_features', - '360_features', - '360_features', - ], - explicit_search_mappings={ - "minus": shared.SearchMappings( - fields_={ - "magnam": 'reprehenderit', - }, - index=False, - type=shared.SearchMappingsType.FLATTENED, - ), - "quos": shared.SearchMappings( - fields_={ - "amet": 'molestiae', - "amet": 'laborum', - "modi": 'perferendis', - }, - index=False, - type=shared.SearchMappingsType.NESTED, - ), - "architecto": shared.SearchMappings( - fields_={ - "dolore": 'sunt', - "maiores": 'neque', - "odit": 'earum', - }, - index=False, - type=shared.SearchMappingsType.BOOLEAN, - ), - }, - feature_flag='FF_MY_FEATURE_FLAG', - group_settings=[ - shared.EntitySchemaGroupSettings( - purpose=[ - '55756f5d-56d0-4bd0-af2d-fe13db4f62cb', - ], - expanded=False, - feature_flag='FF_MY_FEATURE_FLAG', - id='a3f8941a-ebc0-4b80-a692-4d3b2ecfcc8f', - info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( - default='voluptatum', - key='iste', - ), - label='corporis', - order=37129, - render_condition='_is_composite_price = "false"', - setting_flag='MY_SETTING', - ), - shared.EntitySchemaGroupSettings( - purpose=[ - '0f5dd3d6-fa18-404e-94c8-2f168a363c88', - ], - expanded=False, - feature_flag='FF_MY_FEATURE_FLAG', - id='73e48438-0b1f-46b8-8a27-5a60a04c495c', - info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( - default='placeat', - key='voluptas', - ), - label='occaecati', - order=600934, - render_condition='_is_composite_price = "false"', - setting_flag='MY_SETTING', - ), - ], - icon='person', - layout_settings={ - "nihil": 'inventore', - }, - name='Contact', - plural='Contacts', - published=False, - slug='contact', - title_template='{{first_name}} {{last_name}}', - ui_config=shared.EntitySchemaUIConfig( - create_view=shared.EntityViewDisabled( - view_type=shared.EntityViewDisabledViewType.DISABLED, - ), - edit_view=shared.RedirectEntityView( - route='/app/pricing-hub/product/:entityId', - view_type=shared.RedirectEntityViewViewType.REDIRECT, - ), - list_item=shared.EntitySchemaUIConfigListItem( - summary_attributes=[ - 'email', - ], - ), - sharing=shared.EntitySchemaUIConfigSharing( - show_sharing_button=True, - ), - single_view=shared.EntityDefaultEdit( - search_params={ - "facere": 'facilis', - "beatae": 'cumque', - "delectus": 'labore', - }, - table_menu_options=shared.EntityDefaultEditTableMenuOptions( - icon='expedita', - label='corrupti', - ), - view_type=shared.EntityDefaultEditViewType.DEFAULT, - ), - table_view=shared.RedirectEntityView( - route='/app/pricing-hub/product/:entityId', - view_type=shared.RedirectEntityViewViewType.REDIRECT, - ), - ), - version=543353, - ), - draft=False, - slug='contact', -) - -res = s.schemas.put_schema(req) - -if res.entity_schema_item is not None: - # handle response -``` diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md new file mode 100755 index 000000000..8875cf228 --- /dev/null +++ b/entity/docs/sdks/activity/README.md @@ -0,0 +1,194 @@ +# activity + +## Overview + +Entity Events + +### Available Operations + +* [attach_activity](#attach_activity) - attachActivity +* [create_activity](#create_activity) - createActivity +* [get_activity](#get_activity) - getActivity +* [get_entity_activity_feed](#get_entity_activity_feed) - getEntityActivityFeed + +## attach_activity + +Attach existing activity to entity activity feeds + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.AttachActivityRequest( + entities=[ + 'c5955907-aff1-4a3a-afa9-467739251aa5', + ], + id='01F130Q52Q6MWSNS8N2AVXV4JN', +) + +res = s.activity.attach_activity(req) + +if res.activity_item is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.AttachActivityRequest](../../models/operations/attachactivityrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.AttachActivityResponse](../../models/operations/attachactivityresponse.md)** + + +## create_activity + +Create an activity that can be displayed in activity feeds. + +- All activites are published as events on the event bus +- Entity mutations are always part of an activity + + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.CreateActivityRequest( + activity=shared.Activity( + message='{{caller}} did something with {{entity payload.entity.id}}.', + payload={ + "quo": 'sequi', + }, + title='My custom activity', + type='MyCustomActivity', + ), + entities=[ + '5ad019da-1ffe-478f-897b-0074f15471b5', + 'e6e13b99-d488-4e1e-91e4-50ad2abd4426', + '9802d502-a94b-4b4f-a3c9-69e9a3efa77d', + 'fb14cd66-ae39-45ef-b9ba-88f3a6699707', + ], +) + +res = s.activity.create_activity(req) + +if res.activity_item is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.CreateActivityRequest](../../models/operations/createactivityrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.CreateActivityResponse](../../models/operations/createactivityresponse.md)** + + +## get_activity + +Get activity by id + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetActivityRequest( + id='01F130Q52Q6MWSNS8N2AVXV4JN', + operations_from=301575, + operations_size=716075, +) + +res = s.activity.get_activity(req) + +if res.activity_item is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `request` | [operations.GetActivityRequest](../../models/operations/getactivityrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetActivityResponse](../../models/operations/getactivityresponse.md)** + + +## get_entity_activity_feed + +Get activity feed for an entity + + +### Example Usage + +```python +import epilot +import dateutil.parser +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetEntityActivityFeedRequest( + after=dateutil.parser.isoparse('2022-06-04T18:23:50.695Z'), + before=dateutil.parser.isoparse('2022-08-14T00:52:14.624Z'), + from_=618016, + id='b6e21419-5989-40af-a563-e2516fe4c8b7', + size=100226, + slug='contact', + type='SyncActivity', +) + +res = s.activity.get_entity_activity_feed(req) + +if res.get_entity_activity_feed_200_application_json_object is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetEntityActivityFeedRequest](../../models/operations/getentityactivityfeedrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetEntityActivityFeedResponse](../../models/operations/getentityactivityfeedresponse.md)** + diff --git a/entity/docs/entities/README.md b/entity/docs/sdks/entities/README.md similarity index 50% rename from entity/docs/entities/README.md rename to entity/docs/sdks/entities/README.md index 468002d37..f229c41c1 100755 --- a/entity/docs/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -45,6 +45,18 @@ if res.autocomplete_200_application_json_object is not None: # handle response ``` +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.AutocompleteRequest](../../models/operations/autocompleterequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.AutocompleteResponse](../../models/operations/autocompleteresponse.md)** + + ## create_entity Creates a new entity using a key. @@ -102,6 +114,18 @@ if res.entity_item is not None: # handle response ``` +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.CreateEntityRequest](../../models/operations/createentityrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.CreateEntityResponse](../../models/operations/createentityresponse.md)** + + ## delete_entity Deletes an Entity @@ -135,6 +159,18 @@ if res.status_code == 200: # handle response ``` +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.DeleteEntityRequest](../../models/operations/deleteentityrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.DeleteEntityResponse](../../models/operations/deleteentityresponse.md)** + + ## get_entity Gets Entity and relations by id. @@ -226,6 +262,18 @@ if res.get_entity_200_application_json_object is not None: # handle response ``` +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `request` | [operations.GetEntityRequest](../../models/operations/getentityrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetEntityResponse](../../models/operations/getentityresponse.md)** + + ## patch_entity Partially updates an entity with the passed in entity data. @@ -288,6 +336,18 @@ if res.entity_item is not None: # handle response ``` +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `request` | [operations.PatchEntityRequest](../../models/operations/patchentityrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.PatchEntityResponse](../../models/operations/patchentityresponse.md)** + + ## search_entities Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying. @@ -370,20 +430,16 @@ s = epilot.Epilot( ) req = shared.EntitySearchParams( - aggs={ - "accusamus": 'quidem', - "voluptatibus": 'voluptas', - }, + aggs=shared.EntitySearchParamsAggs(), fields_=[ - 'eos', - 'atque', - 'sit', + 'accusamus', + 'quidem', ], - from_=854614, + from_=976405, hydrate=False, include_scores=False, q='_schema:contact AND status:active', - size=67249, + size=377752, sort='_created_at:desc', ) @@ -393,6 +449,18 @@ if res.entity_search_results is not None: # handle response ``` +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `request` | [shared.EntitySearchParams](../../models/shared/entitysearchparams.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.SearchEntitiesResponse](../../models/operations/searchentitiesresponse.md)** + + ## update_entity Updates an Entity @@ -436,13 +504,13 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( request_body={ - "dolorum": 'iusto', - "voluptate": 'dolorum', - "deleniti": 'omnis', + "eos": 'atque', + "sit": 'fugiat', + "ab": 'soluta', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, - id='ebf737ae-4203-4ce5-a6a9-5d8a0d446ce2', + id='a77a89eb-f737-4ae4-a03c-e5e6a95d8a0d', slug='contact', ) @@ -452,6 +520,18 @@ if res.entity_item is not None: # handle response ``` +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.UpdateEntityRequest](../../models/operations/updateentityrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.UpdateEntityResponse](../../models/operations/updateentityresponse.md)** + + ## upsert_entity Create or update an entity using `unique_key` @@ -480,15 +560,11 @@ s = epilot.Epilot( req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( entity={ - "a": 'esse', - "harum": 'iusto', - "ipsum": 'quisquam', + "tempora": 'vel', + "quod": 'officiis', }, unique_key=[ 'email.0.email', - 'email.0.email', - 'email.0.email', - 'email.0.email', ], ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', @@ -502,3 +578,15 @@ res = s.entities.upsert_entity(req) if res.entity_item is not None: # handle response ``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.UpsertEntityRequest](../../models/operations/upsertentityrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.UpsertEntityResponse](../../models/operations/upsertentityresponse.md)** + diff --git a/entity/docs/sdks/entityimport/README.md b/entity/docs/sdks/entityimport/README.md new file mode 100755 index 000000000..c5bd7d36d --- /dev/null +++ b/entity/docs/sdks/entityimport/README.md @@ -0,0 +1,53 @@ +# entity_import + +### Available Operations + +* [import_entities](#import_entities) - Import Entities + +## import_entities + +This endpoint enables the import of entities into the platform. +The entities should be provided in a CSV format inside an S3 bucket. +This API will return the `job_id`` which can be used to fetch the status of the import process. + + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.ImportEntitiesRequest( + entity_import_params=shared.EntityImportParams( + s3_reference=shared.EntityImportParamsS3Reference( + bucket='my-bucket', + key='imports/my-import.json', + ), + schema='contact', + ), + job_id='abc123', +) + +res = s.entity_import.import_entities(req) + +if res.status_code == 200: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.ImportEntitiesRequest](../../models/operations/importentitiesrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.ImportEntitiesResponse](../../models/operations/importentitiesresponse.md)** + diff --git a/entity/docs/epilot/README.md b/entity/docs/sdks/epilot/README.md similarity index 100% rename from entity/docs/epilot/README.md rename to entity/docs/sdks/epilot/README.md diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md new file mode 100755 index 000000000..de5cb0765 --- /dev/null +++ b/entity/docs/sdks/export/README.md @@ -0,0 +1,63 @@ +# export + +## Overview + +Export and Import entities via files + +### Available Operations + +* [export_entities](#export_entities) - exportEntities + +## export_entities + +create export file of entities + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.ExportEntitiesRequest( + entity_search_params=shared.EntitySearchParams( + aggs=shared.EntitySearchParamsAggs(), + fields_=[ + 'a', + 'esse', + 'harum', + ], + from_=483409, + hydrate=False, + include_scores=False, + q='_schema:contact AND status:active', + size=215507, + sort='_created_at:desc', + ), + is_template=False, + job_id='abc123', + language='quisquam', +) + +res = s.export.export_entities(req) + +if res.status_code == 200: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.ExportEntitiesRequest](../../models/operations/exportentitiesrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.ExportEntitiesResponse](../../models/operations/exportentitiesresponse.md)** + diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md new file mode 100755 index 000000000..a2fa985f0 --- /dev/null +++ b/entity/docs/sdks/relations/README.md @@ -0,0 +1,281 @@ +# relations + +## Overview + +Entity Relationships + +### Available Operations + +* [add_relations](#add_relations) - addRelations +* [delete_relation](#delete_relation) - deleteRelation +* [get_relations](#get_relations) - getRelations +* [get_relations_v2](#get_relations_v2) - getRelationsV2 +* [update_relation](#update_relation) - updateRelation + +## add_relations + +Relates one or more entities to parent entity by adding items to a relation attribute + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.AddRelationsRequest( + request_body=[ + shared.RelationItem( + tags=[ + 'tempore', + ], + attribute='accusamus', + entity_id='453f870b-326b-45a7-b429-cdb1a8422bb6', + reverse=False, + ), + shared.RelationItem( + tags=[ + 'molestias', + 'temporibus', + ], + attribute='qui', + entity_id='322715bf-0cbb-41e3-9b8b-90f3443a1108', + reverse=False, + ), + shared.RelationItem( + tags=[ + 'consequatur', + 'est', + 'repellendus', + 'porro', + ], + attribute='doloribus', + entity_id='4b921879-fce9-453f-b3ef-7fbc7abd74dd', + reverse=False, + ), + shared.RelationItem( + tags=[ + 'natus', + ], + attribute='impedit', + entity_id='0f5d2cff-7c70-4a45-a26d-436813f16d9f', + reverse=False, + ), + ], + async_=False, + id='5fce6c55-6146-4c3e-a50f-b008c42e141a', + slug='contact', +) + +res = s.relations.add_relations(req) + +if res.relation_item is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.AddRelationsRequest](../../models/operations/addrelationsrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.AddRelationsResponse](../../models/operations/addrelationsresponse.md)** + + +## delete_relation + +Removes relation between two entities + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.DeleteRelationRequest( + async_=False, + attribute='laborum', + entity_id='placeat', + id='366c8dd6-b144-4290-b474-778a7bd466d2', + slug='contact', +) + +res = s.relations.delete_relation(req) + +if res.status_code == 200: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.DeleteRelationRequest](../../models/operations/deleterelationrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.DeleteRelationResponse](../../models/operations/deleterelationresponse.md)** + + +## get_relations + +Returns 1st level direct relations for an entity. + +You can control whether to return the full entity or just the relation item with the `?hydrate` query param. + +Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetRelationsRequest( + hydrate=False, + id='8c10ab3c-dca4-4251-904e-523c7e0bc717', + include_reverse=False, + slug='contact', +) + +res = s.relations.get_relations(req) + +if res.get_relations_resp is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.GetRelationsRequest](../../models/operations/getrelationsrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetRelationsResponse](../../models/operations/getrelationsresponse.md)** + + +## get_relations_v2 + +Returns 1st level direct relations for an entity with pagination. + +You can control whether to return the full entity or just the relation item with the `?hydrate` query param. + +Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. + + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetRelationsV2Request( + fields_=[ + 'accusamus', + 'aliquam', + 'odio', + ], + from_=577543, + hydrate=False, + id='6f2a70c6-8828-42aa-8825-62f222e9817e', + include_reverse=False, + query='accusamus', + size=82971, + slug='contact', +) + +res = s.relations.get_relations_v2(req) + +if res.get_relations_resp_with_pagination is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.GetRelationsV2Request](../../models/operations/getrelationsv2request.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetRelationsV2Response](../../models/operations/getrelationsv2response.md)** + + +## update_relation + +Updates an existing relation between two entities. + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.UpdateRelationRequest( + request_body=operations.UpdateRelationRequestBody( + tags=[ + 'quod', + 'nam', + ], + ), + async_=False, + attribute='vero', + entity_id='aliquid', + id='1e6b7b95-bc0a-4b3c-a0c4-f3789fd871f9', + slug='contact', +) + +res = s.relations.update_relation(req) + +if res.relation_item is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.UpdateRelationRequest](../../models/operations/updaterelationrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.UpdateRelationResponse](../../models/operations/updaterelationresponse.md)** + diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md new file mode 100755 index 000000000..dc246fdfc --- /dev/null +++ b/entity/docs/sdks/savedviews/README.md @@ -0,0 +1,231 @@ +# saved_views + +## Overview + +Saved Views for Entities + +### Available Operations + +* [create_saved_view](#create_saved_view) - createSavedView +* [delete_saved_view](#delete_saved_view) - deleteSavedView +* [get_saved_view](#get_saved_view) - getSavedView +* [list_saved_views](#list_saved_views) - listSavedViews +* [update_saved_view](#update_saved_view) - updateSavedView + +## create_saved_view + +Creates a new saved view + +### Example Usage + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = shared.SavedView( + created_by={ + "possimus": 'quia', + "eveniet": 'asperiores', + "facere": 'veritatis', + "consequuntur": 'quasi', + }, + name='View listing German', + org='66', + shared=True, + slug=[ + 'contact', + 'contact', + 'contact', + ], + ui_config={ + "aliquid": 'tenetur', + "quae": 'earum', + "vel": 'in', + }, +) + +res = s.saved_views.create_saved_view(req) + +if res.saved_view_item is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `request` | [shared.SavedView](../../models/shared/savedview.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.CreateSavedViewResponse](../../models/operations/createsavedviewresponse.md)** + + +## delete_saved_view + +Deletes a saved view + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.DeleteSavedViewRequest( + id='4bdb04f1-5756-4082-968e-a19f1d170513', +) + +res = s.saved_views.delete_saved_view(req) + +if res.status_code == 200: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.DeleteSavedViewRequest](../../models/operations/deletesavedviewrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.DeleteSavedViewResponse](../../models/operations/deletesavedviewresponse.md)** + + +## get_saved_view + +Gets Saved View configuration by id. + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetSavedViewRequest( + id='39d08086-a184-4039-8c26-071f93f5f064', +) + +res = s.saved_views.get_saved_view(req) + +if res.get_saved_view_200_application_json_object is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.GetSavedViewRequest](../../models/operations/getsavedviewrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetSavedViewResponse](../../models/operations/getsavedviewresponse.md)** + + +## list_saved_views + +Get the Saved Views based on the schema + +### Example Usage + +```python +import epilot + + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.saved_views.list_saved_views() + +if res.list_saved_views_200_application_json_object is not None: + # handle response +``` + + +### Response + +**[operations.ListSavedViewsResponse](../../models/operations/listsavedviewsresponse.md)** + + +## update_saved_view + +Updates a saved view + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.UpdateSavedViewRequest( + saved_view=shared.SavedView( + created_by=shared.SavedViewCreatedBy1( + user_id='10598', + ), + name='View listing German', + org='66', + shared=True, + slug=[ + 'contact', + 'contact', + 'contact', + 'contact', + ], + ui_config={ + "maxime": 'dignissimos', + "officia": 'asperiores', + "nemo": 'quae', + }, + ), + id='5cc413aa-63aa-4e8d-a786-4dbb675fd5e6', +) + +res = s.saved_views.update_saved_view(req) + +if res.saved_view_item is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `request` | [operations.UpdateSavedViewRequest](../../models/operations/updatesavedviewrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.UpdateSavedViewResponse](../../models/operations/updatesavedviewresponse.md)** + diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md new file mode 100755 index 000000000..fc745ebc0 --- /dev/null +++ b/entity/docs/sdks/schemas/README.md @@ -0,0 +1,1128 @@ +# schemas + +## Overview + +Model Entities + +### Available Operations + +* [delete_schema](#delete_schema) - deleteSchema +* [get_schema](#get_schema) - getSchema +* [get_schema_versions](#get_schema_versions) - getSchemaVersions +* [list_schema_blueprints](#list_schema_blueprints) - listSchemaBlueprints +* [list_schemas](#list_schemas) - listSchemas +* [list_taxonomy_classifications_for_schema](#list_taxonomy_classifications_for_schema) - listTaxonomyClassificationsForSchema +* [put_schema](#put_schema) - putSchema + +## delete_schema + +Delete a schema, or a specific version of a schema + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.DeleteSchemaRequest( + slug='contact', +) + +res = s.schemas.delete_schema(req) + +if res.status_code == 200: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `request` | [operations.DeleteSchemaRequest](../../models/operations/deleteschemarequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.DeleteSchemaResponse](../../models/operations/deleteschemaresponse.md)** + + +## get_schema + +By default gets the latest version of the Schema and to get the specific version of schema pass the id. + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetSchemaRequest( + id='0b375ed4-f6fb-4ee4-9f33-317fe35b60eb', + slug='contact', +) + +res = s.schemas.get_schema(req) + +if res.entity_schema_item is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `request` | [operations.GetSchemaRequest](../../models/operations/getschemarequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetSchemaResponse](../../models/operations/getschemaresponse.md)** + + +## get_schema_versions + +Get all versions of this schema ordered by the latest versions including drafts. + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetSchemaVersionsRequest( + drafts_from=1138.16, + drafts_size=8817.21, + slug='contact', + versions_from=6311.26, + versions_size=2724.37, +) + +res = s.schemas.get_schema_versions(req) + +if res.get_schema_versions_200_application_json_object is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `request` | [operations.GetSchemaVersionsRequest](../../models/operations/getschemaversionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetSchemaVersionsResponse](../../models/operations/getschemaversionsresponse.md)** + + +## list_schema_blueprints + +List canonical versions of all available schemas + +### Example Usage + +```python +import epilot + + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.schemas.list_schema_blueprints() + +if res.list_schema_blueprints_200_application_json_object is not None: + # handle response +``` + + +### Response + +**[operations.ListSchemaBlueprintsResponse](../../models/operations/listschemablueprintsresponse.md)** + + +## list_schemas + +Get the latest versions of all schemas + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.ListSchemasRequest( + unpublished=False, +) + +res = s.schemas.list_schemas(req) + +if res.list_schemas_200_application_json_object is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `request` | [operations.ListSchemasRequest](../../models/operations/listschemasrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.ListSchemasResponse](../../models/operations/listschemasresponse.md)** + + +## list_taxonomy_classifications_for_schema + +List taxonomy classifications for a given schema + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.ListTaxonomyClassificationsForSchemaRequest( + query='aspernatur', + size=3790.57, + slug='contact', + taxonomy_slug='purpose', +) + +res = s.schemas.list_taxonomy_classifications_for_schema(req) + +if res.list_taxonomy_classifications_for_schema_200_application_json_object is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `request` | [operations.ListTaxonomyClassificationsForSchemaRequest](../../models/operations/listtaxonomyclassificationsforschemarequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.ListTaxonomyClassificationsForSchemaResponse](../../models/operations/listtaxonomyclassificationsforschemaresponse.md)** + + +## put_schema + +Create or update a schema with a new version + +### Example Usage + +```python +import epilot +import dateutil.parser +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.PutSchemaRequest( + entity_schema=shared.EntitySchema( + attributes=[ + shared.UserRelationAttribute( + purpose=[ + 'ba3c2874-4ed5-43b8-8f3a-8d8f5c0b2f2f', + 'b7b194a2-76b2-4691-afe1-f08f4294e369', + ], + constraints=shared.UserRelationAttributeConstraints(), + default_value='quos', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='voluptatibus', + hidden=False, + hide_label=False, + icon='tempora', + info_helpers=shared.UserRelationAttributeInfoHelpers( + hint_custom_component='tempora', + hint_text='voluptate', + hint_text_key='reiciendis', + hint_tooltip_placement='top', + ), + label='ex', + layout='full_width', + multiple=False, + name='Ethel Towne', + order=0, + placeholder='quaerat', + preview_value_formatter='incidunt', + protected=False, + readonly=False, + render_condition='ipsam', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.UserRelationAttributeType.RELATION_USER, + value_formatter='debitis', + ), + shared.RepeatableAttribute( + purpose=[ + 'ca55efd2-0e45-47e1-858b-6a89fbe3a5aa', + ], + constraints=shared.RepeatableAttributeConstraints(), + default_value='corrupti', + deprecated=False, + enable_relation_picker=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='accusamus', + has_primary=False, + hidden=False, + hide_label=False, + icon='tempora', + info_helpers=shared.RepeatableAttributeInfoHelpers( + hint_custom_component='atque', + hint_text='fugit', + hint_text_key='ut', + hint_tooltip_placement='top', + ), + label='fugiat', + layout='full_width', + name='Cecilia Quitzon IV', + order=0, + placeholder='ipsam', + preview_value_formatter='sit', + protected=False, + readonly=False, + relation_affinity_mode=shared.RepeatableAttributeRelationAffinityMode.STRONG, + render_condition='quas', + repeatable=False, + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.RepeatableAttributeType.DATE, + value_formatter='corporis', + ), + ], + blueprint='1862065e-904f-43b1-994b-8abf603a79f9', + capabilities=[ + shared.EntityCapability( + purpose=[ + 'e0ab7da8-a50c-4e18-bf86-bc173d689eee', + '9526f8d9-86e8-481e-ad4f-0e1012563f94', + 'e29e973e-922a-457a-95be-3e060807e2b6', + 'e3ab8845-f059-47a6-8ff2-a54a31e94764', + ], + attributes=[ + shared.MultiSelectAttribute( + purpose=[ + '865e7956-f925-41a5-a9da-660ff57bfaad', + '4f9efc1b-4512-4c10-b264-8dc2f615199e', + 'bfd0e9fe-6c63-42ca-baed-0117996312fd', + 'e0477177-8ff6-41d0-9747-6360a15db6a6', + ], + allow_any=False, + allow_extra_options=False, + constraints=shared.MultiSelectAttributeConstraints(), + default_value='aliquid', + deprecated=False, + disable_case_sensitive=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='perferendis', + hidden=False, + hide_label=False, + icon='eum', + info_helpers=shared.MultiSelectAttributeInfoHelpers( + hint_custom_component='voluptas', + hint_text='iste', + hint_text_key='id', + hint_tooltip_placement='top', + ), + label='ab', + layout='full_width', + name='Woodrow Volkman', + options=[ + 'deleniti', + 'vitae', + shared.MultiSelectAttributeOptions2( + title='Ms.', + value='quo', + ), + ], + order=0, + placeholder='ex', + preview_value_formatter='ut', + protected=False, + readonly=False, + render_condition='ad', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.MultiSelectAttributeType.CHECKBOX, + value_formatter='voluptatem', + ), + shared.TagsAttribute( + purpose=[ + '61891baa-0fe1-4ade-808e-6f8c5f350d8c', + 'db5a3418-1430-4104-a181-3d5208ece7e2', + '53b66845-1c6c-46e2-85e1-6deab3fec957', + ], + constraints=shared.TagsAttributeConstraints(), + default_value='blanditiis', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='officia', + hidden=False, + hide_label=False, + icon='voluptas', + info_helpers=shared.TagsAttributeInfoHelpers( + hint_custom_component='numquam', + hint_text='nemo', + hint_text_key='quos', + hint_tooltip_placement='top', + ), + label='eius', + layout='full_width', + name='Caroline Dooley', + options=[ + 'quasi', + 'rem', + ], + order=0, + placeholder='fugiat', + preview_value_formatter='dicta', + protected=False, + readonly=False, + render_condition='nisi', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + suggestions=[ + 'consectetur', + ], + type=shared.TagsAttributeType.TAGS, + value_formatter='aperiam', + ), + shared.TagsAttribute( + purpose=[ + 'b0929921-aefb-49f5-8c4d-86e68e4be056', + '013f59da-757a-459e-8fef-66ef1caa3383', + 'c2beb477-373c-48d7-af64-d1db1f2c4310', + '661e9634-9e1c-4f9e-86e3-a437000ae6b6', + ], + constraints=shared.TagsAttributeConstraints(), + default_value='facilis', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='placeat', + hidden=False, + hide_label=False, + icon='perspiciatis', + info_helpers=shared.TagsAttributeInfoHelpers( + hint_custom_component='expedita', + hint_text='deleniti', + hint_text_key='a', + hint_tooltip_placement='top', + ), + label='voluptate', + layout='full_width', + name='Lindsey Treutel', + options=[ + 'corporis', + 'est', + ], + order=0, + placeholder='error', + preview_value_formatter='esse', + protected=False, + readonly=False, + render_condition='labore', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + suggestions=[ + 'vero', + ], + type=shared.TagsAttributeType.TAGS, + value_formatter='consectetur', + ), + ], + feature_flag='FF_MY_FEATURE_FLAG', + legacy=False, + name='customer_messaging', + setting_flag='MY_SETTING', + title='Messaging', + ui_hooks=[ + { + "dolorem": 'ad', + }, + ], + ), + shared.EntityCapability( + purpose=[ + '965bb8a7-2026-4114-b5e1-39dbc2259b1a', + ], + attributes=[ + shared.InvitationEmailAttribute( + purpose=[ + '8c070e10-84cb-4067-ad1a-d879eeb9665b', + '85efbd02-bae0-4be2-9782-259e3ea4b519', + '7f92443d-a7ce-452b-895c-537c6454efb0', + ], + constraints=shared.InvitationEmailAttributeConstraints(), + default_value='libero', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='ratione', + hidden=False, + hide_label=False, + icon='labore', + info_helpers=shared.InvitationEmailAttributeInfoHelpers( + hint_custom_component='totam', + hint_text='occaecati', + hint_text_key='voluptas', + hint_tooltip_placement='top', + ), + label='quo', + layout='full_width', + name='Bethany Paucek', + order=0, + placeholder='impedit', + preview_value_formatter='delectus', + protected=False, + readonly=False, + render_condition='tempore', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.InvitationEmailAttributeType.INVITATION_EMAIL, + value_formatter='vero', + ), + shared.CountryAttribute( + purpose=[ + 'd5707577-9291-477d-aac6-46ecb573409e', + '3eb1e5a2-b12e-4b07-b116-db99545fc95f', + 'a88970e1-89db-4b30-bcb3-3ea055b197cd', + '44e2f52d-82d3-4513-bb6f-48b656bcdb35', + ], + constraints=shared.CountryAttributeConstraints(), + default_value='voluptatibus', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='voluptatibus', + hidden=False, + hide_label=False, + icon='consequuntur', + info_helpers=shared.CountryAttributeInfoHelpers( + hint_custom_component='debitis', + hint_text='labore', + hint_text_key='rerum', + hint_tooltip_placement='top', + ), + label='eos', + layout='full_width', + name='Audrey Durgan', + order=0, + placeholder='rem', + preview_value_formatter='eligendi', + protected=False, + readonly=False, + render_condition='fugiat', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.CountryAttributeType.COUNTRY, + value_formatter='unde', + ), + shared.AutomationAttribute( + purpose=[ + '319c177d-525f-477b-914e-eb52ff785fc3', + '7814d4c9-8e0c-42bb-89eb-75dad636c600', + ], + constraints=shared.AutomationAttributeConstraints(), + default_value='ad', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='quae', + hidden=False, + hide_label=False, + icon='amet', + info_helpers=shared.AutomationAttributeInfoHelpers( + hint_custom_component='illum', + hint_text='praesentium', + hint_text_key='quidem', + hint_tooltip_placement='top', + ), + label='cum', + layout='full_width', + name='Joyce Carroll DVM', + order=0, + placeholder='iusto', + preview_value_formatter='amet', + protected=False, + readonly=False, + render_condition='provident', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.AutomationAttributeType.AUTOMATION, + value_formatter='dolorum', + ), + ], + feature_flag='FF_MY_FEATURE_FLAG', + legacy=False, + name='customer_messaging', + setting_flag='MY_SETTING', + title='Messaging', + ui_hooks=[ + { + "repudiandae": 'consequatur', + "nemo": 'molestiae', + "itaque": 'facilis', + }, + { + "aperiam": 'sint', + "accusamus": 'eos', + "totam": 'dicta', + }, + { + "velit": 'dolor', + }, + { + "a": 'dolor', + }, + ], + ), + shared.EntityCapability( + purpose=[ + '81d4c700-b607-4f3c-93c7-3b9da3f2ceda', + '7e23f225-7411-4faf-8b75-44e472e80285', + '7a5b4046-3a7d-4575-b140-0e764ad7334e', + ], + attributes=[ + shared.CountryAttribute( + purpose=[ + '781b36a0-8088-4d10-8efa-da200ef0422e', + 'b2164cf9-ab83-466c-b23f-fda9e06bee48', + '25c1fc0e-115c-480b-bf91-8544ec42defc', + ], + constraints=shared.CountryAttributeConstraints(), + default_value='porro', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='accusamus', + hidden=False, + hide_label=False, + icon='totam', + info_helpers=shared.CountryAttributeInfoHelpers( + hint_custom_component='reiciendis', + hint_text='ab', + hint_text_key='sint', + hint_tooltip_placement='top', + ), + label='nihil', + layout='full_width', + name='Charlene Kuhic', + order=0, + placeholder='vel', + preview_value_formatter='neque', + protected=False, + readonly=False, + render_condition='corporis', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.CountryAttributeType.COUNTRY, + value_formatter='voluptas', + ), + shared.BooleanAttribute( + purpose=[ + '7b408f05-e3d4-48fd-af31-3a1f5fd94259', + 'c0b36f25-ea94-44f3-b756-c11f6c37a512', + '6243835b-bc05-4a23-a45c-efc5fde10a0c', + ], + constraints=shared.BooleanAttributeConstraints(), + default_value='necessitatibus', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='quia', + hidden=False, + hide_label=False, + icon='dicta', + info_helpers=shared.BooleanAttributeInfoHelpers( + hint_custom_component='vel', + hint_text='perspiciatis', + hint_text_key='debitis', + hint_tooltip_placement='top', + ), + label='ullam', + layout='full_width', + name='Ms. Donna Auer', + order=0, + placeholder='iure', + preview_value_formatter='quibusdam', + protected=False, + readonly=False, + render_condition='quod', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.BooleanAttributeType.BOOLEAN, + value_formatter='nemo', + ), + shared.AutomationAttribute( + purpose=[ + '4762799b-fbbe-4694-9fb2-bb4ecae6c3d5', + ], + constraints=shared.AutomationAttributeConstraints(), + default_value='illum', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='facilis', + hidden=False, + hide_label=False, + icon='non', + info_helpers=shared.AutomationAttributeInfoHelpers( + hint_custom_component='mollitia', + hint_text='assumenda', + hint_text_key='recusandae', + hint_tooltip_placement='top', + ), + label='distinctio', + layout='full_width', + name='Leon Schumm', + order=0, + placeholder='laborum', + preview_value_formatter='incidunt', + protected=False, + readonly=False, + render_condition='maxime', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.AutomationAttributeType.AUTOMATION, + value_formatter='ipsam', + ), + shared.TextAttribute( + purpose=[ + 'a8aa94c0-2644-4cf5-a9d9-a4578adc1ac6', + '00dec001-ac80-42e2-ac09-ff8f0f816ff3', + ], + constraints=shared.TextAttributeConstraints(), + default_value='eius', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='esse', + hidden=False, + hide_label=False, + icon='in', + info_helpers=shared.TextAttributeInfoHelpers( + hint_custom_component='eligendi', + hint_text='quasi', + hint_text_key='neque', + hint_tooltip_placement='top', + ), + label='vero', + layout='full_width', + multiline=False, + name='Edward Denesik II', + order=0, + placeholder='dicta', + preview_value_formatter='odit', + protected=False, + readonly=False, + render_condition='corporis', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.TextAttributeType.STRING, + value_formatter='rerum', + ), + ], + feature_flag='FF_MY_FEATURE_FLAG', + legacy=False, + name='customer_messaging', + setting_flag='MY_SETTING', + title='Messaging', + ui_hooks=[ + { + "vel": 'accusantium', + "id": 'laboriosam', + "ex": 'quas', + }, + ], + ), + shared.EntityCapability( + purpose=[ + '51a472af-923c-4594-9f83-f350cf876ffb', + ], + attributes=[ + shared.TextAttribute( + purpose=[ + 'c6ecbb4e-243c-4f78-9ffa-feda53e5ae6e', + ], + constraints=shared.TextAttributeConstraints(), + default_value='accusantium', + deprecated=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='officia', + hidden=False, + hide_label=False, + icon='impedit', + info_helpers=shared.TextAttributeInfoHelpers( + hint_custom_component='quasi', + hint_text='blanditiis', + hint_text_key='eius', + hint_tooltip_placement='top', + ), + label='quisquam', + layout='full_width', + multiline=False, + name='Gayle Mraz', + order=0, + placeholder='magnam', + preview_value_formatter='reprehenderit', + protected=False, + readonly=False, + render_condition='quod', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.TextAttributeType.STRING, + value_formatter='quos', + ), + shared.RepeatableAttribute( + purpose=[ + '73a40e19-42f3-42e5-9055-756f5d56d0bd', + ], + constraints=shared.RepeatableAttributeConstraints(), + default_value='perferendis', + deprecated=False, + enable_relation_picker=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='id', + has_primary=False, + hidden=False, + hide_label=False, + icon='sapiente', + info_helpers=shared.RepeatableAttributeInfoHelpers( + hint_custom_component='sed', + hint_text='possimus', + hint_text_key='repellat', + hint_tooltip_placement='top', + ), + label='repudiandae', + layout='full_width', + name='Josephine Stroman', + order=0, + placeholder='voluptatibus', + preview_value_formatter='iure', + protected=False, + readonly=False, + relation_affinity_mode=shared.RepeatableAttributeRelationAffinityMode.WEAK, + render_condition='minus', + repeatable=False, + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.RepeatableAttributeType.PAYMENT, + value_formatter='dolorum', + ), + shared.MultiSelectAttribute( + purpose=[ + '8941aebc-0b80-4a69-a4d3-b2ecfcc8f895', + '010f5dd3-d6fa-4180-8e54-c82f168a363c', + '8873e484-380b-41f6-b8ca-275a60a04c49', + '5cc69917-1b51-4c1b-9b1c-f4b888ebdfc4', + ], + allow_any=False, + allow_extra_options=False, + constraints=shared.MultiSelectAttributeConstraints(), + default_value='quod', + deprecated=False, + disable_case_sensitive=False, + entity_builder_disable_edit=False, + feature_flag='FF_MY_FEATURE_FLAG', + group='minus', + hidden=False, + hide_label=False, + icon='porro', + info_helpers=shared.MultiSelectAttributeInfoHelpers( + hint_custom_component='id', + hint_text='excepturi', + hint_text_key='occaecati', + hint_tooltip_placement='top', + ), + label='libero', + layout='full_width', + name='Cory Welch DDS', + options=[ + shared.MultiSelectAttributeOptions2( + title='Miss', + value='recusandae', + ), + ], + order=0, + placeholder='veritatis', + preview_value_formatter='aut', + protected=False, + readonly=False, + render_condition='laudantium', + required=False, + setting_flag='MY_SETTING', + show_in_table=False, + type=shared.MultiSelectAttributeType.MULTISELECT, + value_formatter='dolor', + ), + ], + feature_flag='FF_MY_FEATURE_FLAG', + legacy=False, + name='customer_messaging', + setting_flag='MY_SETTING', + title='Messaging', + ui_hooks=[ + { + "magni": 'rerum', + "doloremque": 'voluptatem', + }, + { + "at": 'eum', + "reprehenderit": 'voluptatum', + }, + { + "nihil": 'atque', + "rerum": 'deserunt', + "atque": 'nostrum', + }, + { + "architecto": 'est', + "enim": 'rem', + "magni": 'quae', + }, + ], + ), + ], + dialog_config={ + "placeat": 'enim', + "labore": 'sapiente', + "saepe": 'delectus', + }, + draft=False, + enable_setting=[ + '360_features', + '360_features', + '360_features', + ], + explicit_search_mappings={ + "cumque": shared.SearchMappings( + fields_={ + "quaerat": 'doloribus', + "quia": 'officiis', + "mollitia": 'cumque', + }, + index=False, + type=shared.SearchMappingsType.INTEGER, + ), + "enim": shared.SearchMappings( + fields_={ + "nemo": 'illum', + "nesciunt": 'sit', + }, + index=False, + type=shared.SearchMappingsType.LONG, + ), + "minus": shared.SearchMappings( + fields_={ + "recusandae": 'voluptates', + "praesentium": 'dicta', + "fugit": 'sit', + "aliquid": 'necessitatibus', + }, + index=False, + type=shared.SearchMappingsType.TEXT, + ), + }, + feature_flag='FF_MY_FEATURE_FLAG', + group_settings=[ + shared.EntitySchemaGroupSettings( + purpose=[ + '3fa4a41c-480d-43f2-932a-f03102d514f4', + ], + expanded=False, + feature_flag='FF_MY_FEATURE_FLAG', + id='cc6f18bf-9621-4a6a-8f77-a87ee3e4be75', + info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( + default='explicabo', + key='impedit', + ), + label='aliquid', + order=339843, + render_condition='_is_composite_price = "false"', + setting_flag='MY_SETTING', + ), + shared.EntitySchemaGroupSettings( + purpose=[ + '34418e3b-b91c-48d9-b5e0-e8419d8f84f1', + '44f3e07e-dcc4-4aa5-b3ca-bd905a972e05', + '6728227b-2d30-4947-8bf7-a4fa87cf535a', + ], + expanded=False, + feature_flag='FF_MY_FEATURE_FLAG', + id='6fae54eb-f60c-4321-b023-b75d2367fe1a', + info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( + default='accusantium', + key='quod', + ), + label='minus', + order=550994, + render_condition='_is_composite_price = "false"', + setting_flag='MY_SETTING', + ), + shared.EntitySchemaGroupSettings( + purpose=[ + 'f79f0a39-6d90-4c36-8b7c-15dfbace188b', + '1c4ee2c8-c6ce-4611-beeb-1c7cbdb6eec7', + '4378ba25-3177-447d-8915-ad2caf5dd672', + '3dc0f5ae-2f3a-46b7-8087-8756143f5a6c', + ], + expanded=False, + feature_flag='FF_MY_FEATURE_FLAG', + id='98b55554-080d-440b-8acc-6cbd6b5f3ec9', + info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( + default='voluptatem', + key='provident', + ), + label='adipisci', + order=34267, + render_condition='_is_composite_price = "false"', + setting_flag='MY_SETTING', + ), + ], + icon='person', + layout_settings={ + "repellat": 'omnis', + "explicabo": 'vel', + }, + name='Contact', + plural='Contacts', + published=False, + slug='contact', + title_template='{{first_name}} {{last_name}}', + ui_config=shared.EntitySchemaUIConfig( + create_view=shared.EntityViewDisabled( + view_type=shared.EntityViewDisabledViewType.DISABLED, + ), + edit_view=shared.RedirectEntityView( + route='/app/pricing-hub/product/:entityId', + view_type=shared.RedirectEntityViewViewType.REDIRECT, + ), + list_item=shared.EntitySchemaUIConfigListItem( + summary_attributes=[ + shared.SummaryAttribute( + feature_flag='ipsam', + label='nostrum', + render_condition='sequi', + setting_flag='voluptatum', + show_as_tag=False, + tag_color='quasi', + value='error', + ), + 'email', + shared.SummaryAttribute( + feature_flag='voluptate', + label='eius', + render_condition='expedita', + setting_flag='aperiam', + show_as_tag=False, + tag_color='voluptates', + value='possimus', + ), + shared.SummaryAttribute( + feature_flag='voluptatem', + label='repudiandae', + render_condition='corporis', + setting_flag='ea', + show_as_tag=False, + tag_color='eos', + value='aliquam', + ), + ], + ), + sharing=shared.EntitySchemaUIConfigSharing( + show_sharing_button=True, + ), + single_view=shared.RedirectEntityView( + route='/app/pricing-hub/product/:entityId', + view_type=shared.RedirectEntityViewViewType.REDIRECT, + ), + table_view=shared.EntityViewDisabled( + view_type=shared.EntityViewDisabledViewType.DISABLED, + ), + ), + version=980649, + ), + draft=False, + slug='contact', +) + +res = s.schemas.put_schema(req) + +if res.entity_schema_item is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `request` | [operations.PutSchemaRequest](../../models/operations/putschemarequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.PutSchemaResponse](../../models/operations/putschemaresponse.md)** + diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md new file mode 100755 index 000000000..4f83bea29 --- /dev/null +++ b/entity/docs/sdks/taxonomy/README.md @@ -0,0 +1,294 @@ +# taxonomy + +## Overview + +Entity classification with Taxonomies + +### Available Operations + +* [get_taxonomy](#get_taxonomy) - getTaxonomy +* [list_taxonomies](#list_taxonomies) - listTaxonomies +* [taxonomies_classifications_search](#taxonomies_classifications_search) - taxonomiesClassificationsSearch +* [taxonomy_autocomplete](#taxonomy_autocomplete) - taxonomyAutocomplete +* [update_classifications_for_taxonomy](#update_classifications_for_taxonomy) - updateClassificationsForTaxonomy + +## get_taxonomy + +Get taxonomy by slug + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetTaxonomyRequest( + taxonomy_slug='purpose', +) + +res = s.taxonomy.get_taxonomy(req) + +if res.taxonomy is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `request` | [operations.GetTaxonomyRequest](../../models/operations/gettaxonomyrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetTaxonomyResponse](../../models/operations/gettaxonomyresponse.md)** + + +## list_taxonomies + +List taxonomies in an organisation + +### Example Usage + +```python +import epilot + + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.taxonomy.list_taxonomies() + +if res.list_taxonomies_200_application_json_object is not None: + # handle response +``` + + +### Response + +**[operations.ListTaxonomiesResponse](../../models/operations/listtaxonomiesresponse.md)** + + +## taxonomies_classifications_search + +List taxonomy classifications in an organisation based on taxonomy slug + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.TaxonomiesClassificationsSearchRequest( + request_body=operations.TaxonomiesClassificationsSearchRequestBody( + classification_ids=[ + '639a910a-bdca-4b62-a766-96e1ec00221b', + '335d89ac-b3ec-4fda-8d0c-549ef0300497', + '8a61fa1c-f206-488f-b7c1-ffc71dca163f', + '2a3c80a9-7ff3-434c-9df8-57a9e61876c6', + ], + ), + taxonomy_slug='mollitia', +) + +res = s.taxonomy.taxonomies_classifications_search(req) + +if res.taxonomies_classifications_search_200_application_json_object is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `request` | [operations.TaxonomiesClassificationsSearchRequest](../../models/operations/taxonomiesclassificationssearchrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.TaxonomiesClassificationsSearchResponse](../../models/operations/taxonomiesclassificationssearchresponse.md)** + + +## taxonomy_autocomplete + +Taxonomies autocomplete + +### Example Usage + +```python +import epilot +from epilot.models import operations + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.TaxonomyAutocompleteRequest( + query='quidem', + size=1265.12, + taxonomy_slug='et', +) + +res = s.taxonomy.taxonomy_autocomplete(req) + +if res.taxonomy_autocomplete_200_application_json_object is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `request` | [operations.TaxonomyAutocompleteRequest](../../models/operations/taxonomyautocompleterequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.TaxonomyAutocompleteResponse](../../models/operations/taxonomyautocompleteresponse.md)** + + +## update_classifications_for_taxonomy + +Update taxonomies in an organisation based in taxonomy slug + +### Example Usage + +```python +import epilot +import dateutil.parser +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.UpdateClassificationsForTaxonomyRequest( + classifications_update=shared.ClassificationsUpdate( + create=[ + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-05-20T09:40:46.168Z'), + id='dfc94d6f-ecd7-4993-9006-6a6d2d000355', + name='Wallbox PV', + parents=[ + '38cec086-fa21-4e91-92cb-3119167b8e3c', + ], + updated_at=dateutil.parser.isoparse('2021-04-20T17:26:00.007Z'), + ), + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-12-07T22:47:43.718Z'), + id='3408d6d3-64ff-4d45-9906-d1263d48e935', + name='Wallbox PV', + parents=[ + '2c9e81f3-0be3-4e43-a02d-721657650664', + '1870d9d2-1f9a-4d03-8c4e-cc11a0836429', + '068b8502-a55e-47f7-bbc8-45e320a319f4', + 'badf947c-9a86-47bc-8242-6665816ddca8', + ], + updated_at=dateutil.parser.isoparse('2020-01-24T15:21:03.821Z'), + ), + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-12-05T12:01:23.554Z'), + id='fcb4c593-ec12-4cda-ad0e-c7afedbd80df', + name='Wallbox PV', + parents=[ + '48a47f93-90c5-4888-8983-dabf9ef3ffdd', + '9f7f079a-f4d3-4572-8cdb-0f4d281187d5', + ], + updated_at=dateutil.parser.isoparse('2022-06-27T23:18:05.509Z'), + ), + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-09-12T21:05:38.468Z'), + id='eded85a9-065e-4628-bdfc-2032b6c87992', + name='Wallbox PV', + parents=[ + 'b7e13584-f7ae-412c-a891-f82ce1157172', + ], + updated_at=dateutil.parser.isoparse('2022-12-12T20:07:27.803Z'), + ), + ], + delete=[ + '377dcfa8-9df9-475e-b566-86092e9c3ddc', + '5f111dea-1026-4d54-9a4d-190feb21780b', + ], + update=[ + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2020-09-25T02:22:59.870Z'), + id='0dbbddb4-8470-48fb-8e39-1e6bc158c4c4', + name='Wallbox PV', + parents=[ + '54599ea3-4226-40e9-b200-ce78a1bd8fb7', + 'a0a116ce-723d-4409-bfa3-0e9af725b291', + '22030d83-f5ae-4b77-99d2-2e8c1f849382', + '5fdc42c8-76c2-4c2d-bb4c-fc1c76230f84', + ], + updated_at=dateutil.parser.isoparse('2022-01-08T03:54:51.622Z'), + ), + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-10-18T09:43:56.655Z'), + id='bd23fdb1-4db6-4be5-a685-998e22ae20da', + name='Wallbox PV', + parents=[ + '6fc2b271-a289-4c57-a854-e90439d22246', + ], + updated_at=dateutil.parser.isoparse('2022-07-29T05:03:39.225Z'), + ), + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-06-19T06:43:31.808Z'), + id='62407084-f7ab-437c-af02-225194db5541', + name='Wallbox PV', + parents=[ + 'adc669af-90a2-46c7-8dc9-81f068981d6b', + ], + updated_at=dateutil.parser.isoparse('2022-07-20T11:17:27.497Z'), + ), + shared.TaxonomyClassification( + created_at=dateutil.parser.isoparse('2022-03-17T08:05:23.562Z'), + id='faa348c3-1bf4-407e-a4fc-f0c42b78f156', + name='Wallbox PV', + parents=[ + '6398a0dc-7663-424c-8b06-c8ca12d02529', + ], + updated_at=dateutil.parser.isoparse('2022-07-07T09:19:49.741Z'), + ), + ], + ), + taxonomy_slug='alias', +) + +res = s.taxonomy.update_classifications_for_taxonomy(req) + +if res.update_classifications_for_taxonomy_200_application_json_object is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.UpdateClassificationsForTaxonomyRequest](../../models/operations/updateclassificationsfortaxonomyrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.UpdateClassificationsForTaxonomyResponse](../../models/operations/updateclassificationsfortaxonomyresponse.md)** + diff --git a/entity/docs/taxonomy/README.md b/entity/docs/taxonomy/README.md deleted file mode 100755 index 3ad63cfa8..000000000 --- a/entity/docs/taxonomy/README.md +++ /dev/null @@ -1,213 +0,0 @@ -# taxonomy - -## Overview - -Entity classification with Taxonomies - -### Available Operations - -* [get_taxonomy](#get_taxonomy) - getTaxonomy -* [list_taxonomies](#list_taxonomies) - listTaxonomies -* [taxonomies_classifications_search](#taxonomies_classifications_search) - taxonomiesClassificationsSearch -* [taxonomy_autocomplete](#taxonomy_autocomplete) - taxonomyAutocomplete -* [update_classifications_for_taxonomy](#update_classifications_for_taxonomy) - updateClassificationsForTaxonomy - -## get_taxonomy - -Get taxonomy by slug - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.GetTaxonomyRequest( - taxonomy_slug='purpose', -) - -res = s.taxonomy.get_taxonomy(req) - -if res.taxonomy is not None: - # handle response -``` - -## list_taxonomies - -List taxonomies in an organisation - -### Example Usage - -```python -import epilot - - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - - -res = s.taxonomy.list_taxonomies() - -if res.list_taxonomies_200_application_json_object is not None: - # handle response -``` - -## taxonomies_classifications_search - -List taxonomy classifications in an organisation based on taxonomy slug - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.TaxonomiesClassificationsSearchRequest( - request_body=operations.TaxonomiesClassificationsSearchRequestBody( - classification_ids=[ - 'bdfc4ccc-a99b-4c7f-80b2-dce10873e42b', - '006d6788-78ba-4858-9a58-208c54fefa9c', - '95f2eac5-565d-4307-8fee-81206e2813fa', - '4a41c480-d3f2-4132-af03-102d514f4cc6', - ], - ), - taxonomy_slug='repellat', -) - -res = s.taxonomy.taxonomies_classifications_search(req) - -if res.taxonomies_classifications_search_200_application_json_object is not None: - # handle response -``` - -## taxonomy_autocomplete - -Taxonomies autocomplete - -### Example Usage - -```python -import epilot -from epilot.models import operations - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.TaxonomyAutocompleteRequest( - query='quae', - size=5339.78, - taxonomy_slug='expedita', -) - -res = s.taxonomy.taxonomy_autocomplete(req) - -if res.taxonomy_autocomplete_200_application_json_object is not None: - # handle response -``` - -## update_classifications_for_taxonomy - -Update taxonomies in an organisation based in taxonomy slug - -### Example Usage - -```python -import epilot -import dateutil.parser -from epilot.models import operations, shared - -s = epilot.Epilot( - security=shared.Security( - epilot_auth="", - ), -) - -req = operations.UpdateClassificationsForTaxonomyRequest( - classifications_update=shared.ClassificationsUpdate( - create=[ - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-03-17T11:23:26.153Z'), - id='21a6a4f7-7a87-4ee3-a4be-752c65b34418', - name='Wallbox PV', - parents=[ - '3bb91c8d-975e-40e8-819d-8f84f144f3e0', - '7edcc4aa-5f3c-4abd-905a-972e05672822', - '7b2d3094-70bf-47a4-ba87-cf535a6fae54', - 'ebf60c32-1f02-43b7-9d23-67fe1a0cc8df', - ], - updated_at=dateutil.parser.isoparse('2022-05-31T03:19:09.957Z'), - ), - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-11-12T03:58:41.553Z'), - id='a396d90c-364b-47c1-9dfb-ace188b1c4ee', - name='Wallbox PV', - parents=[ - 'c8c6ce61-1fee-4b1c-bcbd-b6eec74378ba', - ], - updated_at=dateutil.parser.isoparse('2022-09-06T09:53:00.602Z'), - ), - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-11-23T00:22:34.246Z'), - id='7747dc91-5ad2-4caf-9dd6-723dc0f5ae2f', - name='Wallbox PV', - parents=[ - 'a6b70087-8756-4143-b5a6-c98b55554080', - ], - updated_at=dateutil.parser.isoparse('2022-03-24T16:26:44.342Z'), - ), - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-04-05T19:27:13.618Z'), - id='cacc6cbd-6b5f-43ec-9093-04f926bad255', - name='Wallbox PV', - parents=[ - '819b474b-0ed2-40e5-a248-fff639a910ab', - ], - updated_at=dateutil.parser.isoparse('2020-09-02T19:39:17.071Z'), - ), - ], - delete=[ - 'b6267669-6e1e-4c00-a21b-335d89acb3ec', - 'fda8d0c5-49ef-4030-8497-8a61fa1cf206', - '88f77c1f-fc71-4dca-963f-2a3c80a97ff3', - ], - update=[ - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-03-28T10:53:29.573Z'), - id='ddf857a9-e618-476c-aab2-1d29dfc94d6f', - name='Wallbox PV', - parents=[ - 'cd799390-066a-46d2-9000-355338cec086', - 'fa21e915-2cb3-4119-967b-8e3c8db03408', - 'd6d364ff-d455-4906-9126-3d48e935c2c9', - 'e81f30be-3e43-4202-9721-657650664187', - ], - updated_at=dateutil.parser.isoparse('2022-03-05T14:32:00.362Z'), - ), - ], - ), - taxonomy_slug='provident', -) - -res = s.taxonomy.update_classifications_for_taxonomy(req) - -if res.update_classifications_for_taxonomy_200_application_json_object is not None: - # handle response -``` diff --git a/entity/files.gen b/entity/files.gen index 5c8c16cc5..1b0db7a67 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -107,13 +107,277 @@ src/epilot/models/shared/taxonomy.py src/epilot/models/shared/classificationsupdate.py src/epilot/models/shared/security.py src/epilot/models/shared/__init__.py -docs/epilot/README.md -docs/activity/README.md -docs/entities/README.md -docs/entityimport/README.md -docs/export/README.md -docs/relations/README.md -docs/savedviews/README.md -docs/schemas/README.md -docs/taxonomy/README.md -USAGE.md \ No newline at end of file +docs/sdks/epilot/README.md +docs/sdks/activity/README.md +docs/sdks/entities/README.md +docs/sdks/entityimport/README.md +docs/sdks/export/README.md +docs/sdks/relations/README.md +docs/sdks/savedviews/README.md +docs/sdks/schemas/README.md +docs/sdks/taxonomy/README.md +USAGE.md +docs/models/operations/attachactivityrequest.md +docs/models/operations/attachactivityresponse.md +docs/models/operations/createactivityrequest.md +docs/models/operations/createactivityresponse.md +docs/models/operations/getactivityrequest.md +docs/models/operations/getactivityresponse.md +docs/models/operations/getentityactivityfeedrequest.md +docs/models/operations/getentityactivityfeed200applicationjson.md +docs/models/operations/getentityactivityfeedresponse.md +docs/models/operations/autocompleterequest.md +docs/models/operations/autocomplete200applicationjson.md +docs/models/operations/autocompleteresponse.md +docs/models/operations/createentityrequest.md +docs/models/operations/createentityresponse.md +docs/models/operations/deleteentityrequest.md +docs/models/operations/deleteentityresponse.md +docs/models/operations/getentityrequest.md +docs/models/operations/getentity200applicationjson.md +docs/models/operations/getentityresponse.md +docs/models/operations/patchentityrequest.md +docs/models/operations/patchentityresponse.md +docs/models/operations/searchentitiesresponse.md +docs/models/operations/updateentityrequest.md +docs/models/operations/updateentityresponse.md +docs/models/operations/upsertentityrequestbody.md +docs/models/operations/upsertentityrequest.md +docs/models/operations/upsertentityresponse.md +docs/models/operations/importentitiesrequest.md +docs/models/operations/importentitiesresponse.md +docs/models/operations/exportentitiesrequest.md +docs/models/operations/exportentitiesresponse.md +docs/models/operations/addrelationsrequest.md +docs/models/operations/addrelationsresponse.md +docs/models/operations/deleterelationrequest.md +docs/models/operations/deleterelationresponse.md +docs/models/operations/getrelationsrequest.md +docs/models/operations/getrelationsresponse.md +docs/models/operations/getrelationsv2request.md +docs/models/operations/getrelationsv2response.md +docs/models/operations/updaterelationrequestbody.md +docs/models/operations/updaterelationrequest.md +docs/models/operations/updaterelationresponse.md +docs/models/operations/createsavedviewresponse.md +docs/models/operations/deletesavedviewrequest.md +docs/models/operations/deletesavedviewresponse.md +docs/models/operations/getsavedviewrequest.md +docs/models/operations/getsavedview200applicationjson.md +docs/models/operations/getsavedviewresponse.md +docs/models/operations/listsavedviews200applicationjson.md +docs/models/operations/listsavedviewsresponse.md +docs/models/operations/updatesavedviewrequest.md +docs/models/operations/updatesavedviewresponse.md +docs/models/operations/deleteschemarequest.md +docs/models/operations/deleteschemaresponse.md +docs/models/operations/getschemarequest.md +docs/models/operations/getschemaresponse.md +docs/models/operations/getschemaversionsrequest.md +docs/models/operations/getschemaversions200applicationjson.md +docs/models/operations/getschemaversionsresponse.md +docs/models/operations/listschemablueprints200applicationjson.md +docs/models/operations/listschemablueprintsresponse.md +docs/models/operations/listschemasrequest.md +docs/models/operations/listschemas200applicationjson.md +docs/models/operations/listschemasresponse.md +docs/models/operations/listtaxonomyclassificationsforschemarequest.md +docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md +docs/models/operations/listtaxonomyclassificationsforschemaresponse.md +docs/models/operations/putschemarequest.md +docs/models/operations/putschemaresponse.md +docs/models/operations/gettaxonomyrequest.md +docs/models/operations/gettaxonomyresponse.md +docs/models/operations/listtaxonomies200applicationjson.md +docs/models/operations/listtaxonomiesresponse.md +docs/models/operations/taxonomiesclassificationssearchrequestbody.md +docs/models/operations/taxonomiesclassificationssearchrequest.md +docs/models/operations/taxonomiesclassificationssearch200applicationjson.md +docs/models/operations/taxonomiesclassificationssearchresponse.md +docs/models/operations/taxonomyautocompleterequest.md +docs/models/operations/taxonomyautocomplete200applicationjson.md +docs/models/operations/taxonomyautocompleteresponse.md +docs/models/operations/updateclassificationsfortaxonomyrequest.md +docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md +docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md +docs/models/operations/updateclassificationsfortaxonomyresponse.md +docs/models/shared/activityitem.md +docs/models/shared/entityoperationdiff.md +docs/models/shared/entityoperationoperation.md +docs/models/shared/entityoperationparams.md +docs/models/shared/entityoperation.md +docs/models/shared/activity.md +docs/models/shared/entitysearchresultsaggregations.md +docs/models/shared/entitysearchresults.md +docs/models/shared/entitysearchparamsaggs.md +docs/models/shared/entitysearchparams.md +docs/models/shared/entityimportparamss3reference.md +docs/models/shared/entityimportparams.md +docs/models/shared/relationitem.md +docs/models/shared/getrelationsresp.md +docs/models/shared/getrelationsrespwithpagination.md +docs/models/shared/savedviewitemcreatedby1.md +docs/models/shared/savedviewitem.md +docs/models/shared/savedviewcreatedby1.md +docs/models/shared/savedview.md +docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md +docs/models/shared/entityschemaitemgroupsettings.md +docs/models/shared/entityschemaitemsource.md +docs/models/shared/entityschemaitemuiconfiglistitem.md +docs/models/shared/entityschemaitemuiconfigsharing.md +docs/models/shared/entityschemaitemuiconfig.md +docs/models/shared/entityschemaitem.md +docs/models/shared/entitydefaulttabledropdownitems2type.md +docs/models/shared/entitydefaulttabledropdownitems2.md +docs/models/shared/entitydefaulttabledropdownitems1type.md +docs/models/shared/entitydefaulttabledropdownitems1.md +docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md +docs/models/shared/entitydefaulttablenavbaractionsoptions.md +docs/models/shared/entitydefaulttablenavbaractions.md +docs/models/shared/entitydefaulttableviewtype.md +docs/models/shared/entitydefaulttable.md +docs/models/shared/redirectentityviewviewtype.md +docs/models/shared/redirectentityview.md +docs/models/shared/entityviewdisabledviewtype.md +docs/models/shared/entityviewdisabled.md +docs/models/shared/entitydefaultedittablemenuoptions.md +docs/models/shared/entitydefaulteditviewtype.md +docs/models/shared/entitydefaultedit.md +docs/models/shared/summaryattribute.md +docs/models/shared/entitydefaultcreatetablemenuoptions.md +docs/models/shared/entitydefaultcreateviewtype.md +docs/models/shared/entitydefaultcreate.md +docs/models/shared/searchmappingstype.md +docs/models/shared/searchmappings.md +docs/models/shared/entitycapability.md +docs/models/shared/textattributeconstraints.md +docs/models/shared/textattributeinfohelpers.md +docs/models/shared/textattributetype.md +docs/models/shared/textattribute.md +docs/models/shared/linkattributeconstraints.md +docs/models/shared/linkattributeinfohelpers.md +docs/models/shared/linkattributetype.md +docs/models/shared/linkattribute.md +docs/models/shared/dateattributeconstraints.md +docs/models/shared/dateattributeinfohelpers.md +docs/models/shared/dateattributetype.md +docs/models/shared/dateattribute.md +docs/models/shared/countryattributeconstraints.md +docs/models/shared/countryattributeinfohelpers.md +docs/models/shared/countryattributetype.md +docs/models/shared/countryattribute.md +docs/models/shared/booleanattributeconstraints.md +docs/models/shared/booleanattributeinfohelpers.md +docs/models/shared/booleanattributetype.md +docs/models/shared/booleanattribute.md +docs/models/shared/selectattributeconstraints.md +docs/models/shared/selectattributeinfohelpers.md +docs/models/shared/selectattributeoptions1.md +docs/models/shared/selectattributetype.md +docs/models/shared/selectattribute.md +docs/models/shared/multiselectattributeconstraints.md +docs/models/shared/multiselectattributeinfohelpers.md +docs/models/shared/multiselectattributeoptions2.md +docs/models/shared/multiselectattributetype.md +docs/models/shared/multiselectattribute.md +docs/models/shared/statusattributeconstraints.md +docs/models/shared/statusattributeinfohelpers.md +docs/models/shared/statusattributeoptions2.md +docs/models/shared/statusattributetype.md +docs/models/shared/statusattribute.md +docs/models/shared/sequenceattributeconstraints.md +docs/models/shared/sequenceattributeinfohelpers.md +docs/models/shared/sequenceattributetype.md +docs/models/shared/sequenceattribute.md +docs/models/shared/relationattributeactionsactiontype.md +docs/models/shared/relationattributeactions.md +docs/models/shared/relationattributeconstraints.md +docs/models/shared/relationattributedrawersize.md +docs/models/shared/relationattributeeditmode.md +docs/models/shared/relationattributeinfohelpers.md +docs/models/shared/relationattributerelationaffinitymode.md +docs/models/shared/relationattributerelationtype.md +docs/models/shared/relationattributetype.md +docs/models/shared/relationattribute.md +docs/models/shared/summaryfield.md +docs/models/shared/userrelationattributeconstraints.md +docs/models/shared/userrelationattributeinfohelpers.md +docs/models/shared/userrelationattributetype.md +docs/models/shared/userrelationattribute.md +docs/models/shared/addressrelationattributeconstraints.md +docs/models/shared/addressrelationattributeinfohelpers.md +docs/models/shared/addressrelationattributetype.md +docs/models/shared/addressrelationattribute.md +docs/models/shared/paymentmethodrelationattributeconstraints.md +docs/models/shared/paymentmethodrelationattributeinfohelpers.md +docs/models/shared/paymentmethodrelationattributetype.md +docs/models/shared/paymentmethodrelationattribute.md +docs/models/shared/currencyattributeconstraints.md +docs/models/shared/currencyattributecurrency1.md +docs/models/shared/currencyattributeinfohelpers.md +docs/models/shared/currencyattributetype.md +docs/models/shared/currencyattribute.md +docs/models/shared/repeatableattributeconstraints.md +docs/models/shared/repeatableattributeinfohelpers.md +docs/models/shared/repeatableattributerelationaffinitymode.md +docs/models/shared/repeatableattributetype.md +docs/models/shared/repeatableattribute.md +docs/models/shared/tagsattributeconstraints.md +docs/models/shared/tagsattributeinfohelpers.md +docs/models/shared/tagsattributetype.md +docs/models/shared/tagsattribute.md +docs/models/shared/numberattributeconstraints.md +docs/models/shared/numberattributeinfohelpers.md +docs/models/shared/numberattributetype.md +docs/models/shared/numberattribute.md +docs/models/shared/consentattributeconstraints.md +docs/models/shared/consentattributeinfohelpers.md +docs/models/shared/consentattributetype.md +docs/models/shared/consentattribute.md +docs/models/shared/internalattributeconstraints.md +docs/models/shared/internalattributeinfohelpers.md +docs/models/shared/internalattributetype.md +docs/models/shared/internalattribute.md +docs/models/shared/orderedlistattributeconstraints.md +docs/models/shared/orderedlistattributeinfohelpers.md +docs/models/shared/orderedlistattributetype.md +docs/models/shared/orderedlistattribute.md +docs/models/shared/fileattributeconstraints.md +docs/models/shared/fileattributedefaultaccesscontrol.md +docs/models/shared/fileattributeinfohelpers.md +docs/models/shared/fileattributetype.md +docs/models/shared/fileattribute.md +docs/models/shared/computedattributeconstraints.md +docs/models/shared/computedattributeinfohelpers.md +docs/models/shared/computedattributetype.md +docs/models/shared/computedattribute.md +docs/models/shared/partnerstatusattributeconstraints.md +docs/models/shared/partnerstatusattributeinfohelpers.md +docs/models/shared/partnerstatusattributetype.md +docs/models/shared/partnerstatusattribute.md +docs/models/shared/invitationemailattributeconstraints.md +docs/models/shared/invitationemailattributeinfohelpers.md +docs/models/shared/invitationemailattributetype.md +docs/models/shared/invitationemailattribute.md +docs/models/shared/automationattributeconstraints.md +docs/models/shared/automationattributeinfohelpers.md +docs/models/shared/automationattributetype.md +docs/models/shared/automationattribute.md +docs/models/shared/internaluserattributeconstraints.md +docs/models/shared/internaluserattributeinfohelpers.md +docs/models/shared/internaluserattributetype.md +docs/models/shared/internaluserattribute.md +docs/models/shared/purposeattributeconstraints.md +docs/models/shared/purposeattributeinfohelpers.md +docs/models/shared/purposeattributetype.md +docs/models/shared/purposeattribute.md +docs/models/shared/taxonomyclassification.md +docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md +docs/models/shared/entityschemagroupsettings.md +docs/models/shared/entityschemauiconfiglistitem.md +docs/models/shared/entityschemauiconfigsharing.md +docs/models/shared/entityschemauiconfig.md +docs/models/shared/entityschema.md +docs/models/shared/taxonomy.md +docs/models/shared/classificationsupdate.md +docs/models/shared/security.md \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index fe88b324a..613382fce 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.45.2 - generationVersion: 2.37.2 + speakeasyVersion: 1.47.0 + generationVersion: 2.39.0 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.3.0 + version: 1.4.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index b9c2b2092..8c245ef45 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.3.0", + version="1.4.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/operations/__init__.py b/entity/src/epilot/models/operations/__init__.py index 28811cc88..32be57784 100755 --- a/entity/src/epilot/models/operations/__init__.py +++ b/entity/src/epilot/models/operations/__init__.py @@ -37,4 +37,4 @@ from .updatesavedview import * from .upsertentity import * -__all__ = ["AddRelationsRequest","AddRelationsResponse","AttachActivityRequest","AttachActivityResponse","Autocomplete200ApplicationJSON","AutocompleteRequest","AutocompleteResponse","CreateActivityRequest","CreateActivityResponse","CreateEntityRequest","CreateEntityResponse","CreateSavedViewResponse","DeleteEntityRequest","DeleteEntityResponse","DeleteRelationRequest","DeleteRelationResponse","DeleteSavedViewRequest","DeleteSavedViewResponse","DeleteSchemaRequest","DeleteSchemaResponse","ExportEntitiesRequest","ExportEntitiesResponse","GetActivityRequest","GetActivityResponse","GetEntity200ApplicationJSON","GetEntityActivityFeed200ApplicationJSON","GetEntityActivityFeedRequest","GetEntityActivityFeedResponse","GetEntityRequest","GetEntityResponse","GetRelationsRequest","GetRelationsResponse","GetRelationsV2Request","GetRelationsV2Response","GetSavedView200ApplicationJSON","GetSavedViewRequest","GetSavedViewResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaVersions200ApplicationJSON","GetSchemaVersionsRequest","GetSchemaVersionsResponse","GetTaxonomyRequest","GetTaxonomyResponse","ImportEntitiesRequest","ImportEntitiesResponse","ListSavedViews200ApplicationJSON","ListSavedViewsResponse","ListSchemaBlueprints200ApplicationJSON","ListSchemaBlueprintsResponse","ListSchemas200ApplicationJSON","ListSchemasRequest","ListSchemasResponse","ListTaxonomies200ApplicationJSON","ListTaxonomiesResponse","ListTaxonomyClassificationsForSchema200ApplicationJSON","ListTaxonomyClassificationsForSchemaRequest","ListTaxonomyClassificationsForSchemaResponse","PatchEntityRequest","PatchEntityResponse","PutSchemaRequest","PutSchemaResponse","SearchEntitiesResponse","TaxonomiesClassificationsSearch200ApplicationJSON","TaxonomiesClassificationsSearchRequest","TaxonomiesClassificationsSearchRequestBody","TaxonomiesClassificationsSearchResponse","TaxonomyAutocomplete200ApplicationJSON","TaxonomyAutocompleteRequest","TaxonomyAutocompleteResponse","UpdateClassificationsForTaxonomy200ApplicationJSON","UpdateClassificationsForTaxonomyRequest","UpdateClassificationsForTaxonomyResponse","UpdateEntityRequest","UpdateEntityResponse","UpdateRelationRequest","UpdateRelationRequestBody","UpdateRelationResponse","UpdateSavedViewRequest","UpdateSavedViewResponse","UpsertEntityRequest","UpsertEntityRequestBody","UpsertEntityResponse"] +__all__ = ["AddRelationsRequest","AddRelationsResponse","AttachActivityRequest","AttachActivityResponse","Autocomplete200ApplicationJSON","AutocompleteRequest","AutocompleteResponse","CreateActivityRequest","CreateActivityResponse","CreateEntityRequest","CreateEntityResponse","CreateSavedViewResponse","DeleteEntityRequest","DeleteEntityResponse","DeleteRelationRequest","DeleteRelationResponse","DeleteSavedViewRequest","DeleteSavedViewResponse","DeleteSchemaRequest","DeleteSchemaResponse","ExportEntitiesRequest","ExportEntitiesResponse","GetActivityRequest","GetActivityResponse","GetEntity200ApplicationJSON","GetEntityActivityFeed200ApplicationJSON","GetEntityActivityFeedRequest","GetEntityActivityFeedResponse","GetEntityRequest","GetEntityResponse","GetRelationsRequest","GetRelationsResponse","GetRelationsV2Request","GetRelationsV2Response","GetSavedView200ApplicationJSON","GetSavedViewRequest","GetSavedViewResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaVersions200ApplicationJSON","GetSchemaVersionsRequest","GetSchemaVersionsResponse","GetTaxonomyRequest","GetTaxonomyResponse","ImportEntitiesRequest","ImportEntitiesResponse","ListSavedViews200ApplicationJSON","ListSavedViewsResponse","ListSchemaBlueprints200ApplicationJSON","ListSchemaBlueprintsResponse","ListSchemas200ApplicationJSON","ListSchemasRequest","ListSchemasResponse","ListTaxonomies200ApplicationJSON","ListTaxonomiesResponse","ListTaxonomyClassificationsForSchema200ApplicationJSON","ListTaxonomyClassificationsForSchemaRequest","ListTaxonomyClassificationsForSchemaResponse","PatchEntityRequest","PatchEntityResponse","PutSchemaRequest","PutSchemaResponse","SearchEntitiesResponse","TaxonomiesClassificationsSearch200ApplicationJSON","TaxonomiesClassificationsSearchRequest","TaxonomiesClassificationsSearchRequestBody","TaxonomiesClassificationsSearchResponse","TaxonomyAutocomplete200ApplicationJSON","TaxonomyAutocompleteRequest","TaxonomyAutocompleteResponse","UpdateClassificationsForTaxonomy200ApplicationJSON","UpdateClassificationsForTaxonomy200ApplicationJSONDeleted","UpdateClassificationsForTaxonomyRequest","UpdateClassificationsForTaxonomyResponse","UpdateEntityRequest","UpdateEntityResponse","UpdateRelationRequest","UpdateRelationRequestBody","UpdateRelationResponse","UpdateSavedViewRequest","UpdateSavedViewResponse","UpsertEntityRequest","UpsertEntityRequestBody","UpsertEntityResponse"] diff --git a/entity/src/epilot/models/operations/addrelations.py b/entity/src/epilot/models/operations/addrelations.py index f1c7fe46d..974678c18 100755 --- a/entity/src/epilot/models/operations/addrelations.py +++ b/entity/src/epilot/models/operations/addrelations.py @@ -7,9 +7,9 @@ from typing import Optional + @dataclasses.dataclass class AddRelationsRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @@ -19,12 +19,15 @@ class AddRelationsRequest: request_body: Optional[list[shared_relationitem.RelationItem]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + + + @dataclasses.dataclass class AddRelationsResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) relation_item: Optional[shared_relationitem.RelationItem] = dataclasses.field(default=None) r"""Success""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/attachactivity.py b/entity/src/epilot/models/operations/attachactivity.py index 0e01e3d3d..e65cbcf72 100755 --- a/entity/src/epilot/models/operations/attachactivity.py +++ b/entity/src/epilot/models/operations/attachactivity.py @@ -7,21 +7,24 @@ from typing import Optional + @dataclasses.dataclass class AttachActivityRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Activity Id""" entities: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'entities', 'style': 'form', 'explode': False }}) r"""Comma-separated list of entities which the activity primarily concerns""" + + + @dataclasses.dataclass class AttachActivityResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() activity_item: Optional[shared_activityitem.ActivityItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/autocomplete.py b/entity/src/epilot/models/operations/autocomplete.py index 7c41af7d8..bcfae8235 100755 --- a/entity/src/epilot/models/operations/autocomplete.py +++ b/entity/src/epilot/models/operations/autocomplete.py @@ -8,9 +8,9 @@ from typing import Any, Optional + @dataclasses.dataclass class AutocompleteRequest: - attribute: str = dataclasses.field(metadata={'query_param': { 'field_name': 'attribute', 'style': 'form', 'explode': True }}) r"""Autocomplete attribute""" input: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'input', 'style': 'form', 'explode': True }}) @@ -21,21 +21,26 @@ class AutocompleteRequest: r"""Limit results to entity schema""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class Autocomplete200ApplicationJSON: r"""Success""" - hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) results: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class AutocompleteResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() autocomplete_200_application_json_object: Optional[Autocomplete200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/createactivity.py b/entity/src/epilot/models/operations/createactivity.py index 325121647..5bcf5a62b 100755 --- a/entity/src/epilot/models/operations/createactivity.py +++ b/entity/src/epilot/models/operations/createactivity.py @@ -8,20 +8,23 @@ from typing import Optional + @dataclasses.dataclass class CreateActivityRequest: - activity: Optional[shared_activity.Activity] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) entities: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'entities', 'style': 'form', 'explode': False }}) r"""Comma-separated list of entities which the activity primarily concerns""" + + + @dataclasses.dataclass class CreateActivityResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() activity_item: Optional[shared_activityitem.ActivityItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/createentity.py b/entity/src/epilot/models/operations/createentity.py index 53149e334..d40bd5b02 100755 --- a/entity/src/epilot/models/operations/createentity.py +++ b/entity/src/epilot/models/operations/createentity.py @@ -6,9 +6,9 @@ from typing import Any, Optional + @dataclasses.dataclass class CreateEntityRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Schema""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) @@ -18,12 +18,15 @@ class CreateEntityRequest: request_body: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + + + @dataclasses.dataclass class CreateEntityResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/createsavedview.py b/entity/src/epilot/models/operations/createsavedview.py index 66d9ffad2..de4137f24 100755 --- a/entity/src/epilot/models/operations/createsavedview.py +++ b/entity/src/epilot/models/operations/createsavedview.py @@ -7,12 +7,13 @@ from typing import Optional + @dataclasses.dataclass class CreateSavedViewResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) saved_view_item: Optional[shared_savedviewitem.SavedViewItem] = dataclasses.field(default=None) r"""Success""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/deleteentity.py b/entity/src/epilot/models/operations/deleteentity.py index 5c36bc644..82834d3f8 100755 --- a/entity/src/epilot/models/operations/deleteentity.py +++ b/entity/src/epilot/models/operations/deleteentity.py @@ -6,9 +6,9 @@ from typing import Optional + @dataclasses.dataclass class DeleteEntityRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Type""" @@ -16,10 +16,13 @@ class DeleteEntityRequest: r"""Activity to include in event feed""" + + + @dataclasses.dataclass class DeleteEntityResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/deleterelation.py b/entity/src/epilot/models/operations/deleterelation.py index 52509fd77..fce2e72e8 100755 --- a/entity/src/epilot/models/operations/deleterelation.py +++ b/entity/src/epilot/models/operations/deleterelation.py @@ -6,9 +6,9 @@ from typing import Optional + @dataclasses.dataclass class DeleteRelationRequest: - attribute: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attribute', 'style': 'simple', 'explode': False }}) r"""The attribute that express meaning""" entity_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'entity_id', 'style': 'simple', 'explode': False }}) @@ -21,10 +21,13 @@ class DeleteRelationRequest: r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" + + + @dataclasses.dataclass class DeleteRelationResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/deletesavedview.py b/entity/src/epilot/models/operations/deletesavedview.py index c43649bb3..b367e9962 100755 --- a/entity/src/epilot/models/operations/deletesavedview.py +++ b/entity/src/epilot/models/operations/deletesavedview.py @@ -6,17 +6,20 @@ from typing import Optional + @dataclasses.dataclass class DeleteSavedViewRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""View id""" + + + @dataclasses.dataclass class DeleteSavedViewResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/deleteschema.py b/entity/src/epilot/models/operations/deleteschema.py index c44a6f1e6..9577de4c0 100755 --- a/entity/src/epilot/models/operations/deleteschema.py +++ b/entity/src/epilot/models/operations/deleteschema.py @@ -6,16 +6,19 @@ from typing import Optional + @dataclasses.dataclass class DeleteSchemaRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + + + @dataclasses.dataclass class DeleteSchemaResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/exportentities.py b/entity/src/epilot/models/operations/exportentities.py index 3cb1c5377..fd7b863b4 100755 --- a/entity/src/epilot/models/operations/exportentities.py +++ b/entity/src/epilot/models/operations/exportentities.py @@ -7,9 +7,9 @@ from typing import Optional + @dataclasses.dataclass class ExportEntitiesRequest: - entity_search_params: Optional[shared_entitysearchparams.EntitySearchParams] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) is_template: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'is_template', 'style': 'form', 'explode': True }}) r"""Pass 'true' to generate import template""" @@ -19,10 +19,13 @@ class ExportEntitiesRequest: r"""Export headers translation language""" + + + @dataclasses.dataclass class ExportEntitiesResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/getactivity.py b/entity/src/epilot/models/operations/getactivity.py index 3117c4ceb..1d682cdef 100755 --- a/entity/src/epilot/models/operations/getactivity.py +++ b/entity/src/epilot/models/operations/getactivity.py @@ -7,9 +7,9 @@ from typing import Optional + @dataclasses.dataclass class GetActivityRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Activity Id""" operations_from: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'operations_from', 'style': 'form', 'explode': True }}) @@ -18,12 +18,15 @@ class GetActivityRequest: r"""Maximum number of operations to include in response (default: 10)""" + + + @dataclasses.dataclass class GetActivityResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() activity_item: Optional[shared_activityitem.ActivityItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/getentity.py b/entity/src/epilot/models/operations/getentity.py index 771f46c85..87d20db59 100755 --- a/entity/src/epilot/models/operations/getentity.py +++ b/entity/src/epilot/models/operations/getentity.py @@ -8,9 +8,9 @@ from typing import Any, Optional + @dataclasses.dataclass class GetEntityRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @@ -19,21 +19,26 @@ class GetEntityRequest: r"""When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class GetEntity200ApplicationJSON: r"""Success""" - entity: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity'), 'exclude': lambda f: f is None }}) relations: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class GetEntityResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() get_entity_200_application_json_object: Optional[GetEntity200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/getentityactivityfeed.py b/entity/src/epilot/models/operations/getentityactivityfeed.py index 2ede3a77a..c16fc2455 100755 --- a/entity/src/epilot/models/operations/getentityactivityfeed.py +++ b/entity/src/epilot/models/operations/getentityactivityfeed.py @@ -10,9 +10,9 @@ from typing import Optional + @dataclasses.dataclass class GetEntityActivityFeedRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @@ -29,21 +29,26 @@ class GetEntityActivityFeedRequest: r"""Activity type""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class GetEntityActivityFeed200ApplicationJSON: r"""Success""" - results: Optional[list[shared_activityitem.ActivityItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) total: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('total'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class GetEntityActivityFeedResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() get_entity_activity_feed_200_application_json_object: Optional[GetEntityActivityFeed200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py index 46e9948a8..e3c42dea3 100755 --- a/entity/src/epilot/models/operations/getrelations.py +++ b/entity/src/epilot/models/operations/getrelations.py @@ -6,9 +6,9 @@ from typing import Any, Optional + @dataclasses.dataclass class GetRelationsRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @@ -19,12 +19,15 @@ class GetRelationsRequest: r"""When true, includes reverse relations in response (other entities pointing to this entity)""" + + + @dataclasses.dataclass class GetRelationsResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() get_relations_resp: Optional[list[Any]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/getrelationsv2.py b/entity/src/epilot/models/operations/getrelationsv2.py index f5cca7882..51982bb0e 100755 --- a/entity/src/epilot/models/operations/getrelationsv2.py +++ b/entity/src/epilot/models/operations/getrelationsv2.py @@ -7,9 +7,9 @@ from typing import Optional + @dataclasses.dataclass class GetRelationsV2Request: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @@ -28,12 +28,15 @@ class GetRelationsV2Request: r"""Number of results to return per page""" + + + @dataclasses.dataclass class GetRelationsV2Response: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() get_relations_resp_with_pagination: Optional[shared_getrelationsrespwithpagination.GetRelationsRespWithPagination] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/getsavedview.py b/entity/src/epilot/models/operations/getsavedview.py index 5e1036ef3..28e29ace7 100755 --- a/entity/src/epilot/models/operations/getsavedview.py +++ b/entity/src/epilot/models/operations/getsavedview.py @@ -9,27 +9,32 @@ from typing import Optional + @dataclasses.dataclass class GetSavedViewRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""View id""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class GetSavedView200ApplicationJSON: r"""Success""" - view: Optional[shared_savedviewitem.SavedViewItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class GetSavedViewResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() get_saved_view_200_application_json_object: Optional[GetSavedView200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/getschema.py b/entity/src/epilot/models/operations/getschema.py index 4b89cb308..f1b6689c8 100755 --- a/entity/src/epilot/models/operations/getschema.py +++ b/entity/src/epilot/models/operations/getschema.py @@ -7,19 +7,22 @@ from typing import Optional + @dataclasses.dataclass class GetSchemaRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'id', 'style': 'form', 'explode': True }}) + + + @dataclasses.dataclass class GetSchemaResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() entity_schema_item: Optional[shared_entityschemaitem.EntitySchemaItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/getschemaversions.py b/entity/src/epilot/models/operations/getschemaversions.py index cfbd7851d..156db0297 100755 --- a/entity/src/epilot/models/operations/getschemaversions.py +++ b/entity/src/epilot/models/operations/getschemaversions.py @@ -9,9 +9,9 @@ from typing import Optional + @dataclasses.dataclass class GetSchemaVersionsRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) drafts_from: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'drafts_from', 'style': 'form', 'explode': True }}) drafts_size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'drafts_size', 'style': 'form', 'explode': True }}) @@ -19,21 +19,26 @@ class GetSchemaVersionsRequest: versions_size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'versions_size', 'style': 'form', 'explode': True }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class GetSchemaVersions200ApplicationJSON: r"""Success""" - drafts: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('drafts'), 'exclude': lambda f: f is None }}) versions: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('versions'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class GetSchemaVersionsResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() get_schema_versions_200_application_json_object: Optional[GetSchemaVersions200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/gettaxonomy.py b/entity/src/epilot/models/operations/gettaxonomy.py index 441fac98b..209a15e83 100755 --- a/entity/src/epilot/models/operations/gettaxonomy.py +++ b/entity/src/epilot/models/operations/gettaxonomy.py @@ -7,19 +7,22 @@ from typing import Optional + @dataclasses.dataclass class GetTaxonomyRequest: - taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) r"""Taxonomy slug to return taxonomy for""" + + + @dataclasses.dataclass class GetTaxonomyResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) taxonomy: Optional[shared_taxonomy.Taxonomy] = dataclasses.field(default=None) r"""Taxonomy""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/importentities.py b/entity/src/epilot/models/operations/importentities.py index 1663206ab..ca38dda0a 100755 --- a/entity/src/epilot/models/operations/importentities.py +++ b/entity/src/epilot/models/operations/importentities.py @@ -7,18 +7,21 @@ from typing import Optional + @dataclasses.dataclass class ImportEntitiesRequest: - entity_import_params: Optional[shared_entityimportparams.EntityImportParams] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) job_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'job_id', 'style': 'form', 'explode': True }}) r"""The ID of the import job. This ID is used to track the progress and fetch the result of the import operation.""" + + + @dataclasses.dataclass class ImportEntitiesResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/listsavedviews.py b/entity/src/epilot/models/operations/listsavedviews.py index 6fb9c1c27..2273d8b7b 100755 --- a/entity/src/epilot/models/operations/listsavedviews.py +++ b/entity/src/epilot/models/operations/listsavedviews.py @@ -10,19 +10,22 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ListSavedViews200ApplicationJSON: r"""Success""" - results: Optional[list[shared_savedviewitem.SavedViewItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class ListSavedViewsResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() list_saved_views_200_application_json_object: Optional[ListSavedViews200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/listschemablueprints.py b/entity/src/epilot/models/operations/listschemablueprints.py index 7ba9e7260..cb4edc4f8 100755 --- a/entity/src/epilot/models/operations/listschemablueprints.py +++ b/entity/src/epilot/models/operations/listschemablueprints.py @@ -10,19 +10,22 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ListSchemaBlueprints200ApplicationJSON: r"""Success""" - results: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class ListSchemaBlueprintsResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() list_schema_blueprints_200_application_json_object: Optional[ListSchemaBlueprints200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/listschemas.py b/entity/src/epilot/models/operations/listschemas.py index cb7accd57..7dd2cbd30 100755 --- a/entity/src/epilot/models/operations/listschemas.py +++ b/entity/src/epilot/models/operations/listschemas.py @@ -9,27 +9,32 @@ from typing import Optional + @dataclasses.dataclass class ListSchemasRequest: - unpublished: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'unpublished', 'style': 'form', 'explode': True }}) r"""Return unpublished draft schemas""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ListSchemas200ApplicationJSON: r"""Success""" - results: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class ListSchemasResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() list_schemas_200_application_json_object: Optional[ListSchemas200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/listtaxonomies.py b/entity/src/epilot/models/operations/listtaxonomies.py index 709ae7dd4..7f1d30fec 100755 --- a/entity/src/epilot/models/operations/listtaxonomies.py +++ b/entity/src/epilot/models/operations/listtaxonomies.py @@ -10,19 +10,22 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ListTaxonomies200ApplicationJSON: r"""Returns list of taxonomies in an organisation""" - results: Optional[list[shared_taxonomy.Taxonomy]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class ListTaxonomiesResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() list_taxonomies_200_application_json_object: Optional[ListTaxonomies200ApplicationJSON] = dataclasses.field(default=None) r"""Returns list of taxonomies in an organisation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py index 4948755a5..49ffd909e 100755 --- a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py +++ b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py @@ -9,29 +9,34 @@ from typing import Optional + @dataclasses.dataclass class ListTaxonomyClassificationsForSchemaRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ListTaxonomyClassificationsForSchema200ApplicationJSON: r"""List of taxonomy classifications""" - results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class ListTaxonomyClassificationsForSchemaResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() list_taxonomy_classifications_for_schema_200_application_json_object: Optional[ListTaxonomyClassificationsForSchema200ApplicationJSON] = dataclasses.field(default=None) r"""List of taxonomy classifications""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/patchentity.py b/entity/src/epilot/models/operations/patchentity.py index e2d8d2e4d..55efcc620 100755 --- a/entity/src/epilot/models/operations/patchentity.py +++ b/entity/src/epilot/models/operations/patchentity.py @@ -6,9 +6,9 @@ from typing import Any, Optional + @dataclasses.dataclass class PatchEntityRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Entity Id""" request_body: dict[str, Any] = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) @@ -22,12 +22,15 @@ class PatchEntityRequest: r"""Dry Run mode = returns the patch result but doesn't perform the patch.""" + + + @dataclasses.dataclass class PatchEntityResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) r"""Entity was updated""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/putschema.py b/entity/src/epilot/models/operations/putschema.py index 967074aca..cdd19e756 100755 --- a/entity/src/epilot/models/operations/putschema.py +++ b/entity/src/epilot/models/operations/putschema.py @@ -8,20 +8,23 @@ from typing import Optional + @dataclasses.dataclass class PutSchemaRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) draft: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'draft', 'style': 'form', 'explode': True }}) entity_schema: Optional[shared_entityschema.EntitySchema] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + + + @dataclasses.dataclass class PutSchemaResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() entity_schema_item: Optional[shared_entityschemaitem.EntitySchemaItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/searchentities.py b/entity/src/epilot/models/operations/searchentities.py index 6abecb5ea..9149446ec 100755 --- a/entity/src/epilot/models/operations/searchentities.py +++ b/entity/src/epilot/models/operations/searchentities.py @@ -7,9 +7,9 @@ from typing import Optional + @dataclasses.dataclass class SearchEntitiesResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() entity_search_results: Optional[shared_entitysearchresults.EntitySearchResults] = dataclasses.field(default=None) @@ -17,4 +17,5 @@ class SearchEntitiesResponse: raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) search_entities_200_text_csv_string: Optional[str] = dataclasses.field(default=None) r"""Success""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py b/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py index 0f41b3622..3efb371f7 100755 --- a/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py +++ b/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py @@ -10,34 +10,41 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class TaxonomiesClassificationsSearchRequestBody: - classification_ids: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classificationIds'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class TaxonomiesClassificationsSearchRequest: - taxonomy_slug: str = dataclasses.field(metadata={'query_param': { 'field_name': 'taxonomySlug', 'style': 'form', 'explode': True }}) r"""Taxonomy slug""" request_body: Optional[TaxonomiesClassificationsSearchRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class TaxonomiesClassificationsSearch200ApplicationJSON: r"""Returns list of taxonomy classifications""" - results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class TaxonomiesClassificationsSearchResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) taxonomies_classifications_search_200_application_json_object: Optional[TaxonomiesClassificationsSearch200ApplicationJSON] = dataclasses.field(default=None) r"""Returns list of taxonomy classifications""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/taxonomyautocomplete.py b/entity/src/epilot/models/operations/taxonomyautocomplete.py index 1586e1622..661a4c6c9 100755 --- a/entity/src/epilot/models/operations/taxonomyautocomplete.py +++ b/entity/src/epilot/models/operations/taxonomyautocomplete.py @@ -9,9 +9,9 @@ from typing import Optional + @dataclasses.dataclass class TaxonomyAutocompleteRequest: - taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) r"""Limit results to slug""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) @@ -20,20 +20,25 @@ class TaxonomyAutocompleteRequest: r"""Minimum number of results to return""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class TaxonomyAutocomplete200ApplicationJSON: r"""Taxonomy classifications""" - results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class TaxonomyAutocompleteResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) taxonomy_autocomplete_200_application_json_object: Optional[TaxonomyAutocomplete200ApplicationJSON] = dataclasses.field(default=None) r"""Taxonomy classifications""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py b/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py index 0f48510b0..78378d94c 100755 --- a/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py +++ b/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py @@ -7,33 +7,44 @@ from ..shared import taxonomyclassification as shared_taxonomyclassification from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import Optional + @dataclasses.dataclass class UpdateClassificationsForTaxonomyRequest: - taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) r"""Taxonomy slug""" classifications_update: Optional[shared_classificationsupdate.ClassificationsUpdate] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + + + +@dataclasses.dataclass +class UpdateClassificationsForTaxonomy200ApplicationJSONDeleted: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class UpdateClassificationsForTaxonomy200ApplicationJSON: r"""Taxonomies classifications""" - created: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created'), 'exclude': lambda f: f is None }}) - deleted: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deleted'), 'exclude': lambda f: f is None }}) + deleted: Optional[UpdateClassificationsForTaxonomy200ApplicationJSONDeleted] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deleted'), 'exclude': lambda f: f is None }}) updated: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class UpdateClassificationsForTaxonomyResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) update_classifications_for_taxonomy_200_application_json_object: Optional[UpdateClassificationsForTaxonomy200ApplicationJSON] = dataclasses.field(default=None) r"""Taxonomies classifications""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/updateentity.py b/entity/src/epilot/models/operations/updateentity.py index cfac0a796..8e6c8a0ab 100755 --- a/entity/src/epilot/models/operations/updateentity.py +++ b/entity/src/epilot/models/operations/updateentity.py @@ -6,9 +6,9 @@ from typing import Any, Optional + @dataclasses.dataclass class UpdateEntityRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @@ -20,12 +20,15 @@ class UpdateEntityRequest: request_body: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + + + @dataclasses.dataclass class UpdateEntityResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/updaterelation.py b/entity/src/epilot/models/operations/updaterelation.py index fc397ac49..7d4cae986 100755 --- a/entity/src/epilot/models/operations/updaterelation.py +++ b/entity/src/epilot/models/operations/updaterelation.py @@ -10,15 +10,17 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class UpdateRelationRequestBody: - tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) + + + @dataclasses.dataclass class UpdateRelationRequest: - attribute: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attribute', 'style': 'simple', 'explode': False }}) r"""The attribute that express meaning""" entity_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'entity_id', 'style': 'simple', 'explode': False }}) @@ -32,12 +34,15 @@ class UpdateRelationRequest: request_body: Optional[UpdateRelationRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + + + @dataclasses.dataclass class UpdateRelationResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) relation_item: Optional[shared_relationitem.RelationItem] = dataclasses.field(default=None) r"""Success""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/updatesavedview.py b/entity/src/epilot/models/operations/updatesavedview.py index edd752804..7dc152c1d 100755 --- a/entity/src/epilot/models/operations/updatesavedview.py +++ b/entity/src/epilot/models/operations/updatesavedview.py @@ -8,20 +8,23 @@ from typing import Optional + @dataclasses.dataclass class UpdateSavedViewRequest: - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""View id""" saved_view: Optional[shared_savedview.SavedView] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + + + @dataclasses.dataclass class UpdateSavedViewResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) saved_view_item: Optional[shared_savedviewitem.SavedViewItem] = dataclasses.field(default=None) r"""Success""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/operations/upsertentity.py b/entity/src/epilot/models/operations/upsertentity.py index ab5ca3c27..39939f2eb 100755 --- a/entity/src/epilot/models/operations/upsertentity.py +++ b/entity/src/epilot/models/operations/upsertentity.py @@ -9,16 +9,18 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class UpsertEntityRequestBody: - entity: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity') }}) unique_key: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unique_key') }}) + + + @dataclasses.dataclass class UpsertEntityRequest: - slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Schema""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) @@ -30,12 +32,15 @@ class UpsertEntityRequest: request_body: Optional[UpsertEntityRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + + + @dataclasses.dataclass class UpsertEntityResponse: - content_type: str = dataclasses.field() status_code: int = dataclasses.field() entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) r"""Entity was updated""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index 48491c7f6..2b3ee246f 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -54,4 +54,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigSharing","EntitySchemaUIConfig","EntitySchemaUIConfigListItem","EntitySchemaUIConfigSharing","EntitySearchParams","EntitySearchResults","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsResp","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerStatusAttribute","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeInfoHelpers","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeInfoHelpers","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] +__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigSharing","EntitySchemaUIConfig","EntitySchemaUIConfigListItem","EntitySchemaUIConfigSharing","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsResp","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] diff --git a/entity/src/epilot/models/shared/activity.py b/entity/src/epilot/models/shared/activity.py index d9ec57c04..f8a872f59 100755 --- a/entity/src/epilot/models/shared/activity.py +++ b/entity/src/epilot/models/shared/activity.py @@ -8,13 +8,14 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class Activity: - message: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message') }}) r"""Message for activity. Supports handlebars syntax.""" title: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title') }}) r"""Title for activity. Supports handlebars syntax.""" type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/activityitem.py b/entity/src/epilot/models/shared/activityitem.py index 7dbba6926..390675793 100755 --- a/entity/src/epilot/models/shared/activityitem.py +++ b/entity/src/epilot/models/shared/activityitem.py @@ -12,10 +12,10 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ActivityItem: r"""Success""" - message: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message') }}) r"""Message for activity. Supports handlebars syntax.""" title: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title') }}) @@ -29,4 +29,5 @@ class ActivityItem: r"""Count of total operations attached to this activity""" payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) timestamp: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timestamp'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/addressrelationattribute.py b/entity/src/epilot/models/shared/addressrelationattribute.py index 1dc988e75..9e0eb5847 100755 --- a/entity/src/epilot/models/shared/addressrelationattribute.py +++ b/entity/src/epilot/models/shared/addressrelationattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class AddressRelationAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class AddressRelationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class AddressRelationAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class AddressRelationAttributeType(str, Enum): RELATION_ADDRESS = 'relation_address' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class AddressRelationAttribute: r"""Reference to an address attribute of another entity""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[AddressRelationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -86,4 +97,5 @@ class AddressRelationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[AddressRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/automationattribute.py b/entity/src/epilot/models/shared/automationattribute.py index d3d2200f7..2fd13ce0f 100755 --- a/entity/src/epilot/models/shared/automationattribute.py +++ b/entity/src/epilot/models/shared/automationattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class AutomationAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class AutomationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class AutomationAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class AutomationAttributeType(str, Enum): AUTOMATION = 'automation' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class AutomationAttribute: r"""Automation entity""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[AutomationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -85,4 +96,5 @@ class AutomationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[AutomationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/booleanattribute.py b/entity/src/epilot/models/shared/booleanattribute.py index 5c76d0a4b..25f292a35 100755 --- a/entity/src/epilot/models/shared/booleanattribute.py +++ b/entity/src/epilot/models/shared/booleanattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class BooleanAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class BooleanAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class BooleanAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class BooleanAttributeType(str, Enum): BOOLEAN = 'boolean' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class BooleanAttribute: r"""Yes / No Toggle""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[BooleanAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -85,4 +96,5 @@ class BooleanAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[BooleanAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/classificationsupdate.py b/entity/src/epilot/models/shared/classificationsupdate.py index 9318a95db..0089f548f 100755 --- a/entity/src/epilot/models/shared/classificationsupdate.py +++ b/entity/src/epilot/models/shared/classificationsupdate.py @@ -9,10 +9,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ClassificationsUpdate: - create: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create'), 'exclude': lambda f: f is None }}) delete: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('delete'), 'exclude': lambda f: f is None }}) update: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('update'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/computedattribute.py b/entity/src/epilot/models/shared/computedattribute.py index 4286d21e4..9a9c8fa84 100755 --- a/entity/src/epilot/models/shared/computedattribute.py +++ b/entity/src/epilot/models/shared/computedattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class ComputedAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ComputedAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class ComputedAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class ComputedAttributeType(str, Enum): COMPUTED = 'computed' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ComputedAttribute: r"""An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes)""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[ComputedAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -85,4 +96,5 @@ class ComputedAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[ComputedAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/consentattribute.py b/entity/src/epilot/models/shared/consentattribute.py index d97a6fad9..3e41efebb 100755 --- a/entity/src/epilot/models/shared/consentattribute.py +++ b/entity/src/epilot/models/shared/consentattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class ConsentAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ConsentAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,21 +40,23 @@ class ConsentAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class ConsentAttributeType(str, Enum): CONSENT = 'consent' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class ConsentAttribute: r"""Consent Management""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) topic: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('topic') }}) type: ConsentAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[ConsentAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -87,4 +98,5 @@ class ConsentAttribute: show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/countryattribute.py b/entity/src/epilot/models/shared/countryattribute.py index cc35f9eb3..c6c465751 100755 --- a/entity/src/epilot/models/shared/countryattribute.py +++ b/entity/src/epilot/models/shared/countryattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class CountryAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class CountryAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class CountryAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class CountryAttributeType(str, Enum): COUNTRY = 'country' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class CountryAttribute: r"""Country picker""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[CountryAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -85,4 +96,5 @@ class CountryAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[CountryAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/currencyattribute.py b/entity/src/epilot/models/shared/currencyattribute.py index 347e3d736..f82c455c8 100755 --- a/entity/src/epilot/models/shared/currencyattribute.py +++ b/entity/src/epilot/models/shared/currencyattribute.py @@ -8,22 +8,33 @@ from typing import Any, Optional + +@dataclasses.dataclass +class CurrencyAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class CurrencyAttributeCurrency1: r"""A currency configuration""" - code: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('code') }}) description: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) symbol: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('symbol') }}) flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('flag'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class CurrencyAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -42,22 +53,24 @@ class CurrencyAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class CurrencyAttributeType(str, Enum): CURRENCY = 'currency' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class CurrencyAttribute: r"""Currency input""" - currency: list[Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) r"""An array of currency configurations with a country code (ISO-4217)""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) type: CurrencyAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[CurrencyAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -99,4 +112,5 @@ class CurrencyAttribute: show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/dateattribute.py b/entity/src/epilot/models/shared/dateattribute.py index 1a893f8a9..8c575a99f 100755 --- a/entity/src/epilot/models/shared/dateattribute.py +++ b/entity/src/epilot/models/shared/dateattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class DateAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class DateAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,20 +40,22 @@ class DateAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class DateAttributeType(str, Enum): DATE = 'date' DATETIME = 'datetime' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class DateAttribute: r"""Date or Datetime picker""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[DateAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -86,4 +97,5 @@ class DateAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[DateAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entitycapability.py b/entity/src/epilot/models/shared/entitycapability.py index b8aeac623..65e2d15d6 100755 --- a/entity/src/epilot/models/shared/entitycapability.py +++ b/entity/src/epilot/models/shared/entitycapability.py @@ -8,10 +8,10 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityCapability: r"""Capabilities the Entity has. Turn features on/off for entities.""" - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Unique name for the capability""" purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) @@ -25,4 +25,5 @@ class EntityCapability: title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) r"""Human readable title of the capability""" ui_hooks: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_hooks'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entitydefaultcreate.py b/entity/src/epilot/models/shared/entitydefaultcreate.py index 38527bc36..001572853 100755 --- a/entity/src/epilot/models/shared/entitydefaultcreate.py +++ b/entity/src/epilot/models/shared/entitydefaultcreate.py @@ -9,21 +9,24 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityDefaultCreateTableMenuOptions: - icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label'), 'exclude': lambda f: f is None }}) + + class EntityDefaultCreateViewType(str, Enum): DEFAULT = 'default' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityDefaultCreate: - search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) table_menu_options: Optional[EntityDefaultCreateTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) view_type: Optional[EntityDefaultCreateViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entitydefaultedit.py b/entity/src/epilot/models/shared/entitydefaultedit.py index e5219557d..0b18bfaeb 100755 --- a/entity/src/epilot/models/shared/entitydefaultedit.py +++ b/entity/src/epilot/models/shared/entitydefaultedit.py @@ -9,21 +9,24 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityDefaultEditTableMenuOptions: - icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label'), 'exclude': lambda f: f is None }}) + + class EntityDefaultEditViewType(str, Enum): DEFAULT = 'default' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityDefaultEdit: - search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) table_menu_options: Optional[EntityDefaultEditTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) view_type: Optional[EntityDefaultEditViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py index b439daf6a..e1ef9434b 100755 --- a/entity/src/epilot/models/shared/entitydefaulttable.py +++ b/entity/src/epilot/models/shared/entitydefaulttable.py @@ -12,9 +12,9 @@ class EntityDefaultTableDropdownItems2Type(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityDefaultTableDropdownItems2: - feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This dropdown item should only be active when the feature flag is enabled""" legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) @@ -23,14 +23,16 @@ class EntityDefaultTableDropdownItems2: type: Optional[EntityDefaultTableDropdownItems2Type] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('uri'), 'exclude': lambda f: f is None }}) + + class EntityDefaultTableDropdownItems1Type(str, Enum): ENTITY = 'entity' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityDefaultTableDropdownItems1: - entity: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity'), 'exclude': lambda f: f is None }}) r"""URL-friendly identifier for the entity schema""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) @@ -40,29 +42,41 @@ class EntityDefaultTableDropdownItems1: type: Optional[EntityDefaultTableDropdownItems1Type] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + + + +@dataclasses.dataclass +class EntityDefaultTableNavbarActionsOptionsParams: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityDefaultTableNavbarActionsOptions: - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - params: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('params'), 'exclude': lambda f: f is None }}) + params: Optional[EntityDefaultTableNavbarActionsOptionsParams] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('params'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityDefaultTableNavbarActions: - type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) options: Optional[list[EntityDefaultTableNavbarActionsOptions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + + class EntityDefaultTableViewType(str, Enum): DEFAULT = 'default' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityDefaultTable: - classic_view: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classic_view'), 'exclude': lambda f: f is None }}) dropdown_items: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dropdown_items'), 'exclude': lambda f: f is None }}) enable_thumbnails: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_thumbnails'), 'exclude': lambda f: f is None }}) @@ -70,4 +84,5 @@ class EntityDefaultTable: navbar_actions: Optional[list[EntityDefaultTableNavbarActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('navbar_actions'), 'exclude': lambda f: f is None }}) row_actions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('row_actions'), 'exclude': lambda f: f is None }}) view_type: Optional[EntityDefaultTableViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entityimportparams.py b/entity/src/epilot/models/shared/entityimportparams.py index a5a25eca7..16767e71a 100755 --- a/entity/src/epilot/models/shared/entityimportparams.py +++ b/entity/src/epilot/models/shared/entityimportparams.py @@ -7,23 +7,26 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityImportParamsS3Reference: r"""The S3 bucket and key where the JSON file for import is located.""" - bucket: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bucket') }}) r"""The name of the S3 bucket where the JSON file for import is stored.""" key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key') }}) r"""The key or path to the JSON file within the S3 bucket.""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityImportParams: r"""The parameters for importing entities.""" - s3_reference: EntityImportParamsS3Reference = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('S3Reference') }}) r"""The S3 bucket and key where the JSON file for import is located.""" schema: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schema') }}) r"""The schema of the entities being imported. This must match the schema of the entities on the platform.""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entityoperation.py b/entity/src/epilot/models/shared/entityoperation.py index 5fb7b3834..bb79d5274 100755 --- a/entity/src/epilot/models/shared/entityoperation.py +++ b/entity/src/epilot/models/shared/entityoperation.py @@ -9,13 +9,15 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityOperationDiff: - added: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('added'), 'exclude': lambda f: f is None }}) deleted: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deleted'), 'exclude': lambda f: f is None }}) updated: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated'), 'exclude': lambda f: f is None }}) + + class EntityOperationOperation(str, Enum): CREATE_ENTITY = 'createEntity' UPDATE_ENTITY = 'updateEntity' @@ -23,18 +25,20 @@ class EntityOperationOperation(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityOperationParams: - id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) slug: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug'), 'exclude': lambda f: f is None }}) r"""URL-friendly identifier for the entity schema""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityOperation: - entity: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity') }}) operation: EntityOperationOperation = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('operation') }}) org: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org') }}) @@ -43,4 +47,5 @@ class EntityOperation: diff: Optional[EntityOperationDiff] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('diff'), 'exclude': lambda f: f is None }}) params: Optional[EntityOperationParams] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('params'), 'exclude': lambda f: f is None }}) payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entityschema.py b/entity/src/epilot/models/shared/entityschema.py index 7786a3631..bd1aa5794 100755 --- a/entity/src/epilot/models/shared/entityschema.py +++ b/entity/src/epilot/models/shared/entityschema.py @@ -10,17 +10,19 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaGroupSettingsInfoTooltipTitle: - default: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default'), 'exclude': lambda f: f is None }}) key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaGroupSettings: - id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) @@ -35,25 +37,31 @@ class EntitySchemaGroupSettings: r"""This group should only be active when the setting is enabled""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaUIConfigListItem: - summary_attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaUIConfigSharing: - show_sharing_button: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_sharing_button'), 'exclude': lambda f: f is None }}) r"""Show the sharing button in entity detail view""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaUIConfig: - create_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) edit_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_view'), 'exclude': lambda f: f is None }}) list_item: Optional[EntitySchemaUIConfigListItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('list_item'), 'exclude': lambda f: f is None }}) @@ -62,11 +70,13 @@ class EntitySchemaUIConfig: table_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_view'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchema: r"""The \\"type\\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.""" - attributes: list[Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) r"""An ordered list of attributes the entity contains""" capabilities: list[shared_entitycapability.EntityCapability] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities') }}) @@ -98,4 +108,5 @@ class EntitySchema: r"""Template for rendering the title field. Uses handlebars""" ui_config: Optional[EntitySchemaUIConfig] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config'), 'exclude': lambda f: f is None }}) version: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('version'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entityschemaitem.py b/entity/src/epilot/models/shared/entityschemaitem.py index ac8ec297a..82f3c5df1 100755 --- a/entity/src/epilot/models/shared/entityschemaitem.py +++ b/entity/src/epilot/models/shared/entityschemaitem.py @@ -10,17 +10,19 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaItemGroupSettingsInfoTooltipTitle: - default: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default'), 'exclude': lambda f: f is None }}) key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaItemGroupSettings: - id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) @@ -35,33 +37,41 @@ class EntitySchemaItemGroupSettings: r"""This group should only be active when the setting is enabled""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaItemSource: - id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaItemUIConfigListItem: - summary_attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaItemUIConfigSharing: - show_sharing_button: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_sharing_button'), 'exclude': lambda f: f is None }}) r"""Show the sharing button in entity detail view""" + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaItemUIConfig: - create_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) edit_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_view'), 'exclude': lambda f: f is None }}) list_item: Optional[EntitySchemaItemUIConfigListItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('list_item'), 'exclude': lambda f: f is None }}) @@ -70,11 +80,13 @@ class EntitySchemaItemUIConfig: table_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_view'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySchemaItem: r"""The \\"type\\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.""" - attributes: list[Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) r"""An ordered list of attributes the entity contains""" capabilities: list[shared_entitycapability.EntityCapability] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities') }}) @@ -112,4 +124,5 @@ class EntitySchemaItem: ui_config: Optional[EntitySchemaItemUIConfig] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config'), 'exclude': lambda f: f is None }}) updated_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'exclude': lambda f: f is None }}) version: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('version'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entitysearchparams.py b/entity/src/epilot/models/shared/entitysearchparams.py index ab19a9eab..0880c830d 100755 --- a/entity/src/epilot/models/shared/entitysearchparams.py +++ b/entity/src/epilot/models/shared/entitysearchparams.py @@ -4,16 +4,23 @@ import dataclasses from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import Optional + + + +@dataclasses.dataclass +class EntitySearchParamsAggs: + r"""Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.""" + pass @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySearchParams: - q: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('q') }}) r"""Lucene queries supported with ElasticSearch""" - aggs: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggs'), 'exclude': lambda f: f is None }}) + aggs: Optional[EntitySearchParamsAggs] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggs'), 'exclude': lambda f: f is None }}) r"""Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.""" fields_: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) r"""List of entity fields to include in search results""" @@ -25,4 +32,5 @@ class EntitySearchParams: size: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('size'), 'exclude': lambda f: f is None }}) r"""Max search size is 1000 with higher values defaulting to 1000""" sort: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sort'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entitysearchresults.py b/entity/src/epilot/models/shared/entitysearchresults.py index 32288e56a..2136d4995 100755 --- a/entity/src/epilot/models/shared/entitysearchresults.py +++ b/entity/src/epilot/models/shared/entitysearchresults.py @@ -7,12 +7,19 @@ from typing import Any, Optional + +@dataclasses.dataclass +class EntitySearchResultsAggregations: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntitySearchResults: r"""Success""" - - aggregations: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggregations'), 'exclude': lambda f: f is None }}) + aggregations: Optional[EntitySearchResultsAggregations] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggregations'), 'exclude': lambda f: f is None }}) hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) results: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/entityviewdisabled.py b/entity/src/epilot/models/shared/entityviewdisabled.py index 04eb1da73..062013954 100755 --- a/entity/src/epilot/models/shared/entityviewdisabled.py +++ b/entity/src/epilot/models/shared/entityviewdisabled.py @@ -12,8 +12,9 @@ class EntityViewDisabledViewType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class EntityViewDisabled: - view_type: Optional[EntityViewDisabledViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/fileattribute.py b/entity/src/epilot/models/shared/fileattribute.py index b1365f5ca..b3d596f2a 100755 --- a/entity/src/epilot/models/shared/fileattribute.py +++ b/entity/src/epilot/models/shared/fileattribute.py @@ -7,16 +7,25 @@ from epilot import utils from typing import Any, Optional + + +@dataclasses.dataclass +class FileAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + class FileAttributeDefaultAccessControl(str, Enum): PUBLIC_READ = 'public-read' PRIVATE = 'private' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class FileAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -35,23 +44,25 @@ class FileAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class FileAttributeType(str, Enum): IMAGE = 'image' FILE = 'file' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class FileAttribute: r"""File or Image Attachment""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) type: FileAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) allowed_extensions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allowed_extensions'), 'exclude': lambda f: f is None }}) r"""List of file extensions (without the dot suffix)""" - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[FileAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -100,4 +111,5 @@ class FileAttribute: show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/getrelationsresp.py b/entity/src/epilot/models/shared/getrelationsresp.py index c7c652e41..0e249b23f 100755 --- a/entity/src/epilot/models/shared/getrelationsresp.py +++ b/entity/src/epilot/models/shared/getrelationsresp.py @@ -8,12 +8,13 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class GetRelationsResp: - attribute: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attribute') }}) entity_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_id') }}) tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) reverse: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reverse'), 'exclude': lambda f: f is None }}) r"""Whether this is a reverse relation""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py index 4fe2e1548..0e2cac0b6 100755 --- a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py +++ b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py @@ -8,10 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class GetRelationsRespWithPagination: r"""Success""" - hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) relations: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/internalattribute.py b/entity/src/epilot/models/shared/internalattribute.py index 659a341e5..c7c20d2dd 100755 --- a/entity/src/epilot/models/shared/internalattribute.py +++ b/entity/src/epilot/models/shared/internalattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class InternalAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class InternalAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class InternalAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class InternalAttributeType(str, Enum): INTERNAL = 'internal' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class InternalAttribute: r"""No UI representation""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[InternalAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -85,4 +96,5 @@ class InternalAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[InternalAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/internaluserattribute.py b/entity/src/epilot/models/shared/internaluserattribute.py index ecaf0d8cb..0d71a40bb 100755 --- a/entity/src/epilot/models/shared/internaluserattribute.py +++ b/entity/src/epilot/models/shared/internaluserattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class InternalUserAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class InternalUserAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class InternalUserAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class InternalUserAttributeType(str, Enum): INTERNAL_USER = 'internal_user' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class InternalUserAttribute: r"""Epilot internal user info""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[InternalUserAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -85,4 +96,5 @@ class InternalUserAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[InternalUserAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/invitationemailattribute.py b/entity/src/epilot/models/shared/invitationemailattribute.py index a8ed138d0..7d6a94a51 100755 --- a/entity/src/epilot/models/shared/invitationemailattribute.py +++ b/entity/src/epilot/models/shared/invitationemailattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class InvitationEmailAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class InvitationEmailAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class InvitationEmailAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class InvitationEmailAttributeType(str, Enum): INVITATION_EMAIL = 'invitation_email' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class InvitationEmailAttribute: r"""Email address for send invitation""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[InvitationEmailAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -85,4 +96,5 @@ class InvitationEmailAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[InvitationEmailAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/linkattribute.py b/entity/src/epilot/models/shared/linkattribute.py index ca6fd5370..e907ca3e3 100755 --- a/entity/src/epilot/models/shared/linkattribute.py +++ b/entity/src/epilot/models/shared/linkattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class LinkAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class LinkAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class LinkAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class LinkAttributeType(str, Enum): LINK = 'link' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class LinkAttribute: r"""Link with title and href""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[LinkAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -85,4 +96,5 @@ class LinkAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[LinkAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/multiselectattribute.py b/entity/src/epilot/models/shared/multiselectattribute.py index 8c1f8c7eb..8e353fcb4 100755 --- a/entity/src/epilot/models/shared/multiselectattribute.py +++ b/entity/src/epilot/models/shared/multiselectattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class MultiSelectAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class MultiSelectAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -32,23 +41,27 @@ class MultiSelectAttributeInfoHelpers: """ + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class MultiSelectAttributeOptions2: - value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) + + class MultiSelectAttributeType(str, Enum): MULTISELECT = 'multiselect' CHECKBOX = 'checkbox' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class MultiSelectAttribute: r"""Multi Choice Selection""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) @@ -56,7 +69,7 @@ class MultiSelectAttribute: r"""Allow arbitrary input values in addition to provided options""" allow_extra_options: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_extra_options'), 'exclude': lambda f: f is None }}) r"""controls if the 360 ui will allow the user to enter a value which is not defined by the options""" - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[MultiSelectAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -101,4 +114,5 @@ class MultiSelectAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[MultiSelectAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/numberattribute.py b/entity/src/epilot/models/shared/numberattribute.py index a5f2eaa6e..c9d80b139 100755 --- a/entity/src/epilot/models/shared/numberattribute.py +++ b/entity/src/epilot/models/shared/numberattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class NumberAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class NumberAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class NumberAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class NumberAttributeType(str, Enum): NUMBER = 'number' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class NumberAttribute: r"""Numeric input""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[NumberAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -86,4 +97,5 @@ class NumberAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[NumberAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/orderedlistattribute.py b/entity/src/epilot/models/shared/orderedlistattribute.py index 707cb95e0..cd5de91b2 100755 --- a/entity/src/epilot/models/shared/orderedlistattribute.py +++ b/entity/src/epilot/models/shared/orderedlistattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class OrderedListAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class OrderedListAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class OrderedListAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class OrderedListAttributeType(str, Enum): ORDERED_LIST = 'ordered_list' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class OrderedListAttribute: r"""Type of attribute to render N number of ordered fields""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[OrderedListAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -85,4 +96,5 @@ class OrderedListAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[OrderedListAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/partnerstatusattribute.py b/entity/src/epilot/models/shared/partnerstatusattribute.py index d9022837e..b4977a5c9 100755 --- a/entity/src/epilot/models/shared/partnerstatusattribute.py +++ b/entity/src/epilot/models/shared/partnerstatusattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class PartnerStatusAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class PartnerStatusAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class PartnerStatusAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class PartnerStatusAttributeType(str, Enum): PARTNER_STATUS = 'partner_status' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class PartnerStatusAttribute: r"""Partner Status""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[PartnerStatusAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -85,4 +96,5 @@ class PartnerStatusAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[PartnerStatusAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py index e73ae6045..9555af94a 100755 --- a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py +++ b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class PaymentMethodRelationAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class PaymentMethodRelationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class PaymentMethodRelationAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class PaymentMethodRelationAttributeType(str, Enum): RELATION_PAYMENT_METHOD = 'relation_payment_method' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class PaymentMethodRelationAttribute: r"""Reference to a payment method attribute of another entity""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[PaymentMethodRelationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -86,4 +97,5 @@ class PaymentMethodRelationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[PaymentMethodRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/purposeattribute.py b/entity/src/epilot/models/shared/purposeattribute.py index a63e509df..715870599 100755 --- a/entity/src/epilot/models/shared/purposeattribute.py +++ b/entity/src/epilot/models/shared/purposeattribute.py @@ -11,11 +11,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class PurposeAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class PurposeAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -34,19 +43,21 @@ class PurposeAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class PurposeAttributeType(str, Enum): PURPOSE = 'purpose' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class PurposeAttribute: r"""Entity Taxonomy""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[PurposeAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -92,4 +103,5 @@ class PurposeAttribute: type: Optional[PurposeAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/redirectentityview.py b/entity/src/epilot/models/shared/redirectentityview.py index 4c258f4b1..440d7c0cb 100755 --- a/entity/src/epilot/models/shared/redirectentityview.py +++ b/entity/src/epilot/models/shared/redirectentityview.py @@ -12,9 +12,10 @@ class RedirectEntityViewViewType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class RedirectEntityView: - route: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('route'), 'exclude': lambda f: f is None }}) view_type: Optional[RedirectEntityViewViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py index bf8966664..69eaea0d1 100755 --- a/entity/src/epilot/models/shared/relationattribute.py +++ b/entity/src/epilot/models/shared/relationattribute.py @@ -22,9 +22,9 @@ class RelationAttributeActionsActionType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class RelationAttributeActions: - action_type: Optional[RelationAttributeActionsActionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action_type'), 'exclude': lambda f: f is None }}) r"""The action type. Currently supported actions: @@ -44,6 +44,17 @@ class RelationAttributeActions: setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""Name of the setting flag that enables this action""" + + + + +@dataclasses.dataclass +class RelationAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + class RelationAttributeDrawerSize(str, Enum): SMALL = 'small' MEDIUM = 'medium' @@ -54,10 +65,10 @@ class RelationAttributeEditMode(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class RelationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -76,6 +87,8 @@ class RelationAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class RelationAttributeRelationAffinityMode(str, Enum): r"""Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity.""" WEAK = 'weak' @@ -90,10 +103,10 @@ class RelationAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class RelationAttribute: r"""Entity Relationship""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) @@ -101,7 +114,7 @@ class RelationAttribute: add_button_label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('add_button_label'), 'exclude': lambda f: f is None }}) r"""Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is.""" allowed_schemas: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allowedSchemas'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[RelationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -157,4 +170,5 @@ class RelationAttribute: summary_fields: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_fields'), 'exclude': lambda f: f is None }}) type: Optional[RelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/relationitem.py b/entity/src/epilot/models/shared/relationitem.py index 16ec9127a..0a022d9b0 100755 --- a/entity/src/epilot/models/shared/relationitem.py +++ b/entity/src/epilot/models/shared/relationitem.py @@ -8,13 +8,14 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class RelationItem: r"""Success""" - attribute: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attribute') }}) entity_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_id') }}) tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) reverse: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reverse'), 'exclude': lambda f: f is None }}) r"""Whether this is a reverse relation""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/repeatableattribute.py b/entity/src/epilot/models/shared/repeatableattribute.py index a38245297..47f2eafb5 100755 --- a/entity/src/epilot/models/shared/repeatableattribute.py +++ b/entity/src/epilot/models/shared/repeatableattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class RepeatableAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class RepeatableAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,6 +40,8 @@ class RepeatableAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class RepeatableAttributeRelationAffinityMode(str, Enum): r"""Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.""" WEAK = 'weak' @@ -48,14 +59,14 @@ class RepeatableAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class RepeatableAttribute: r"""Repeatable (add N number of fields)""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[RepeatableAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -103,4 +114,5 @@ class RepeatableAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[RepeatableAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/savedview.py b/entity/src/epilot/models/shared/savedview.py index 5a8161503..ee6b616e3 100755 --- a/entity/src/epilot/models/shared/savedview.py +++ b/entity/src/epilot/models/shared/savedview.py @@ -8,18 +8,20 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SavedViewCreatedBy1: r"""A user that created the view""" - user_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user_id'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SavedView: r"""A saved entity view""" - created_by: Any = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""User-friendly identifier for the saved view""" @@ -30,4 +32,5 @@ class SavedView: r"""Organisation ID a view belongs to""" shared: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shared'), 'exclude': lambda f: f is None }}) r"""boolean property for if a view is shared with organisation""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/savedviewitem.py b/entity/src/epilot/models/shared/savedviewitem.py index 4e73711ac..5a710cec6 100755 --- a/entity/src/epilot/models/shared/savedviewitem.py +++ b/entity/src/epilot/models/shared/savedviewitem.py @@ -8,18 +8,20 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SavedViewItemCreatedBy1: r"""A user that created the view""" - user_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user_id'), 'exclude': lambda f: f is None }}) + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SavedViewItem: r"""A saved entity view""" - created_by: Any = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""User-friendly identifier for the saved view""" @@ -34,4 +36,5 @@ class SavedViewItem: shared: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shared'), 'exclude': lambda f: f is None }}) r"""boolean property for if a view is shared with organisation""" updated_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/searchmappings.py b/entity/src/epilot/models/shared/searchmappings.py index 944cbf09f..6ce015cf4 100755 --- a/entity/src/epilot/models/shared/searchmappings.py +++ b/entity/src/epilot/models/shared/searchmappings.py @@ -20,10 +20,11 @@ class SearchMappingsType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SearchMappings: - fields_: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) index: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) type: Optional[SearchMappingsType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/security.py b/entity/src/epilot/models/shared/security.py index e4f1a8c31..864a0d4a5 100755 --- a/entity/src/epilot/models/shared/security.py +++ b/entity/src/epilot/models/shared/security.py @@ -5,9 +5,10 @@ from typing import Optional + @dataclasses.dataclass class Security: - epilot_auth: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'http', 'sub_type': 'bearer', 'field_name': 'Authorization' }}) epilot_org: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'apiKey', 'sub_type': 'header', 'field_name': 'x-epilot-org-id' }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/selectattribute.py b/entity/src/epilot/models/shared/selectattribute.py index 6dcefa48f..ad29d986b 100755 --- a/entity/src/epilot/models/shared/selectattribute.py +++ b/entity/src/epilot/models/shared/selectattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class SelectAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SelectAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -32,29 +41,33 @@ class SelectAttributeInfoHelpers: """ + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SelectAttributeOptions1: - value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) + + class SelectAttributeType(str, Enum): SELECT = 'select' RADIO = 'radio' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SelectAttribute: r"""Dropdown select""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) allow_any: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_any'), 'exclude': lambda f: f is None }}) r"""Allow arbitrary input values in addition to provided options""" - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[SelectAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -97,4 +110,5 @@ class SelectAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[SelectAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/sequenceattribute.py b/entity/src/epilot/models/shared/sequenceattribute.py index 1b09784da..93acbe29e 100755 --- a/entity/src/epilot/models/shared/sequenceattribute.py +++ b/entity/src/epilot/models/shared/sequenceattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class SequenceAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SequenceAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class SequenceAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class SequenceAttributeType(str, Enum): SEQUENCE = 'sequence' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SequenceAttribute: r"""Sequence of unique identifiers""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[SequenceAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -88,4 +99,5 @@ class SequenceAttribute: start_number: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_number'), 'exclude': lambda f: f is None }}) type: Optional[SequenceAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py index f7e3f5c8a..ed82f7494 100755 --- a/entity/src/epilot/models/shared/statusattribute.py +++ b/entity/src/epilot/models/shared/statusattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class StatusAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class StatusAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -32,26 +41,30 @@ class StatusAttributeInfoHelpers: """ + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class StatusAttributeOptions2: - value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) + + class StatusAttributeType(str, Enum): STATUS = 'status' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class StatusAttribute: r"""Status select""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[StatusAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -94,4 +107,5 @@ class StatusAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[StatusAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/summaryattribute.py b/entity/src/epilot/models/shared/summaryattribute.py index 01a302aee..a629a9ec6 100755 --- a/entity/src/epilot/models/shared/summaryattribute.py +++ b/entity/src/epilot/models/shared/summaryattribute.py @@ -8,6 +8,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SummaryAttribute: r"""Represents an expanded version of an attribute to be displayed in the list item summary. @@ -22,7 +23,6 @@ class SummaryAttribute: ``` The value field supports handlebar expressions from which you can pick any field from the entity state. """ - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) r"""Label to be shown on the top of the value.""" value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) @@ -40,4 +40,5 @@ class SummaryAttribute: r"""Displays the value within a tag chip.""" tag_color: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tag_color'), 'exclude': lambda f: f is None }}) r"""CSS hex color or CSS color name for the tag chip.""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/summaryfield.py b/entity/src/epilot/models/shared/summaryfield.py index 33622de7d..7e005154c 100755 --- a/entity/src/epilot/models/shared/summaryfield.py +++ b/entity/src/epilot/models/shared/summaryfield.py @@ -8,12 +8,13 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class SummaryField: r"""Summary Fields are displayed inside list view as a resume of the relation entity.""" - display_as: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('display_as'), 'exclude': lambda f: f is None }}) r"""An hint on how to display the summary field""" field: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('field'), 'exclude': lambda f: f is None }}) r"""The field from the entity attributes to display""" - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/tagsattribute.py b/entity/src/epilot/models/shared/tagsattribute.py index f1217fa71..ff74f81cf 100755 --- a/entity/src/epilot/models/shared/tagsattribute.py +++ b/entity/src/epilot/models/shared/tagsattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class TagsAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class TagsAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class TagsAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class TagsAttributeType(str, Enum): TAGS = 'tags' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class TagsAttribute: r"""Tags""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[TagsAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -87,4 +98,5 @@ class TagsAttribute: suggestions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggestions'), 'exclude': lambda f: f is None }}) type: Optional[TagsAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/taxonomy.py b/entity/src/epilot/models/shared/taxonomy.py index 67dbbb46b..586d1c42d 100755 --- a/entity/src/epilot/models/shared/taxonomy.py +++ b/entity/src/epilot/models/shared/taxonomy.py @@ -11,10 +11,10 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class Taxonomy: r"""Taxonomy""" - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag""" slug: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) @@ -23,4 +23,5 @@ class Taxonomy: plural: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plural'), 'exclude': lambda f: f is None }}) r"""Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags""" updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/taxonomyclassification.py b/entity/src/epilot/models/shared/taxonomyclassification.py index 6d03e02d0..07a70195b 100755 --- a/entity/src/epilot/models/shared/taxonomyclassification.py +++ b/entity/src/epilot/models/shared/taxonomyclassification.py @@ -11,12 +11,13 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class TaxonomyClassification: - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) parents: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/textattribute.py b/entity/src/epilot/models/shared/textattribute.py index fd98e4209..d4c7f64cb 100755 --- a/entity/src/epilot/models/shared/textattribute.py +++ b/entity/src/epilot/models/shared/textattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class TextAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class TextAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class TextAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class TextAttributeType(str, Enum): STRING = 'string' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class TextAttribute: r"""Textarea or text input""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[TextAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -86,4 +97,5 @@ class TextAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[TextAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/models/shared/userrelationattribute.py b/entity/src/epilot/models/shared/userrelationattribute.py index b02c7edfb..11b757839 100755 --- a/entity/src/epilot/models/shared/userrelationattribute.py +++ b/entity/src/epilot/models/shared/userrelationattribute.py @@ -8,11 +8,20 @@ from typing import Any, Optional + +@dataclasses.dataclass +class UserRelationAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class UserRelationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" - hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) r"""The name of the custom component to be used as the hint helper. The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. @@ -31,19 +40,21 @@ class UserRelationAttributeInfoHelpers: The value should be a valid `@mui/core` tooltip placement. """ + + class UserRelationAttributeType(str, Enum): RELATION_USER = 'relation_user' @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass class UserRelationAttribute: r"""User Relationship""" - label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - constraints: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + constraints: Optional[UserRelationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ @@ -86,4 +97,5 @@ class UserRelationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[UserRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + + diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index d8f0a290d..12d3f9f2d 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.3.0' - gen_version: str = '2.37.2' + sdk_version: str = '1.4.0' + gen_version: str = '2.39.0' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 1077abfd19ed0ba770ee34ca486d5073f6756f1d Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sun, 11 Jun 2023 01:58:19 +0000 Subject: [PATCH 03/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.1 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- .../src/epilot/models/shared/addressrelationattribute.py | 3 ++- entity/src/epilot/models/shared/automationattribute.py | 3 ++- entity/src/epilot/models/shared/booleanattribute.py | 3 ++- entity/src/epilot/models/shared/computedattribute.py | 3 ++- entity/src/epilot/models/shared/consentattribute.py | 3 ++- entity/src/epilot/models/shared/countryattribute.py | 3 ++- entity/src/epilot/models/shared/currencyattribute.py | 3 ++- entity/src/epilot/models/shared/dateattribute.py | 3 ++- entity/src/epilot/models/shared/entitysearchparams.py | 3 ++- entity/src/epilot/models/shared/fileattribute.py | 3 ++- entity/src/epilot/models/shared/internalattribute.py | 3 ++- entity/src/epilot/models/shared/internaluserattribute.py | 3 ++- .../src/epilot/models/shared/invitationemailattribute.py | 3 ++- entity/src/epilot/models/shared/linkattribute.py | 3 ++- entity/src/epilot/models/shared/multiselectattribute.py | 3 ++- entity/src/epilot/models/shared/numberattribute.py | 3 ++- entity/src/epilot/models/shared/orderedlistattribute.py | 3 ++- entity/src/epilot/models/shared/partnerstatusattribute.py | 3 ++- .../models/shared/paymentmethodrelationattribute.py | 3 ++- entity/src/epilot/models/shared/purposeattribute.py | 3 ++- entity/src/epilot/models/shared/relationattribute.py | 3 ++- entity/src/epilot/models/shared/repeatableattribute.py | 3 ++- entity/src/epilot/models/shared/selectattribute.py | 3 ++- entity/src/epilot/models/shared/sequenceattribute.py | 3 ++- entity/src/epilot/models/shared/statusattribute.py | 3 ++- entity/src/epilot/models/shared/tagsattribute.py | 3 ++- entity/src/epilot/models/shared/textattribute.py | 3 ++- entity/src/epilot/models/shared/userrelationattribute.py | 3 ++- entity/src/epilot/sdkconfiguration.py | 4 ++-- 32 files changed, 69 insertions(+), 35 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 48129aa6b..cfe031009 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -46,4 +46,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.47.0 (2.39.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.47.0 (2.39.0) https://github.com/speakeasy-api/speakeasy + +## 2023-06-11 01:57:50 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.47.1 (2.39.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 613382fce..d1337e646 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.47.0 - generationVersion: 2.39.0 + speakeasyVersion: 1.47.1 + generationVersion: 2.39.2 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.4.0 + version: 1.4.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 8c245ef45..6cd1e7808 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.4.0", + version="1.4.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/shared/addressrelationattribute.py b/entity/src/epilot/models/shared/addressrelationattribute.py index 9e0eb5847..4dde2203a 100755 --- a/entity/src/epilot/models/shared/addressrelationattribute.py +++ b/entity/src/epilot/models/shared/addressrelationattribute.py @@ -14,7 +14,8 @@ class AddressRelationAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/automationattribute.py b/entity/src/epilot/models/shared/automationattribute.py index 2fd13ce0f..78adb6483 100755 --- a/entity/src/epilot/models/shared/automationattribute.py +++ b/entity/src/epilot/models/shared/automationattribute.py @@ -14,7 +14,8 @@ class AutomationAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/booleanattribute.py b/entity/src/epilot/models/shared/booleanattribute.py index 25f292a35..5505ac152 100755 --- a/entity/src/epilot/models/shared/booleanattribute.py +++ b/entity/src/epilot/models/shared/booleanattribute.py @@ -14,7 +14,8 @@ class BooleanAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/computedattribute.py b/entity/src/epilot/models/shared/computedattribute.py index 9a9c8fa84..8f14a76d8 100755 --- a/entity/src/epilot/models/shared/computedattribute.py +++ b/entity/src/epilot/models/shared/computedattribute.py @@ -14,7 +14,8 @@ class ComputedAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/consentattribute.py b/entity/src/epilot/models/shared/consentattribute.py index 3e41efebb..2d328b22b 100755 --- a/entity/src/epilot/models/shared/consentattribute.py +++ b/entity/src/epilot/models/shared/consentattribute.py @@ -14,7 +14,8 @@ class ConsentAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/countryattribute.py b/entity/src/epilot/models/shared/countryattribute.py index c6c465751..dd1c7755e 100755 --- a/entity/src/epilot/models/shared/countryattribute.py +++ b/entity/src/epilot/models/shared/countryattribute.py @@ -14,7 +14,8 @@ class CountryAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/currencyattribute.py b/entity/src/epilot/models/shared/currencyattribute.py index f82c455c8..2611f6c39 100755 --- a/entity/src/epilot/models/shared/currencyattribute.py +++ b/entity/src/epilot/models/shared/currencyattribute.py @@ -14,7 +14,8 @@ class CurrencyAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/dateattribute.py b/entity/src/epilot/models/shared/dateattribute.py index 8c575a99f..58795b7dc 100755 --- a/entity/src/epilot/models/shared/dateattribute.py +++ b/entity/src/epilot/models/shared/dateattribute.py @@ -14,7 +14,8 @@ class DateAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/entitysearchparams.py b/entity/src/epilot/models/shared/entitysearchparams.py index 0880c830d..71fbbc82b 100755 --- a/entity/src/epilot/models/shared/entitysearchparams.py +++ b/entity/src/epilot/models/shared/entitysearchparams.py @@ -11,7 +11,8 @@ @dataclasses.dataclass class EntitySearchParamsAggs: r"""Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.""" - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/fileattribute.py b/entity/src/epilot/models/shared/fileattribute.py index b3d596f2a..e45c675f2 100755 --- a/entity/src/epilot/models/shared/fileattribute.py +++ b/entity/src/epilot/models/shared/fileattribute.py @@ -14,7 +14,8 @@ class FileAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + class FileAttributeDefaultAccessControl(str, Enum): PUBLIC_READ = 'public-read' diff --git a/entity/src/epilot/models/shared/internalattribute.py b/entity/src/epilot/models/shared/internalattribute.py index c7c20d2dd..235f53d31 100755 --- a/entity/src/epilot/models/shared/internalattribute.py +++ b/entity/src/epilot/models/shared/internalattribute.py @@ -14,7 +14,8 @@ class InternalAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/internaluserattribute.py b/entity/src/epilot/models/shared/internaluserattribute.py index 0d71a40bb..d2816d830 100755 --- a/entity/src/epilot/models/shared/internaluserattribute.py +++ b/entity/src/epilot/models/shared/internaluserattribute.py @@ -14,7 +14,8 @@ class InternalUserAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/invitationemailattribute.py b/entity/src/epilot/models/shared/invitationemailattribute.py index 7d6a94a51..43beb5681 100755 --- a/entity/src/epilot/models/shared/invitationemailattribute.py +++ b/entity/src/epilot/models/shared/invitationemailattribute.py @@ -14,7 +14,8 @@ class InvitationEmailAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/linkattribute.py b/entity/src/epilot/models/shared/linkattribute.py index e907ca3e3..adc963ee7 100755 --- a/entity/src/epilot/models/shared/linkattribute.py +++ b/entity/src/epilot/models/shared/linkattribute.py @@ -14,7 +14,8 @@ class LinkAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/multiselectattribute.py b/entity/src/epilot/models/shared/multiselectattribute.py index 8e353fcb4..59e23bdcc 100755 --- a/entity/src/epilot/models/shared/multiselectattribute.py +++ b/entity/src/epilot/models/shared/multiselectattribute.py @@ -14,7 +14,8 @@ class MultiSelectAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/numberattribute.py b/entity/src/epilot/models/shared/numberattribute.py index c9d80b139..cbfef2dee 100755 --- a/entity/src/epilot/models/shared/numberattribute.py +++ b/entity/src/epilot/models/shared/numberattribute.py @@ -14,7 +14,8 @@ class NumberAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/orderedlistattribute.py b/entity/src/epilot/models/shared/orderedlistattribute.py index cd5de91b2..76a7e56f4 100755 --- a/entity/src/epilot/models/shared/orderedlistattribute.py +++ b/entity/src/epilot/models/shared/orderedlistattribute.py @@ -14,7 +14,8 @@ class OrderedListAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/partnerstatusattribute.py b/entity/src/epilot/models/shared/partnerstatusattribute.py index b4977a5c9..47ffdad80 100755 --- a/entity/src/epilot/models/shared/partnerstatusattribute.py +++ b/entity/src/epilot/models/shared/partnerstatusattribute.py @@ -14,7 +14,8 @@ class PartnerStatusAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py index 9555af94a..f8babf618 100755 --- a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py +++ b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py @@ -14,7 +14,8 @@ class PaymentMethodRelationAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/purposeattribute.py b/entity/src/epilot/models/shared/purposeattribute.py index 715870599..ea4ceadd3 100755 --- a/entity/src/epilot/models/shared/purposeattribute.py +++ b/entity/src/epilot/models/shared/purposeattribute.py @@ -17,7 +17,8 @@ class PurposeAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py index 69eaea0d1..a9a360144 100755 --- a/entity/src/epilot/models/shared/relationattribute.py +++ b/entity/src/epilot/models/shared/relationattribute.py @@ -53,7 +53,8 @@ class RelationAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + class RelationAttributeDrawerSize(str, Enum): SMALL = 'small' diff --git a/entity/src/epilot/models/shared/repeatableattribute.py b/entity/src/epilot/models/shared/repeatableattribute.py index 47f2eafb5..ca672b5f0 100755 --- a/entity/src/epilot/models/shared/repeatableattribute.py +++ b/entity/src/epilot/models/shared/repeatableattribute.py @@ -14,7 +14,8 @@ class RepeatableAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/selectattribute.py b/entity/src/epilot/models/shared/selectattribute.py index ad29d986b..10481db31 100755 --- a/entity/src/epilot/models/shared/selectattribute.py +++ b/entity/src/epilot/models/shared/selectattribute.py @@ -14,7 +14,8 @@ class SelectAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/sequenceattribute.py b/entity/src/epilot/models/shared/sequenceattribute.py index 93acbe29e..30006b7ad 100755 --- a/entity/src/epilot/models/shared/sequenceattribute.py +++ b/entity/src/epilot/models/shared/sequenceattribute.py @@ -14,7 +14,8 @@ class SequenceAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py index ed82f7494..18e2d3497 100755 --- a/entity/src/epilot/models/shared/statusattribute.py +++ b/entity/src/epilot/models/shared/statusattribute.py @@ -14,7 +14,8 @@ class StatusAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/tagsattribute.py b/entity/src/epilot/models/shared/tagsattribute.py index ff74f81cf..7180aaa78 100755 --- a/entity/src/epilot/models/shared/tagsattribute.py +++ b/entity/src/epilot/models/shared/tagsattribute.py @@ -14,7 +14,8 @@ class TagsAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/textattribute.py b/entity/src/epilot/models/shared/textattribute.py index d4c7f64cb..b39f082c6 100755 --- a/entity/src/epilot/models/shared/textattribute.py +++ b/entity/src/epilot/models/shared/textattribute.py @@ -14,7 +14,8 @@ class TextAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/models/shared/userrelationattribute.py b/entity/src/epilot/models/shared/userrelationattribute.py index 11b757839..bd17da0e7 100755 --- a/entity/src/epilot/models/shared/userrelationattribute.py +++ b/entity/src/epilot/models/shared/userrelationattribute.py @@ -14,7 +14,8 @@ class UserRelationAttributeConstraints: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - pass + + @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 12d3f9f2d..eff30ea27 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.4.0' - gen_version: str = '2.39.0' + sdk_version: str = '1.4.1' + gen_version: str = '2.39.2' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From b3e3a9d92c7d1cddc1a4cab5cc8888843f7c3b87 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 14 Jun 2023 01:42:51 +0000 Subject: [PATCH 04/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.3 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- entity/src/epilot/utils/retries.py | 3 ++- 5 files changed, 15 insertions(+), 8 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index cfe031009..9761d4903 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -52,4 +52,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.47.1 (2.39.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.47.1 (2.39.2) https://github.com/speakeasy-api/speakeasy + +## 2023-06-14 01:42:19 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.47.3 (2.40.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index d1337e646..8c66e77d2 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.47.1 - generationVersion: 2.39.2 + speakeasyVersion: 1.47.3 + generationVersion: 2.40.1 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.4.1 + version: 1.5.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 6cd1e7808..c276ea60a 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.4.1", + version="1.5.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index eff30ea27..a1302b9e7 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.4.1' - gen_version: str = '2.39.2' + sdk_version: str = '1.5.0' + gen_version: str = '2.40.1' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: diff --git a/entity/src/epilot/utils/retries.py b/entity/src/epilot/utils/retries.py index c6251d948..2138c1b5e 100755 --- a/entity/src/epilot/utils/retries.py +++ b/entity/src/epilot/utils/retries.py @@ -24,8 +24,9 @@ class RetryConfig: backoff: BackoffStrategy retry_connection_errors: bool - def __init__(self, strategy: str, retry_connection_errors: bool): + def __init__(self, strategy: str, backoff: BackoffStrategy, retry_connection_errors: bool): self.strategy = strategy + self.backoff = backoff self.retry_connection_errors = retry_connection_errors From 37dd7da671a70bcf4cb9c64b0af897053975955b Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 16 Jun 2023 01:43:13 +0000 Subject: [PATCH 05/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.48.0 --- entity/.gitignore | 2 +- entity/RELEASES.md | 8 +++++++- entity/files.gen | 1 - entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 6 files changed, 14 insertions(+), 9 deletions(-) diff --git a/entity/.gitignore b/entity/.gitignore index 9072ad43b..648876d29 100755 --- a/entity/.gitignore +++ b/entity/.gitignore @@ -2,4 +2,4 @@ venv/ src/*.egg-info/ __pycache__/ .pytest_cache/ -.python-version` \ No newline at end of file +.python-version` diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 9761d4903..ce5d51cef 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -58,4 +58,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.47.3 (2.40.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.47.3 (2.40.1) https://github.com/speakeasy-api/speakeasy + +## 2023-06-16 01:42:44 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.48.0 (2.41.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/files.gen b/entity/files.gen index 1b0db7a67..a7faec61d 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -8,7 +8,6 @@ src/epilot/saved_views.py src/epilot/schemas.py src/epilot/taxonomy.py src/epilot/sdk.py -.gitignore pylintrc setup.py src/epilot/__init__.py diff --git a/entity/gen.yaml b/entity/gen.yaml index 8c66e77d2..86a6a9a5e 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.47.3 - generationVersion: 2.40.1 + speakeasyVersion: 1.48.0 + generationVersion: 2.41.1 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.5.0 + version: 1.6.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index c276ea60a..5511c4fc6 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.5.0", + version="1.6.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index a1302b9e7..39c1bb475 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.5.0' - gen_version: str = '2.40.1' + sdk_version: str = '1.6.0' + gen_version: str = '2.41.1' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 2cce71cbc7ee8a053c7690d88b1f752745833812 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 20 Jun 2023 01:38:08 +0000 Subject: [PATCH 06/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.0 --- entity/.gitignore | 2 ++ entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 5 files changed, 15 insertions(+), 7 deletions(-) diff --git a/entity/.gitignore b/entity/.gitignore index 648876d29..8ac3f51d4 100755 --- a/entity/.gitignore +++ b/entity/.gitignore @@ -1,3 +1,5 @@ +.python-version +.DS_Store venv/ src/*.egg-info/ __pycache__/ diff --git a/entity/RELEASES.md b/entity/RELEASES.md index ce5d51cef..9233a88bb 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -64,4 +64,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.48.0 (2.41.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.48.0 (2.41.1) https://github.com/speakeasy-api/speakeasy + +## 2023-06-20 01:37:43 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.49.0 (2.41.4) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 86a6a9a5e..5d13dd1c3 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.48.0 - generationVersion: 2.41.1 + speakeasyVersion: 1.49.0 + generationVersion: 2.41.4 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.6.0 + version: 1.6.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 5511c4fc6..550b6887f 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.6.0", + version="1.6.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 39c1bb475..8ac505ebe 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.6.0' - gen_version: str = '2.41.1' + sdk_version: str = '1.6.1' + gen_version: str = '2.41.4' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From b21797b6f1760ab1546d3909ee01449f8f73637c Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 21 Jun 2023 01:39:45 +0000 Subject: [PATCH 07/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.1 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 9233a88bb..bdae19567 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -70,4 +70,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.49.0 (2.41.4) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.49.0 (2.41.4) https://github.com/speakeasy-api/speakeasy + +## 2023-06-21 01:39:20 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.49.1 (2.41.5) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 5d13dd1c3..52bcf5418 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.49.0 - generationVersion: 2.41.4 + speakeasyVersion: 1.49.1 + generationVersion: 2.41.5 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.6.1 + version: 1.6.2 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 550b6887f..de053359f 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.6.1", + version="1.6.2", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 8ac505ebe..85ee7a8a5 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.6.1' - gen_version: str = '2.41.4' + sdk_version: str = '1.6.2' + gen_version: str = '2.41.5' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 3fe1005de428c681ababf7e1de7038c49d3adb54 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 23 Jun 2023 01:53:59 +0000 Subject: [PATCH 08/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.50.1 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index bdae19567..fee4ce912 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -76,4 +76,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.49.1 (2.41.5) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.49.1 (2.41.5) https://github.com/speakeasy-api/speakeasy + +## 2023-06-23 01:53:34 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.50.1 (2.43.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 52bcf5418..986f10e3a 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.49.1 - generationVersion: 2.41.5 + speakeasyVersion: 1.50.1 + generationVersion: 2.43.2 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.6.2 + version: 1.7.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index de053359f..c6b5a3f9b 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.6.2", + version="1.7.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 85ee7a8a5..9ad78aa63 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.6.2' - gen_version: str = '2.41.5' + sdk_version: str = '1.7.0' + gen_version: str = '2.43.2' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From c6951fda27b5598f9539377580e6f66877b5735c Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 27 Jun 2023 01:56:22 +0000 Subject: [PATCH 09/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.1 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index fee4ce912..52eb3b26a 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -82,4 +82,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.50.1 (2.43.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.50.1 (2.43.2) https://github.com/speakeasy-api/speakeasy + +## 2023-06-27 01:55:53 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.51.1 (2.50.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 986f10e3a..6c97f8da7 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.50.1 - generationVersion: 2.43.2 + speakeasyVersion: 1.51.1 + generationVersion: 2.50.2 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.7.0 + version: 1.8.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index c6b5a3f9b..15ba3480f 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.7.0", + version="1.8.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 9ad78aa63..ed100760e 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.7.0' - gen_version: str = '2.43.2' + sdk_version: str = '1.8.0' + gen_version: str = '2.50.2' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 2cdf9697b9131b77c48daa17231cb6d645845660 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Thu, 29 Jun 2023 01:51:04 +0000 Subject: [PATCH 10/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.3 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 52eb3b26a..86245af0c 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -88,4 +88,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.51.1 (2.50.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.51.1 (2.50.2) https://github.com/speakeasy-api/speakeasy + +## 2023-06-29 01:50:35 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.51.3 (2.52.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 6c97f8da7..9de38c59a 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.51.1 - generationVersion: 2.50.2 + speakeasyVersion: 1.51.3 + generationVersion: 2.52.2 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.8.0 + version: 1.9.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 15ba3480f..f85ce9227 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.8.0", + version="1.9.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index ed100760e..79de2526c 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.8.0' - gen_version: str = '2.50.2' + sdk_version: str = '1.9.0' + gen_version: str = '2.52.2' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 2444c31cd68b20bfee946ff39019bc12ad13780a Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 1 Jul 2023 02:00:49 +0000 Subject: [PATCH 11/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.0 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 86245af0c..0cc7adb1f 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -94,4 +94,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.51.3 (2.52.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.51.3 (2.52.2) https://github.com/speakeasy-api/speakeasy + +## 2023-07-01 02:00:20 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.52.0 (2.55.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 9de38c59a..2c6504c1d 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.51.3 - generationVersion: 2.52.2 + speakeasyVersion: 1.52.0 + generationVersion: 2.55.0 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.9.0 + version: 1.10.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index f85ce9227..4d2c1c4d6 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.9.0", + version="1.10.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 79de2526c..5063a5bc5 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.9.0' - gen_version: str = '2.52.2' + sdk_version: str = '1.10.0' + gen_version: str = '2.55.0' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 5e1d82d08fce71f0f34b33642928793acfa1cc80 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Thu, 6 Jul 2023 01:56:46 +0000 Subject: [PATCH 12/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.2 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 0cc7adb1f..968b74772 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -100,4 +100,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.52.0 (2.55.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.52.0 (2.55.0) https://github.com/speakeasy-api/speakeasy + +## 2023-07-06 01:56:21 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.52.2 (2.57.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 2c6504c1d..804e49b73 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.52.0 - generationVersion: 2.55.0 + speakeasyVersion: 1.52.2 + generationVersion: 2.57.2 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.10.0 + version: 1.11.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 4d2c1c4d6..2fb1b296c 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.10.0", + version="1.11.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 5063a5bc5..0adf8b448 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.10.0' - gen_version: str = '2.55.0' + sdk_version: str = '1.11.0' + gen_version: str = '2.57.2' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 2df4ff60f6c52e2d0d89c80c555cd8f194504271 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 7 Jul 2023 01:54:18 +0000 Subject: [PATCH 13/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.0 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 968b74772..38f26b282 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -106,4 +106,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.52.2 (2.57.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.52.2 (2.57.2) https://github.com/speakeasy-api/speakeasy + +## 2023-07-07 01:53:55 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.53.0 (2.58.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 804e49b73..1680ef8ac 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.52.2 - generationVersion: 2.57.2 + speakeasyVersion: 1.53.0 + generationVersion: 2.58.0 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.11.0 + version: 1.12.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 2fb1b296c..bb479a8e3 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.11.0", + version="1.12.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 0adf8b448..254902816 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.11.0' - gen_version: str = '2.57.2' + sdk_version: str = '1.12.0' + gen_version: str = '2.58.0' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 6de713fc269e75240c98d817aef0cbba02956b06 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 8 Jul 2023 01:53:24 +0000 Subject: [PATCH 14/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.1 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 38f26b282..4d7105bd3 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -112,4 +112,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.53.0 (2.58.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.53.0 (2.58.0) https://github.com/speakeasy-api/speakeasy + +## 2023-07-08 01:53:00 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.53.1 (2.58.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 1680ef8ac..3868a34ec 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.53.0 - generationVersion: 2.58.0 + speakeasyVersion: 1.53.1 + generationVersion: 2.58.2 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.12.0 + version: 1.12.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index bb479a8e3..28cebe6e3 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.12.0", + version="1.12.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 254902816..85860fc20 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.12.0' - gen_version: str = '2.58.0' + sdk_version: str = '1.12.1' + gen_version: str = '2.58.2' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From a89651c9d9b39d68145c4c5b7a8a6541b13797ce Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 11 Jul 2023 01:46:41 +0000 Subject: [PATCH 15/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.0 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 4d7105bd3..124b44e5d 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -118,4 +118,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.53.1 (2.58.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.53.1 (2.58.2) https://github.com/speakeasy-api/speakeasy + +## 2023-07-11 01:46:12 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.56.0 (2.61.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 3868a34ec..23ccd6e0a 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.53.1 - generationVersion: 2.58.2 + speakeasyVersion: 1.56.0 + generationVersion: 2.61.0 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.12.1 + version: 1.13.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 28cebe6e3..83150579c 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.12.1", + version="1.13.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 85860fc20..861e54329 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.12.1' - gen_version: str = '2.58.2' + sdk_version: str = '1.13.0' + gen_version: str = '2.61.0' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 7dee9e3010779d37cb962b4af1277a3f8a3b2578 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 12 Jul 2023 01:55:03 +0000 Subject: [PATCH 16/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.4 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 124b44e5d..741279276 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -124,4 +124,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.56.0 (2.61.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.56.0 (2.61.0) https://github.com/speakeasy-api/speakeasy + +## 2023-07-12 01:54:35 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.56.4 (2.61.5) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 23ccd6e0a..3d0d288ff 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.56.0 - generationVersion: 2.61.0 + speakeasyVersion: 1.56.4 + generationVersion: 2.61.5 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.13.0 + version: 1.13.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 83150579c..4fac6e557 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.13.0", + version="1.13.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 861e54329..76a09750f 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.13.0' - gen_version: str = '2.61.0' + sdk_version: str = '1.13.1' + gen_version: str = '2.61.5' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From af9c7450d85dbc83c9cf848725c73a976c28192d Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Thu, 13 Jul 2023 01:57:22 +0000 Subject: [PATCH 17/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.57.0 --- entity/RELEASES.md | 8 ++- entity/gen.yaml | 6 +- entity/setup.py | 2 +- entity/src/epilot/activity.py | 2 +- entity/src/epilot/entities.py | 72 +++++++++---------- .../epilot/models/shared/relationattribute.py | 4 +- entity/src/epilot/relations.py | 8 +-- entity/src/epilot/sdk.py | 4 +- entity/src/epilot/sdkconfiguration.py | 4 +- 9 files changed, 58 insertions(+), 52 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 741279276..01c8171da 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -130,4 +130,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.56.4 (2.61.5) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.56.4 (2.61.5) https://github.com/speakeasy-api/speakeasy + +## 2023-07-13 01:56:55 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.57.0 (2.62.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 3d0d288ff..1ef7ad953 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.56.4 - generationVersion: 2.61.5 + speakeasyVersion: 1.57.0 + generationVersion: 2.62.1 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.13.1 + version: 1.14.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 4fac6e557..b3f3f20ec 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.13.1", + version="1.14.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/activity.py b/entity/src/epilot/activity.py index d98a66118..1870416ea 100755 --- a/entity/src/epilot/activity.py +++ b/entity/src/epilot/activity.py @@ -43,7 +43,7 @@ def attach_activity(self, request: operations.AttachActivityRequest) -> operatio def create_activity(self, request: operations.CreateActivityRequest) -> operations.CreateActivityResponse: r"""createActivity Create an activity that can be displayed in activity feeds. - + - All activites are published as events on the event bus - Entity mutations are always part of an activity """ diff --git a/entity/src/epilot/entities.py b/entity/src/epilot/entities.py index 0eaf14f3e..9f396e58b 100755 --- a/entity/src/epilot/entities.py +++ b/entity/src/epilot/entities.py @@ -43,17 +43,17 @@ def autocomplete(self, request: operations.AutocompleteRequest) -> operations.Au def create_entity(self, request: operations.CreateEntityRequest) -> operations.CreateEntityResponse: r"""createEntity Creates a new entity using a key. - + ## Activity - + If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityCreated` - + ## Relations - + To create a relation, store a property object that defines a `$relation` array. - + Example: - + ```json { \"contacts\": { @@ -63,7 +63,7 @@ def create_entity(self, request: operations.CreateEntityRequest) -> operations.C } } ``` - + The items in `$relation` support two properties: - `entity_id` - The ID of the entity to link - `_tags` - Tags or labels for the relation (optional) @@ -97,9 +97,9 @@ def create_entity(self, request: operations.CreateEntityRequest) -> operations.C def delete_entity(self, request: operations.DeleteEntityRequest) -> operations.DeleteEntityResponse: r"""deleteEntity Deletes an Entity - + ## Activity - + If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityDeleted` """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -124,11 +124,11 @@ def delete_entity(self, request: operations.DeleteEntityRequest) -> operations.D def get_entity(self, request: operations.GetEntityRequest) -> operations.GetEntityResponse: r"""getEntity Gets Entity and relations by id. - + ## Relations - + When `hydrate=true`, relation attributes are replaced in-place with nested entity values. - + Example: ```json { @@ -149,7 +149,7 @@ def get_entity(self, request: operations.GetEntityRequest) -> operations.GetEnti } } ``` - + Becomes: ```json { @@ -213,19 +213,19 @@ def get_entity(self, request: operations.GetEntityRequest) -> operations.GetEnti def patch_entity(self, request: operations.PatchEntityRequest) -> operations.PatchEntityResponse: r"""patchEntity Partially updates an entity with the passed in entity data. - + - If an _updated_at is passed and the server contains a newer version of the entity a `409` Error is returned - + ## Activity - + If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityUpdated` - + ## Relations - + To create a relation, store a property that defines a `$relation` array. - + Example: - + ```json { \"contacts\": { @@ -235,7 +235,7 @@ def patch_entity(self, request: operations.PatchEntityRequest) -> operations.Pat } } ``` - + The items in `$relation` support two properties: - `entity_id` - The ID of the entity to link - `_tags` - Tags or labels for the relation (optional) @@ -273,13 +273,13 @@ def patch_entity(self, request: operations.PatchEntityRequest) -> operations.Pat def search_entities(self, request: shared.EntitySearchParams) -> operations.SearchEntitiesResponse: r"""searchEntities Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying. - + Passing comma-separated `x-epilot-org-id` is supported for cross-org entity search. - + ## Relations - + When `hydrate=true`, relation attributes are replaced in-place with nested entity values. - + Example: ```json { @@ -300,7 +300,7 @@ def search_entities(self, request: shared.EntitySearchParams) -> operations.Sear } } ``` - + Becomes: ```json { @@ -368,17 +368,17 @@ def search_entities(self, request: shared.EntitySearchParams) -> operations.Sear def update_entity(self, request: operations.UpdateEntityRequest) -> operations.UpdateEntityResponse: r"""updateEntity Updates an Entity - + ## Activity - + If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityUpdated` - + ## Relations - + To create a relation, store a property that defines a `$relation` array. - + Example: - + ```json { \"contacts\": { @@ -388,7 +388,7 @@ def update_entity(self, request: operations.UpdateEntityRequest) -> operations.U } } ``` - + The items in `$relation` support two properties: - `entity_id` - The ID of the entity to link - `_tags` - Tags or labels for the relation (optional) @@ -422,13 +422,13 @@ def update_entity(self, request: operations.UpdateEntityRequest) -> operations.U def upsert_entity(self, request: operations.UpsertEntityRequest) -> operations.UpsertEntityResponse: r"""upsertEntity Create or update an entity using `unique_key` - + - If no entities are matched, a new entity is created. - If exactly one entity is matched, a `PATCH`-style update is applied to the existing entity. - If more than one entity is matched a `409` Error is returned - + ## Activity - + If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityCreated` or `EntityUpdated` """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py index a9a360144..c2bc03575 100755 --- a/entity/src/epilot/models/shared/relationattribute.py +++ b/entity/src/epilot/models/shared/relationattribute.py @@ -9,7 +9,7 @@ class RelationAttributeActionsActionType(str, Enum): r"""The action type. Currently supported actions: - + | action | description | |--------|-------------| | add_existing | Enables the user to pick an existing entity to link as relation | @@ -27,7 +27,7 @@ class RelationAttributeActionsActionType(str, Enum): class RelationAttributeActions: action_type: Optional[RelationAttributeActionsActionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action_type'), 'exclude': lambda f: f is None }}) r"""The action type. Currently supported actions: - + | action | description | |--------|-------------| | add_existing | Enables the user to pick an existing entity to link as relation | diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py index 51487f014..9cb276753 100755 --- a/entity/src/epilot/relations.py +++ b/entity/src/epilot/relations.py @@ -69,9 +69,9 @@ def delete_relation(self, request: operations.DeleteRelationRequest) -> operatio def get_relations(self, request: operations.GetRelationsRequest) -> operations.GetRelationsResponse: r"""getRelations Returns 1st level direct relations for an entity. - + You can control whether to return the full entity or just the relation item with the `?hydrate` query param. - + Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -100,9 +100,9 @@ def get_relations(self, request: operations.GetRelationsRequest) -> operations.G def get_relations_v2(self, request: operations.GetRelationsV2Request) -> operations.GetRelationsV2Response: r"""getRelationsV2 Returns 1st level direct relations for an entity with pagination. - + You can control whether to return the full entity or just the relation item with the `?hydrate` query param. - + Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) diff --git a/entity/src/epilot/sdk.py b/entity/src/epilot/sdk.py index e85430415..822107785 100755 --- a/entity/src/epilot/sdk.py +++ b/entity/src/epilot/sdk.py @@ -15,9 +15,9 @@ class Epilot: r"""Entity API: Flexible data layer for epilot Entities. - + Use this API configure and access your business objects like Contacts, Opportunities and Products. - + [Feature Documentation](https://docs.epilot.io/docs/entities/flexible-entities) """ activity: Activity diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 76a09750f..46418169d 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.13.1' - gen_version: str = '2.61.5' + sdk_version: str = '1.14.0' + gen_version: str = '2.62.1' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 07cf7cda7aaa3932679d3385c50b2ec35199d881 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 14 Jul 2023 01:56:56 +0000 Subject: [PATCH 18/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.59.0 --- entity/README.md | 4 +++- entity/RELEASES.md | 8 +++++++- entity/USAGE.md | 4 +++- entity/docs/sdks/activity/README.md | 6 +++--- entity/docs/sdks/entities/README.md | 14 +++++++------- entity/docs/sdks/relations/README.md | 8 ++++---- entity/docs/sdks/savedviews/README.md | 6 +++--- entity/docs/sdks/schemas/README.md | 12 ++++++------ entity/docs/sdks/taxonomy/README.md | 8 ++++---- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 12 files changed, 46 insertions(+), 36 deletions(-) diff --git a/entity/README.md b/entity/README.md index 717785c1d..a08fa7fd4 100755 --- a/entity/README.md +++ b/entity/README.md @@ -10,9 +10,11 @@ pip install git+https://github.com/epilot-dev/sdk-python.git#subdirectory=entity ## SDK Example Usage + + ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 01c8171da..e2221ddde 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -136,4 +136,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.57.0 (2.62.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.57.0 (2.62.1) https://github.com/speakeasy-api/speakeasy + +## 2023-07-14 01:56:32 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.59.0 (2.65.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/USAGE.md b/entity/USAGE.md index e2b02a3b0..79ecb397a 100755 --- a/entity/USAGE.md +++ b/entity/USAGE.md @@ -1,7 +1,9 @@ + + ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md index 8875cf228..7f551e5e1 100755 --- a/entity/docs/sdks/activity/README.md +++ b/entity/docs/sdks/activity/README.md @@ -19,7 +19,7 @@ Attach existing activity to entity activity feeds ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -115,7 +115,7 @@ Get activity by id ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -157,7 +157,7 @@ Get activity feed for an entity ```python import epilot import dateutil.parser -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index f229c41c1..d615f4100 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -24,7 +24,7 @@ Autocomplete entity attributes ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -90,7 +90,7 @@ The items in `$relation` support two properties: ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -139,7 +139,7 @@ If no `activity_id` query parameter is provided, implicitly creates Activity of ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -242,7 +242,7 @@ Becomes: ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -309,7 +309,7 @@ The items in `$relation` support two properties: ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -494,7 +494,7 @@ The items in `$relation` support two properties: ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -549,7 +549,7 @@ If no `activity_id` query parameter is provided, implicitly creates Activity of ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index a2fa985f0..dbdd33c5d 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -98,7 +98,7 @@ Removes relation between two entities ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -145,7 +145,7 @@ Reverse relations i.e. entities referring to this entity are included with the ` ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -191,7 +191,7 @@ Reverse relations i.e. entities referring to this entity are included with the ` ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -240,7 +240,7 @@ Updates an existing relation between two entities. ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index dc246fdfc..28874f366 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -76,7 +76,7 @@ Deletes a saved view ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -114,7 +114,7 @@ Gets Saved View configuration by id. ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -152,7 +152,7 @@ Get the Saved Views based on the schema ```python import epilot - +from epilot.models import shared s = epilot.Epilot( security=shared.Security( diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index fc745ebc0..1e228f732 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -22,7 +22,7 @@ Delete a schema, or a specific version of a schema ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -60,7 +60,7 @@ By default gets the latest version of the Schema and to get the specific version ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -99,7 +99,7 @@ Get all versions of this schema ordered by the latest versions including drafts. ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -141,7 +141,7 @@ List canonical versions of all available schemas ```python import epilot - +from epilot.models import shared s = epilot.Epilot( security=shared.Security( @@ -170,7 +170,7 @@ Get the latest versions of all schemas ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -208,7 +208,7 @@ List taxonomy classifications for a given schema ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index 4f83bea29..796522792 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -20,7 +20,7 @@ Get taxonomy by slug ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -58,7 +58,7 @@ List taxonomies in an organisation ```python import epilot - +from epilot.models import shared s = epilot.Epilot( security=shared.Security( @@ -87,7 +87,7 @@ List taxonomy classifications in an organisation based on taxonomy slug ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( @@ -133,7 +133,7 @@ Taxonomies autocomplete ```python import epilot -from epilot.models import operations +from epilot.models import operations, shared s = epilot.Epilot( security=shared.Security( diff --git a/entity/gen.yaml b/entity/gen.yaml index 1ef7ad953..93a601116 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.57.0 - generationVersion: 2.62.1 + speakeasyVersion: 1.59.0 + generationVersion: 2.65.0 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.14.0 + version: 1.15.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index b3f3f20ec..db33a1788 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.14.0", + version="1.15.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 46418169d..dc68ac3b0 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.14.0' - gen_version: str = '2.62.1' + sdk_version: str = '1.15.0' + gen_version: str = '2.65.0' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 0863498931c27d165be004b1233aee7b20a28ce7 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Mon, 17 Jul 2023 02:00:23 +0000 Subject: [PATCH 19/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.60.0 --- entity/RELEASES.md | 8 ++++++- entity/files.gen | 1 + entity/gen.yaml | 6 +++--- entity/pylintrc | 4 +++- entity/setup.py | 2 +- entity/src/epilot/activity.py | 8 +++++++ entity/src/epilot/entities.py | 16 +++++++++++++- entity/src/epilot/models/errors/sdkerror.py | 24 +++++++++++++++++++++ entity/src/epilot/relations.py | 8 +++++++ entity/src/epilot/saved_views.py | 8 +++++++ entity/src/epilot/schemas.py | 12 +++++++++++ entity/src/epilot/sdkconfiguration.py | 4 ++-- entity/src/epilot/taxonomy.py | 10 +++++++++ 13 files changed, 102 insertions(+), 9 deletions(-) create mode 100755 entity/src/epilot/models/errors/sdkerror.py diff --git a/entity/RELEASES.md b/entity/RELEASES.md index e2221ddde..22a55c5fd 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -142,4 +142,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.59.0 (2.65.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.59.0 (2.65.0) https://github.com/speakeasy-api/speakeasy + +## 2023-07-17 01:59:57 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.60.0 (2.66.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/files.gen b/entity/files.gen index a7faec61d..c32c3e568 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -12,6 +12,7 @@ pylintrc setup.py src/epilot/__init__.py src/epilot/models/__init__.py +src/epilot/models/errors/sdkerror.py src/epilot/utils/__init__.py src/epilot/utils/retries.py src/epilot/utils/utils.py diff --git a/entity/gen.yaml b/entity/gen.yaml index 93a601116..98d26195b 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.59.0 - generationVersion: 2.65.0 + speakeasyVersion: 1.60.0 + generationVersion: 2.66.0 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.15.0 + version: 1.16.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/pylintrc b/entity/pylintrc index dd6adb149..0302fb809 100755 --- a/entity/pylintrc +++ b/entity/pylintrc @@ -439,7 +439,9 @@ disable=raw-checker-failed, using-constant-test, too-many-statements, cyclic-import, - too-many-nested-blocks + too-many-nested-blocks, + too-many-boolean-expressions, + no-else-raise # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option diff --git a/entity/setup.py b/entity/setup.py index db33a1788..ceb3e9ca9 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.15.0", + version="1.16.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/activity.py b/entity/src/epilot/activity.py index 1870416ea..5fac2af2b 100755 --- a/entity/src/epilot/activity.py +++ b/entity/src/epilot/activity.py @@ -36,6 +36,8 @@ def attach_activity(self, request: operations.AttachActivityRequest) -> operatio if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.ActivityItem]) res.activity_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -69,6 +71,8 @@ def create_activity(self, request: operations.CreateActivityRequest) -> operatio if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.ActivityItem]) res.activity_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -96,6 +100,8 @@ def get_activity(self, request: operations.GetActivityRequest) -> operations.Get if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.ActivityItem]) res.activity_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -123,6 +129,8 @@ def get_entity_activity_feed(self, request: operations.GetEntityActivityFeedRequ if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.GetEntityActivityFeed200ApplicationJSON]) res.get_entity_activity_feed_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res diff --git a/entity/src/epilot/entities.py b/entity/src/epilot/entities.py index 9f396e58b..92bf863a1 100755 --- a/entity/src/epilot/entities.py +++ b/entity/src/epilot/entities.py @@ -36,6 +36,8 @@ def autocomplete(self, request: operations.AutocompleteRequest) -> operations.Au if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.Autocomplete200ApplicationJSON]) res.autocomplete_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -90,6 +92,8 @@ def create_entity(self, request: operations.CreateEntityRequest) -> operations.C if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[dict[str, Any]]) res.entity_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -206,6 +210,8 @@ def get_entity(self, request: operations.GetEntityRequest) -> operations.GetEnti if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.GetEntity200ApplicationJSON]) res.get_entity_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -264,6 +270,8 @@ def patch_entity(self, request: operations.PatchEntityRequest) -> operations.Pat if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[dict[str, Any]]) res.entity_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code == 409: pass @@ -359,8 +367,10 @@ def search_entities(self, request: shared.EntitySearchParams) -> operations.Sear if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.EntitySearchResults]) res.entity_search_results = out - if utils.match_content_type(content_type, 'text/csv'): + elif utils.match_content_type(content_type, 'text/csv'): res.search_entities_200_text_csv_string = http_res.content + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -415,6 +425,8 @@ def update_entity(self, request: operations.UpdateEntityRequest) -> operations.U if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[dict[str, Any]]) res.entity_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -453,6 +465,8 @@ def upsert_entity(self, request: operations.UpsertEntityRequest) -> operations.U if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[dict[str, Any]]) res.entity_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code == 409: pass diff --git a/entity/src/epilot/models/errors/sdkerror.py b/entity/src/epilot/models/errors/sdkerror.py new file mode 100755 index 000000000..6bb02bbd6 --- /dev/null +++ b/entity/src/epilot/models/errors/sdkerror.py @@ -0,0 +1,24 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http + + +class SDKError(Exception): + """Represents an error returned by the API.""" + message: str + status_code: int + body: str + raw_response: requests_http.Response + + def __init__(self, message: str, status_code: int, body: str, raw_response: requests_http.Response): + self.message = message + self.status_code = status_code + self.body = body + self.raw_response = raw_response + + def __str__(self): + body = '' + if len(self.body) > 0: + body = f'\n{self.body}' + + return f'{self.message}: Status {self.status_code}{body}' diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py index 9cb276753..9f60e5024 100755 --- a/entity/src/epilot/relations.py +++ b/entity/src/epilot/relations.py @@ -39,6 +39,8 @@ def add_relations(self, request: operations.AddRelationsRequest) -> operations.A if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.RelationItem]) res.relation_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -93,6 +95,8 @@ def get_relations(self, request: operations.GetRelationsRequest) -> operations.G if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[list[Any]]) res.get_relations_resp = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -124,6 +128,8 @@ def get_relations_v2(self, request: operations.GetRelationsV2Request) -> operati if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.GetRelationsRespWithPagination]) res.get_relations_resp_with_pagination = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -154,6 +160,8 @@ def update_relation(self, request: operations.UpdateRelationRequest) -> operatio if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.RelationItem]) res.relation_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res diff --git a/entity/src/epilot/saved_views.py b/entity/src/epilot/saved_views.py index 288192276..01e4bdb1c 100755 --- a/entity/src/epilot/saved_views.py +++ b/entity/src/epilot/saved_views.py @@ -38,6 +38,8 @@ def create_saved_view(self, request: shared.SavedView) -> operations.CreateSaved if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.SavedViewItem]) res.saved_view_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -86,6 +88,8 @@ def get_saved_view(self, request: operations.GetSavedViewRequest) -> operations. if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.GetSavedView200ApplicationJSON]) res.get_saved_view_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -112,6 +116,8 @@ def list_saved_views(self) -> operations.ListSavedViewsResponse: if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.ListSavedViews200ApplicationJSON]) res.list_saved_views_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -141,6 +147,8 @@ def update_saved_view(self, request: operations.UpdateSavedViewRequest) -> opera if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.SavedViewItem]) res.saved_view_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res diff --git a/entity/src/epilot/schemas.py b/entity/src/epilot/schemas.py index 02d3742c2..2bce7b205 100755 --- a/entity/src/epilot/schemas.py +++ b/entity/src/epilot/schemas.py @@ -58,6 +58,8 @@ def get_schema(self, request: operations.GetSchemaRequest) -> operations.GetSche if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.EntitySchemaItem]) res.entity_schema_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -85,6 +87,8 @@ def get_schema_versions(self, request: operations.GetSchemaVersionsRequest) -> o if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.GetSchemaVersions200ApplicationJSON]) res.get_schema_versions_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -111,6 +115,8 @@ def list_schema_blueprints(self) -> operations.ListSchemaBlueprintsResponse: if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.ListSchemaBlueprints200ApplicationJSON]) res.list_schema_blueprints_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -138,6 +144,8 @@ def list_schemas(self, request: operations.ListSchemasRequest) -> operations.Lis if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.ListSchemas200ApplicationJSON]) res.list_schemas_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -165,6 +173,8 @@ def list_taxonomy_classifications_for_schema(self, request: operations.ListTaxon if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.ListTaxonomyClassificationsForSchema200ApplicationJSON]) res.list_taxonomy_classifications_for_schema_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -195,6 +205,8 @@ def put_schema(self, request: operations.PutSchemaRequest) -> operations.PutSche if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.EntitySchemaItem]) res.entity_schema_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index dc68ac3b0..8a9be7203 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.15.0' - gen_version: str = '2.65.0' + sdk_version: str = '1.16.0' + gen_version: str = '2.66.0' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: diff --git a/entity/src/epilot/taxonomy.py b/entity/src/epilot/taxonomy.py index dcb67a049..150e6e5c3 100755 --- a/entity/src/epilot/taxonomy.py +++ b/entity/src/epilot/taxonomy.py @@ -35,6 +35,8 @@ def get_taxonomy(self, request: operations.GetTaxonomyRequest) -> operations.Get if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.Taxonomy]) res.taxonomy = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -61,6 +63,8 @@ def list_taxonomies(self) -> operations.ListTaxonomiesResponse: if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.ListTaxonomies200ApplicationJSON]) res.list_taxonomies_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -91,6 +95,8 @@ def taxonomies_classifications_search(self, request: operations.TaxonomiesClassi if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.TaxonomiesClassificationsSearch200ApplicationJSON]) res.taxonomies_classifications_search_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -118,6 +124,8 @@ def taxonomy_autocomplete(self, request: operations.TaxonomyAutocompleteRequest) if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.TaxonomyAutocomplete200ApplicationJSON]) res.taxonomy_autocomplete_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -147,6 +155,8 @@ def update_classifications_for_taxonomy(self, request: operations.UpdateClassifi if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.UpdateClassificationsForTaxonomy200ApplicationJSON]) res.update_classifications_for_taxonomy_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res From 1b27d5ffe03b4951ff5f3ca6d1aec944dfeb1037 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 18 Jul 2023 02:04:48 +0000 Subject: [PATCH 20/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.61.0 --- entity/RELEASES.md | 8 +++++++- entity/files.gen | 1 + entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/activity.py | 2 +- entity/src/epilot/entities.py | 2 +- entity/src/epilot/models/errors/__init__.py | 4 ++++ entity/src/epilot/relations.py | 2 +- entity/src/epilot/saved_views.py | 2 +- entity/src/epilot/schemas.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- entity/src/epilot/taxonomy.py | 2 +- 12 files changed, 24 insertions(+), 13 deletions(-) create mode 100755 entity/src/epilot/models/errors/__init__.py diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 22a55c5fd..98a0d8e08 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -148,4 +148,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.60.0 (2.66.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.60.0 (2.66.0) https://github.com/speakeasy-api/speakeasy + +## 2023-07-18 02:04:21 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.61.0 (2.70.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/files.gen b/entity/files.gen index c32c3e568..31113becb 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -107,6 +107,7 @@ src/epilot/models/shared/taxonomy.py src/epilot/models/shared/classificationsupdate.py src/epilot/models/shared/security.py src/epilot/models/shared/__init__.py +src/epilot/models/errors/__init__.py docs/sdks/epilot/README.md docs/sdks/activity/README.md docs/sdks/entities/README.md diff --git a/entity/gen.yaml b/entity/gen.yaml index 98d26195b..22cc77a7a 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.60.0 - generationVersion: 2.66.0 + speakeasyVersion: 1.61.0 + generationVersion: 2.70.0 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.16.0 + version: 1.17.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index ceb3e9ca9..676d5ecea 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.16.0", + version="1.17.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/activity.py b/entity/src/epilot/activity.py index 5fac2af2b..60a09333e 100755 --- a/entity/src/epilot/activity.py +++ b/entity/src/epilot/activity.py @@ -2,7 +2,7 @@ from .sdkconfiguration import SDKConfiguration from epilot import utils -from epilot.models import operations, shared +from epilot.models import errors, operations, shared from typing import Optional class Activity: diff --git a/entity/src/epilot/entities.py b/entity/src/epilot/entities.py index 92bf863a1..a1c1c407e 100755 --- a/entity/src/epilot/entities.py +++ b/entity/src/epilot/entities.py @@ -2,7 +2,7 @@ from .sdkconfiguration import SDKConfiguration from epilot import utils -from epilot.models import operations, shared +from epilot.models import errors, operations, shared from typing import Any, Optional class Entities: diff --git a/entity/src/epilot/models/errors/__init__.py b/entity/src/epilot/models/errors/__init__.py new file mode 100755 index 000000000..cfd848441 --- /dev/null +++ b/entity/src/epilot/models/errors/__init__.py @@ -0,0 +1,4 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from .sdkerror import SDKError +__all__ = ["SDKError"] diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py index 9f60e5024..7f7ae4aa9 100755 --- a/entity/src/epilot/relations.py +++ b/entity/src/epilot/relations.py @@ -2,7 +2,7 @@ from .sdkconfiguration import SDKConfiguration from epilot import utils -from epilot.models import operations, shared +from epilot.models import errors, operations, shared from typing import Any, Optional class Relations: diff --git a/entity/src/epilot/saved_views.py b/entity/src/epilot/saved_views.py index 01e4bdb1c..2f1d5ec2f 100755 --- a/entity/src/epilot/saved_views.py +++ b/entity/src/epilot/saved_views.py @@ -2,7 +2,7 @@ from .sdkconfiguration import SDKConfiguration from epilot import utils -from epilot.models import operations, shared +from epilot.models import errors, operations, shared from typing import Optional class SavedViews: diff --git a/entity/src/epilot/schemas.py b/entity/src/epilot/schemas.py index 2bce7b205..f209f9f4b 100755 --- a/entity/src/epilot/schemas.py +++ b/entity/src/epilot/schemas.py @@ -2,7 +2,7 @@ from .sdkconfiguration import SDKConfiguration from epilot import utils -from epilot.models import operations, shared +from epilot.models import errors, operations, shared from typing import Optional class Schemas: diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 8a9be7203..81c501daf 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.16.0' - gen_version: str = '2.66.0' + sdk_version: str = '1.17.0' + gen_version: str = '2.70.0' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: diff --git a/entity/src/epilot/taxonomy.py b/entity/src/epilot/taxonomy.py index 150e6e5c3..0bfc01a26 100755 --- a/entity/src/epilot/taxonomy.py +++ b/entity/src/epilot/taxonomy.py @@ -2,7 +2,7 @@ from .sdkconfiguration import SDKConfiguration from epilot import utils -from epilot.models import operations, shared +from epilot.models import errors, operations, shared from typing import Optional class Taxonomy: From 8e96d8721df2626f4fa73844b704a9c17d7233f2 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 19 Jul 2023 02:53:13 +0000 Subject: [PATCH 21/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.62.1 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 98a0d8e08..aaad12ac3 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -154,4 +154,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.61.0 (2.70.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.61.0 (2.70.0) https://github.com/speakeasy-api/speakeasy + +## 2023-07-19 02:52:43 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.62.1 (2.70.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 22cc77a7a..209f595a0 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.61.0 - generationVersion: 2.70.0 + speakeasyVersion: 1.62.1 + generationVersion: 2.70.2 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.17.0 + version: 1.17.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 676d5ecea..dbd87b773 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.17.0", + version="1.17.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 81c501daf..c15edc426 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.17.0' - gen_version: str = '2.70.0' + sdk_version: str = '1.17.1' + gen_version: str = '2.70.2' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 365533962ba555532ae05161d9ae4c67bfe3f338 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 22 Jul 2023 01:35:01 +0000 Subject: [PATCH 22/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.64.0 --- entity/RELEASES.md | 8 +++++++- entity/USAGE.md | 0 entity/docs/models/operations/addrelationsrequest.md | 0 entity/docs/models/operations/addrelationsresponse.md | 0 entity/docs/models/operations/attachactivityrequest.md | 0 entity/docs/models/operations/attachactivityresponse.md | 0 .../models/operations/autocomplete200applicationjson.md | 0 entity/docs/models/operations/autocompleterequest.md | 0 entity/docs/models/operations/autocompleteresponse.md | 0 entity/docs/models/operations/createactivityrequest.md | 0 entity/docs/models/operations/createactivityresponse.md | 0 entity/docs/models/operations/createentityrequest.md | 0 entity/docs/models/operations/createentityresponse.md | 0 entity/docs/models/operations/createsavedviewresponse.md | 0 entity/docs/models/operations/deleteentityrequest.md | 0 entity/docs/models/operations/deleteentityresponse.md | 0 entity/docs/models/operations/deleterelationrequest.md | 0 entity/docs/models/operations/deleterelationresponse.md | 0 entity/docs/models/operations/deletesavedviewrequest.md | 0 entity/docs/models/operations/deletesavedviewresponse.md | 0 entity/docs/models/operations/deleteschemarequest.md | 0 entity/docs/models/operations/deleteschemaresponse.md | 0 entity/docs/models/operations/exportentitiesrequest.md | 0 entity/docs/models/operations/exportentitiesresponse.md | 0 entity/docs/models/operations/getactivityrequest.md | 0 entity/docs/models/operations/getactivityresponse.md | 0 .../docs/models/operations/getentity200applicationjson.md | 0 .../operations/getentityactivityfeed200applicationjson.md | 0 .../models/operations/getentityactivityfeedrequest.md | 0 .../models/operations/getentityactivityfeedresponse.md | 0 entity/docs/models/operations/getentityrequest.md | 0 entity/docs/models/operations/getentityresponse.md | 0 entity/docs/models/operations/getrelationsrequest.md | 0 entity/docs/models/operations/getrelationsresponse.md | 0 entity/docs/models/operations/getrelationsv2request.md | 0 entity/docs/models/operations/getrelationsv2response.md | 0 .../models/operations/getsavedview200applicationjson.md | 0 entity/docs/models/operations/getsavedviewrequest.md | 0 entity/docs/models/operations/getsavedviewresponse.md | 0 entity/docs/models/operations/getschemarequest.md | 0 entity/docs/models/operations/getschemaresponse.md | 0 .../operations/getschemaversions200applicationjson.md | 0 entity/docs/models/operations/getschemaversionsrequest.md | 0 .../docs/models/operations/getschemaversionsresponse.md | 0 entity/docs/models/operations/gettaxonomyrequest.md | 0 entity/docs/models/operations/gettaxonomyresponse.md | 0 entity/docs/models/operations/importentitiesrequest.md | 0 entity/docs/models/operations/importentitiesresponse.md | 0 .../models/operations/listsavedviews200applicationjson.md | 0 entity/docs/models/operations/listsavedviewsresponse.md | 0 .../operations/listschemablueprints200applicationjson.md | 0 .../models/operations/listschemablueprintsresponse.md | 0 .../models/operations/listschemas200applicationjson.md | 0 entity/docs/models/operations/listschemasrequest.md | 0 entity/docs/models/operations/listschemasresponse.md | 0 .../models/operations/listtaxonomies200applicationjson.md | 0 entity/docs/models/operations/listtaxonomiesresponse.md | 0 ...ttaxonomyclassificationsforschema200applicationjson.md | 0 .../listtaxonomyclassificationsforschemarequest.md | 0 .../listtaxonomyclassificationsforschemaresponse.md | 0 entity/docs/models/operations/patchentityrequest.md | 0 entity/docs/models/operations/patchentityresponse.md | 0 entity/docs/models/operations/putschemarequest.md | 0 entity/docs/models/operations/putschemaresponse.md | 0 entity/docs/models/operations/searchentitiesresponse.md | 0 .../taxonomiesclassificationssearch200applicationjson.md | 0 .../operations/taxonomiesclassificationssearchrequest.md | 0 .../taxonomiesclassificationssearchrequestbody.md | 0 .../operations/taxonomiesclassificationssearchresponse.md | 0 .../operations/taxonomyautocomplete200applicationjson.md | 0 .../docs/models/operations/taxonomyautocompleterequest.md | 0 .../models/operations/taxonomyautocompleteresponse.md | 0 .../updateclassificationsfortaxonomy200applicationjson.md | 0 ...classificationsfortaxonomy200applicationjsondeleted.md | 0 .../operations/updateclassificationsfortaxonomyrequest.md | 0 .../updateclassificationsfortaxonomyresponse.md | 0 entity/docs/models/operations/updateentityrequest.md | 0 entity/docs/models/operations/updateentityresponse.md | 0 entity/docs/models/operations/updaterelationrequest.md | 0 .../docs/models/operations/updaterelationrequestbody.md | 0 entity/docs/models/operations/updaterelationresponse.md | 0 entity/docs/models/operations/updatesavedviewrequest.md | 0 entity/docs/models/operations/updatesavedviewresponse.md | 0 entity/docs/models/operations/upsertentityrequest.md | 0 entity/docs/models/operations/upsertentityrequestbody.md | 0 entity/docs/models/operations/upsertentityresponse.md | 0 entity/docs/models/shared/activity.md | 0 entity/docs/models/shared/activityitem.md | 0 entity/docs/models/shared/addressrelationattribute.md | 0 .../models/shared/addressrelationattributeconstraints.md | 0 .../models/shared/addressrelationattributeinfohelpers.md | 0 entity/docs/models/shared/addressrelationattributetype.md | 0 entity/docs/models/shared/automationattribute.md | 0 .../docs/models/shared/automationattributeconstraints.md | 0 .../docs/models/shared/automationattributeinfohelpers.md | 0 entity/docs/models/shared/automationattributetype.md | 0 entity/docs/models/shared/booleanattribute.md | 0 entity/docs/models/shared/booleanattributeconstraints.md | 0 entity/docs/models/shared/booleanattributeinfohelpers.md | 0 entity/docs/models/shared/booleanattributetype.md | 0 entity/docs/models/shared/classificationsupdate.md | 0 entity/docs/models/shared/computedattribute.md | 0 entity/docs/models/shared/computedattributeconstraints.md | 0 entity/docs/models/shared/computedattributeinfohelpers.md | 0 entity/docs/models/shared/computedattributetype.md | 0 entity/docs/models/shared/consentattribute.md | 0 entity/docs/models/shared/consentattributeconstraints.md | 0 entity/docs/models/shared/consentattributeinfohelpers.md | 0 entity/docs/models/shared/consentattributetype.md | 0 entity/docs/models/shared/countryattribute.md | 0 entity/docs/models/shared/countryattributeconstraints.md | 0 entity/docs/models/shared/countryattributeinfohelpers.md | 0 entity/docs/models/shared/countryattributetype.md | 0 entity/docs/models/shared/currencyattribute.md | 0 entity/docs/models/shared/currencyattributeconstraints.md | 0 entity/docs/models/shared/currencyattributecurrency1.md | 0 entity/docs/models/shared/currencyattributeinfohelpers.md | 0 entity/docs/models/shared/currencyattributetype.md | 0 entity/docs/models/shared/dateattribute.md | 0 entity/docs/models/shared/dateattributeconstraints.md | 0 entity/docs/models/shared/dateattributeinfohelpers.md | 0 entity/docs/models/shared/dateattributetype.md | 0 entity/docs/models/shared/entitycapability.md | 0 entity/docs/models/shared/entitydefaultcreate.md | 0 .../models/shared/entitydefaultcreatetablemenuoptions.md | 0 entity/docs/models/shared/entitydefaultcreateviewtype.md | 0 entity/docs/models/shared/entitydefaultedit.md | 0 .../models/shared/entitydefaultedittablemenuoptions.md | 0 entity/docs/models/shared/entitydefaulteditviewtype.md | 0 entity/docs/models/shared/entitydefaulttable.md | 0 .../models/shared/entitydefaulttabledropdownitems1.md | 0 .../models/shared/entitydefaulttabledropdownitems1type.md | 0 .../models/shared/entitydefaulttabledropdownitems2.md | 0 .../models/shared/entitydefaulttabledropdownitems2type.md | 0 .../docs/models/shared/entitydefaulttablenavbaractions.md | 0 .../shared/entitydefaulttablenavbaractionsoptions.md | 0 .../entitydefaulttablenavbaractionsoptionsparams.md | 0 entity/docs/models/shared/entitydefaulttableviewtype.md | 0 entity/docs/models/shared/entityimportparams.md | 0 .../docs/models/shared/entityimportparamss3reference.md | 0 entity/docs/models/shared/entityoperation.md | 0 entity/docs/models/shared/entityoperationdiff.md | 0 entity/docs/models/shared/entityoperationoperation.md | 0 entity/docs/models/shared/entityoperationparams.md | 0 entity/docs/models/shared/entityschema.md | 0 entity/docs/models/shared/entityschemagroupsettings.md | 0 .../shared/entityschemagroupsettingsinfotooltiptitle.md | 0 entity/docs/models/shared/entityschemaitem.md | 0 .../docs/models/shared/entityschemaitemgroupsettings.md | 0 .../entityschemaitemgroupsettingsinfotooltiptitle.md | 0 entity/docs/models/shared/entityschemaitemsource.md | 0 entity/docs/models/shared/entityschemaitemuiconfig.md | 0 .../models/shared/entityschemaitemuiconfiglistitem.md | 0 .../docs/models/shared/entityschemaitemuiconfigsharing.md | 0 entity/docs/models/shared/entityschemauiconfig.md | 0 entity/docs/models/shared/entityschemauiconfiglistitem.md | 0 entity/docs/models/shared/entityschemauiconfigsharing.md | 0 entity/docs/models/shared/entitysearchparams.md | 0 entity/docs/models/shared/entitysearchparamsaggs.md | 0 entity/docs/models/shared/entitysearchresults.md | 0 .../docs/models/shared/entitysearchresultsaggregations.md | 0 entity/docs/models/shared/entityviewdisabled.md | 0 entity/docs/models/shared/entityviewdisabledviewtype.md | 0 entity/docs/models/shared/fileattribute.md | 0 entity/docs/models/shared/fileattributeconstraints.md | 0 .../models/shared/fileattributedefaultaccesscontrol.md | 0 entity/docs/models/shared/fileattributeinfohelpers.md | 0 entity/docs/models/shared/fileattributetype.md | 0 entity/docs/models/shared/getrelationsresp.md | 0 .../docs/models/shared/getrelationsrespwithpagination.md | 0 entity/docs/models/shared/internalattribute.md | 0 entity/docs/models/shared/internalattributeconstraints.md | 0 entity/docs/models/shared/internalattributeinfohelpers.md | 0 entity/docs/models/shared/internalattributetype.md | 0 entity/docs/models/shared/internaluserattribute.md | 0 .../models/shared/internaluserattributeconstraints.md | 0 .../models/shared/internaluserattributeinfohelpers.md | 0 entity/docs/models/shared/internaluserattributetype.md | 0 entity/docs/models/shared/invitationemailattribute.md | 0 .../models/shared/invitationemailattributeconstraints.md | 0 .../models/shared/invitationemailattributeinfohelpers.md | 0 entity/docs/models/shared/invitationemailattributetype.md | 0 entity/docs/models/shared/linkattribute.md | 0 entity/docs/models/shared/linkattributeconstraints.md | 0 entity/docs/models/shared/linkattributeinfohelpers.md | 0 entity/docs/models/shared/linkattributetype.md | 0 entity/docs/models/shared/multiselectattribute.md | 0 .../docs/models/shared/multiselectattributeconstraints.md | 0 .../docs/models/shared/multiselectattributeinfohelpers.md | 0 entity/docs/models/shared/multiselectattributeoptions2.md | 0 entity/docs/models/shared/multiselectattributetype.md | 0 entity/docs/models/shared/numberattribute.md | 0 entity/docs/models/shared/numberattributeconstraints.md | 0 entity/docs/models/shared/numberattributeinfohelpers.md | 0 entity/docs/models/shared/numberattributetype.md | 0 entity/docs/models/shared/orderedlistattribute.md | 0 .../docs/models/shared/orderedlistattributeconstraints.md | 0 .../docs/models/shared/orderedlistattributeinfohelpers.md | 0 entity/docs/models/shared/orderedlistattributetype.md | 0 entity/docs/models/shared/partnerstatusattribute.md | 0 .../models/shared/partnerstatusattributeconstraints.md | 0 .../models/shared/partnerstatusattributeinfohelpers.md | 0 entity/docs/models/shared/partnerstatusattributetype.md | 0 .../docs/models/shared/paymentmethodrelationattribute.md | 0 .../shared/paymentmethodrelationattributeconstraints.md | 0 .../shared/paymentmethodrelationattributeinfohelpers.md | 0 .../models/shared/paymentmethodrelationattributetype.md | 0 entity/docs/models/shared/purposeattribute.md | 0 entity/docs/models/shared/purposeattributeconstraints.md | 0 entity/docs/models/shared/purposeattributeinfohelpers.md | 0 entity/docs/models/shared/purposeattributetype.md | 0 entity/docs/models/shared/redirectentityview.md | 0 entity/docs/models/shared/redirectentityviewviewtype.md | 0 entity/docs/models/shared/relationattribute.md | 0 entity/docs/models/shared/relationattributeactions.md | 0 .../models/shared/relationattributeactionsactiontype.md | 0 entity/docs/models/shared/relationattributeconstraints.md | 0 entity/docs/models/shared/relationattributedrawersize.md | 0 entity/docs/models/shared/relationattributeeditmode.md | 0 entity/docs/models/shared/relationattributeinfohelpers.md | 0 .../shared/relationattributerelationaffinitymode.md | 0 .../docs/models/shared/relationattributerelationtype.md | 0 entity/docs/models/shared/relationattributetype.md | 0 entity/docs/models/shared/relationitem.md | 0 entity/docs/models/shared/repeatableattribute.md | 0 .../docs/models/shared/repeatableattributeconstraints.md | 0 .../docs/models/shared/repeatableattributeinfohelpers.md | 0 .../shared/repeatableattributerelationaffinitymode.md | 0 entity/docs/models/shared/repeatableattributetype.md | 0 entity/docs/models/shared/savedview.md | 0 entity/docs/models/shared/savedviewcreatedby1.md | 0 entity/docs/models/shared/savedviewitem.md | 0 entity/docs/models/shared/savedviewitemcreatedby1.md | 0 entity/docs/models/shared/searchmappings.md | 0 entity/docs/models/shared/searchmappingstype.md | 0 entity/docs/models/shared/security.md | 0 entity/docs/models/shared/selectattribute.md | 0 entity/docs/models/shared/selectattributeconstraints.md | 0 entity/docs/models/shared/selectattributeinfohelpers.md | 0 entity/docs/models/shared/selectattributeoptions1.md | 0 entity/docs/models/shared/selectattributetype.md | 0 entity/docs/models/shared/sequenceattribute.md | 0 entity/docs/models/shared/sequenceattributeconstraints.md | 0 entity/docs/models/shared/sequenceattributeinfohelpers.md | 0 entity/docs/models/shared/sequenceattributetype.md | 0 entity/docs/models/shared/statusattribute.md | 0 entity/docs/models/shared/statusattributeconstraints.md | 0 entity/docs/models/shared/statusattributeinfohelpers.md | 0 entity/docs/models/shared/statusattributeoptions2.md | 0 entity/docs/models/shared/statusattributetype.md | 0 entity/docs/models/shared/summaryattribute.md | 0 entity/docs/models/shared/summaryfield.md | 0 entity/docs/models/shared/tagsattribute.md | 0 entity/docs/models/shared/tagsattributeconstraints.md | 0 entity/docs/models/shared/tagsattributeinfohelpers.md | 0 entity/docs/models/shared/tagsattributetype.md | 0 entity/docs/models/shared/taxonomy.md | 0 entity/docs/models/shared/taxonomyclassification.md | 0 entity/docs/models/shared/textattribute.md | 0 entity/docs/models/shared/textattributeconstraints.md | 0 entity/docs/models/shared/textattributeinfohelpers.md | 0 entity/docs/models/shared/textattributetype.md | 0 entity/docs/models/shared/userrelationattribute.md | 0 .../models/shared/userrelationattributeconstraints.md | 0 .../models/shared/userrelationattributeinfohelpers.md | 0 entity/docs/models/shared/userrelationattributetype.md | 0 entity/docs/sdks/activity/README.md | 0 entity/docs/sdks/entities/README.md | 0 entity/docs/sdks/entityimport/README.md | 0 entity/docs/sdks/epilot/README.md | 0 entity/docs/sdks/export/README.md | 0 entity/docs/sdks/relations/README.md | 0 entity/docs/sdks/savedviews/README.md | 0 entity/docs/sdks/schemas/README.md | 0 entity/docs/sdks/taxonomy/README.md | 0 entity/gen.yaml | 6 +++--- entity/pylintrc | 0 entity/setup.py | 4 ++-- entity/src/epilot/__init__.py | 0 entity/src/epilot/activity.py | 0 entity/src/epilot/entities.py | 0 entity/src/epilot/entity_import.py | 0 entity/src/epilot/export.py | 0 entity/src/epilot/models/__init__.py | 0 entity/src/epilot/models/errors/__init__.py | 0 entity/src/epilot/models/errors/sdkerror.py | 0 entity/src/epilot/models/operations/__init__.py | 0 entity/src/epilot/models/operations/addrelations.py | 0 entity/src/epilot/models/operations/attachactivity.py | 0 entity/src/epilot/models/operations/autocomplete.py | 0 entity/src/epilot/models/operations/createactivity.py | 0 entity/src/epilot/models/operations/createentity.py | 0 entity/src/epilot/models/operations/createsavedview.py | 0 entity/src/epilot/models/operations/deleteentity.py | 0 entity/src/epilot/models/operations/deleterelation.py | 0 entity/src/epilot/models/operations/deletesavedview.py | 0 entity/src/epilot/models/operations/deleteschema.py | 0 entity/src/epilot/models/operations/exportentities.py | 0 entity/src/epilot/models/operations/getactivity.py | 0 entity/src/epilot/models/operations/getentity.py | 0 .../src/epilot/models/operations/getentityactivityfeed.py | 0 entity/src/epilot/models/operations/getrelations.py | 0 entity/src/epilot/models/operations/getrelationsv2.py | 0 entity/src/epilot/models/operations/getsavedview.py | 0 entity/src/epilot/models/operations/getschema.py | 0 entity/src/epilot/models/operations/getschemaversions.py | 0 entity/src/epilot/models/operations/gettaxonomy.py | 0 entity/src/epilot/models/operations/importentities.py | 0 entity/src/epilot/models/operations/listsavedviews.py | 0 .../src/epilot/models/operations/listschemablueprints.py | 0 entity/src/epilot/models/operations/listschemas.py | 0 entity/src/epilot/models/operations/listtaxonomies.py | 0 .../operations/listtaxonomyclassificationsforschema.py | 0 entity/src/epilot/models/operations/patchentity.py | 0 entity/src/epilot/models/operations/putschema.py | 0 entity/src/epilot/models/operations/searchentities.py | 0 .../models/operations/taxonomiesclassificationssearch.py | 0 .../src/epilot/models/operations/taxonomyautocomplete.py | 0 .../models/operations/updateclassificationsfortaxonomy.py | 0 entity/src/epilot/models/operations/updateentity.py | 0 entity/src/epilot/models/operations/updaterelation.py | 0 entity/src/epilot/models/operations/updatesavedview.py | 0 entity/src/epilot/models/operations/upsertentity.py | 0 entity/src/epilot/models/shared/__init__.py | 0 entity/src/epilot/models/shared/activity.py | 0 entity/src/epilot/models/shared/activityitem.py | 0 .../src/epilot/models/shared/addressrelationattribute.py | 0 entity/src/epilot/models/shared/automationattribute.py | 0 entity/src/epilot/models/shared/booleanattribute.py | 0 entity/src/epilot/models/shared/classificationsupdate.py | 0 entity/src/epilot/models/shared/computedattribute.py | 0 entity/src/epilot/models/shared/consentattribute.py | 0 entity/src/epilot/models/shared/countryattribute.py | 0 entity/src/epilot/models/shared/currencyattribute.py | 0 entity/src/epilot/models/shared/dateattribute.py | 0 entity/src/epilot/models/shared/entitycapability.py | 0 entity/src/epilot/models/shared/entitydefaultcreate.py | 0 entity/src/epilot/models/shared/entitydefaultedit.py | 0 entity/src/epilot/models/shared/entitydefaulttable.py | 0 entity/src/epilot/models/shared/entityimportparams.py | 0 entity/src/epilot/models/shared/entityoperation.py | 0 entity/src/epilot/models/shared/entityschema.py | 0 entity/src/epilot/models/shared/entityschemaitem.py | 0 entity/src/epilot/models/shared/entitysearchparams.py | 0 entity/src/epilot/models/shared/entitysearchresults.py | 0 entity/src/epilot/models/shared/entityviewdisabled.py | 0 entity/src/epilot/models/shared/fileattribute.py | 0 entity/src/epilot/models/shared/getrelationsresp.py | 0 .../models/shared/getrelationsrespwithpagination.py | 0 entity/src/epilot/models/shared/internalattribute.py | 0 entity/src/epilot/models/shared/internaluserattribute.py | 0 .../src/epilot/models/shared/invitationemailattribute.py | 0 entity/src/epilot/models/shared/linkattribute.py | 0 entity/src/epilot/models/shared/multiselectattribute.py | 0 entity/src/epilot/models/shared/numberattribute.py | 0 entity/src/epilot/models/shared/orderedlistattribute.py | 0 entity/src/epilot/models/shared/partnerstatusattribute.py | 0 .../models/shared/paymentmethodrelationattribute.py | 0 entity/src/epilot/models/shared/purposeattribute.py | 0 entity/src/epilot/models/shared/redirectentityview.py | 0 entity/src/epilot/models/shared/relationattribute.py | 0 entity/src/epilot/models/shared/relationitem.py | 0 entity/src/epilot/models/shared/repeatableattribute.py | 0 entity/src/epilot/models/shared/savedview.py | 0 entity/src/epilot/models/shared/savedviewitem.py | 0 entity/src/epilot/models/shared/searchmappings.py | 0 entity/src/epilot/models/shared/security.py | 0 entity/src/epilot/models/shared/selectattribute.py | 0 entity/src/epilot/models/shared/sequenceattribute.py | 0 entity/src/epilot/models/shared/statusattribute.py | 0 entity/src/epilot/models/shared/summaryattribute.py | 0 entity/src/epilot/models/shared/summaryfield.py | 0 entity/src/epilot/models/shared/tagsattribute.py | 0 entity/src/epilot/models/shared/taxonomy.py | 0 entity/src/epilot/models/shared/taxonomyclassification.py | 0 entity/src/epilot/models/shared/textattribute.py | 0 entity/src/epilot/models/shared/userrelationattribute.py | 0 entity/src/epilot/relations.py | 0 entity/src/epilot/saved_views.py | 0 entity/src/epilot/schemas.py | 0 entity/src/epilot/sdk.py | 0 entity/src/epilot/sdkconfiguration.py | 4 ++-- entity/src/epilot/taxonomy.py | 0 entity/src/epilot/utils/__init__.py | 0 entity/src/epilot/utils/retries.py | 0 entity/src/epilot/utils/utils.py | 0 386 files changed, 14 insertions(+), 8 deletions(-) mode change 100755 => 100644 entity/USAGE.md mode change 100755 => 100644 entity/docs/models/operations/addrelationsrequest.md mode change 100755 => 100644 entity/docs/models/operations/addrelationsresponse.md mode change 100755 => 100644 entity/docs/models/operations/attachactivityrequest.md mode change 100755 => 100644 entity/docs/models/operations/attachactivityresponse.md mode change 100755 => 100644 entity/docs/models/operations/autocomplete200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/autocompleterequest.md mode change 100755 => 100644 entity/docs/models/operations/autocompleteresponse.md mode change 100755 => 100644 entity/docs/models/operations/createactivityrequest.md mode change 100755 => 100644 entity/docs/models/operations/createactivityresponse.md mode change 100755 => 100644 entity/docs/models/operations/createentityrequest.md mode change 100755 => 100644 entity/docs/models/operations/createentityresponse.md mode change 100755 => 100644 entity/docs/models/operations/createsavedviewresponse.md mode change 100755 => 100644 entity/docs/models/operations/deleteentityrequest.md mode change 100755 => 100644 entity/docs/models/operations/deleteentityresponse.md mode change 100755 => 100644 entity/docs/models/operations/deleterelationrequest.md mode change 100755 => 100644 entity/docs/models/operations/deleterelationresponse.md mode change 100755 => 100644 entity/docs/models/operations/deletesavedviewrequest.md mode change 100755 => 100644 entity/docs/models/operations/deletesavedviewresponse.md mode change 100755 => 100644 entity/docs/models/operations/deleteschemarequest.md mode change 100755 => 100644 entity/docs/models/operations/deleteschemaresponse.md mode change 100755 => 100644 entity/docs/models/operations/exportentitiesrequest.md mode change 100755 => 100644 entity/docs/models/operations/exportentitiesresponse.md mode change 100755 => 100644 entity/docs/models/operations/getactivityrequest.md mode change 100755 => 100644 entity/docs/models/operations/getactivityresponse.md mode change 100755 => 100644 entity/docs/models/operations/getentity200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/getentityactivityfeed200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/getentityactivityfeedrequest.md mode change 100755 => 100644 entity/docs/models/operations/getentityactivityfeedresponse.md mode change 100755 => 100644 entity/docs/models/operations/getentityrequest.md mode change 100755 => 100644 entity/docs/models/operations/getentityresponse.md mode change 100755 => 100644 entity/docs/models/operations/getrelationsrequest.md mode change 100755 => 100644 entity/docs/models/operations/getrelationsresponse.md mode change 100755 => 100644 entity/docs/models/operations/getrelationsv2request.md mode change 100755 => 100644 entity/docs/models/operations/getrelationsv2response.md mode change 100755 => 100644 entity/docs/models/operations/getsavedview200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/getsavedviewrequest.md mode change 100755 => 100644 entity/docs/models/operations/getsavedviewresponse.md mode change 100755 => 100644 entity/docs/models/operations/getschemarequest.md mode change 100755 => 100644 entity/docs/models/operations/getschemaresponse.md mode change 100755 => 100644 entity/docs/models/operations/getschemaversions200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/getschemaversionsrequest.md mode change 100755 => 100644 entity/docs/models/operations/getschemaversionsresponse.md mode change 100755 => 100644 entity/docs/models/operations/gettaxonomyrequest.md mode change 100755 => 100644 entity/docs/models/operations/gettaxonomyresponse.md mode change 100755 => 100644 entity/docs/models/operations/importentitiesrequest.md mode change 100755 => 100644 entity/docs/models/operations/importentitiesresponse.md mode change 100755 => 100644 entity/docs/models/operations/listsavedviews200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/listsavedviewsresponse.md mode change 100755 => 100644 entity/docs/models/operations/listschemablueprints200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/listschemablueprintsresponse.md mode change 100755 => 100644 entity/docs/models/operations/listschemas200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/listschemasrequest.md mode change 100755 => 100644 entity/docs/models/operations/listschemasresponse.md mode change 100755 => 100644 entity/docs/models/operations/listtaxonomies200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/listtaxonomiesresponse.md mode change 100755 => 100644 entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md mode change 100755 => 100644 entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md mode change 100755 => 100644 entity/docs/models/operations/patchentityrequest.md mode change 100755 => 100644 entity/docs/models/operations/patchentityresponse.md mode change 100755 => 100644 entity/docs/models/operations/putschemarequest.md mode change 100755 => 100644 entity/docs/models/operations/putschemaresponse.md mode change 100755 => 100644 entity/docs/models/operations/searchentitiesresponse.md mode change 100755 => 100644 entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/taxonomiesclassificationssearchrequest.md mode change 100755 => 100644 entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md mode change 100755 => 100644 entity/docs/models/operations/taxonomiesclassificationssearchresponse.md mode change 100755 => 100644 entity/docs/models/operations/taxonomyautocomplete200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/taxonomyautocompleterequest.md mode change 100755 => 100644 entity/docs/models/operations/taxonomyautocompleteresponse.md mode change 100755 => 100644 entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md mode change 100755 => 100644 entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md mode change 100755 => 100644 entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md mode change 100755 => 100644 entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md mode change 100755 => 100644 entity/docs/models/operations/updateentityrequest.md mode change 100755 => 100644 entity/docs/models/operations/updateentityresponse.md mode change 100755 => 100644 entity/docs/models/operations/updaterelationrequest.md mode change 100755 => 100644 entity/docs/models/operations/updaterelationrequestbody.md mode change 100755 => 100644 entity/docs/models/operations/updaterelationresponse.md mode change 100755 => 100644 entity/docs/models/operations/updatesavedviewrequest.md mode change 100755 => 100644 entity/docs/models/operations/updatesavedviewresponse.md mode change 100755 => 100644 entity/docs/models/operations/upsertentityrequest.md mode change 100755 => 100644 entity/docs/models/operations/upsertentityrequestbody.md mode change 100755 => 100644 entity/docs/models/operations/upsertentityresponse.md mode change 100755 => 100644 entity/docs/models/shared/activity.md mode change 100755 => 100644 entity/docs/models/shared/activityitem.md mode change 100755 => 100644 entity/docs/models/shared/addressrelationattribute.md mode change 100755 => 100644 entity/docs/models/shared/addressrelationattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/addressrelationattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/addressrelationattributetype.md mode change 100755 => 100644 entity/docs/models/shared/automationattribute.md mode change 100755 => 100644 entity/docs/models/shared/automationattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/automationattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/automationattributetype.md mode change 100755 => 100644 entity/docs/models/shared/booleanattribute.md mode change 100755 => 100644 entity/docs/models/shared/booleanattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/booleanattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/booleanattributetype.md mode change 100755 => 100644 entity/docs/models/shared/classificationsupdate.md mode change 100755 => 100644 entity/docs/models/shared/computedattribute.md mode change 100755 => 100644 entity/docs/models/shared/computedattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/computedattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/computedattributetype.md mode change 100755 => 100644 entity/docs/models/shared/consentattribute.md mode change 100755 => 100644 entity/docs/models/shared/consentattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/consentattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/consentattributetype.md mode change 100755 => 100644 entity/docs/models/shared/countryattribute.md mode change 100755 => 100644 entity/docs/models/shared/countryattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/countryattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/countryattributetype.md mode change 100755 => 100644 entity/docs/models/shared/currencyattribute.md mode change 100755 => 100644 entity/docs/models/shared/currencyattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/currencyattributecurrency1.md mode change 100755 => 100644 entity/docs/models/shared/currencyattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/currencyattributetype.md mode change 100755 => 100644 entity/docs/models/shared/dateattribute.md mode change 100755 => 100644 entity/docs/models/shared/dateattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/dateattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/dateattributetype.md mode change 100755 => 100644 entity/docs/models/shared/entitycapability.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaultcreate.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaultcreateviewtype.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaultedit.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaultedittablemenuoptions.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaulteditviewtype.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaulttable.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaulttabledropdownitems1.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaulttabledropdownitems1type.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaulttabledropdownitems2.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaulttabledropdownitems2type.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaulttablenavbaractions.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md mode change 100755 => 100644 entity/docs/models/shared/entitydefaulttableviewtype.md mode change 100755 => 100644 entity/docs/models/shared/entityimportparams.md mode change 100755 => 100644 entity/docs/models/shared/entityimportparamss3reference.md mode change 100755 => 100644 entity/docs/models/shared/entityoperation.md mode change 100755 => 100644 entity/docs/models/shared/entityoperationdiff.md mode change 100755 => 100644 entity/docs/models/shared/entityoperationoperation.md mode change 100755 => 100644 entity/docs/models/shared/entityoperationparams.md mode change 100755 => 100644 entity/docs/models/shared/entityschema.md mode change 100755 => 100644 entity/docs/models/shared/entityschemagroupsettings.md mode change 100755 => 100644 entity/docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md mode change 100755 => 100644 entity/docs/models/shared/entityschemaitem.md mode change 100755 => 100644 entity/docs/models/shared/entityschemaitemgroupsettings.md mode change 100755 => 100644 entity/docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md mode change 100755 => 100644 entity/docs/models/shared/entityschemaitemsource.md mode change 100755 => 100644 entity/docs/models/shared/entityschemaitemuiconfig.md mode change 100755 => 100644 entity/docs/models/shared/entityschemaitemuiconfiglistitem.md mode change 100755 => 100644 entity/docs/models/shared/entityschemaitemuiconfigsharing.md mode change 100755 => 100644 entity/docs/models/shared/entityschemauiconfig.md mode change 100755 => 100644 entity/docs/models/shared/entityschemauiconfiglistitem.md mode change 100755 => 100644 entity/docs/models/shared/entityschemauiconfigsharing.md mode change 100755 => 100644 entity/docs/models/shared/entitysearchparams.md mode change 100755 => 100644 entity/docs/models/shared/entitysearchparamsaggs.md mode change 100755 => 100644 entity/docs/models/shared/entitysearchresults.md mode change 100755 => 100644 entity/docs/models/shared/entitysearchresultsaggregations.md mode change 100755 => 100644 entity/docs/models/shared/entityviewdisabled.md mode change 100755 => 100644 entity/docs/models/shared/entityviewdisabledviewtype.md mode change 100755 => 100644 entity/docs/models/shared/fileattribute.md mode change 100755 => 100644 entity/docs/models/shared/fileattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/fileattributedefaultaccesscontrol.md mode change 100755 => 100644 entity/docs/models/shared/fileattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/fileattributetype.md mode change 100755 => 100644 entity/docs/models/shared/getrelationsresp.md mode change 100755 => 100644 entity/docs/models/shared/getrelationsrespwithpagination.md mode change 100755 => 100644 entity/docs/models/shared/internalattribute.md mode change 100755 => 100644 entity/docs/models/shared/internalattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/internalattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/internalattributetype.md mode change 100755 => 100644 entity/docs/models/shared/internaluserattribute.md mode change 100755 => 100644 entity/docs/models/shared/internaluserattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/internaluserattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/internaluserattributetype.md mode change 100755 => 100644 entity/docs/models/shared/invitationemailattribute.md mode change 100755 => 100644 entity/docs/models/shared/invitationemailattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/invitationemailattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/invitationemailattributetype.md mode change 100755 => 100644 entity/docs/models/shared/linkattribute.md mode change 100755 => 100644 entity/docs/models/shared/linkattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/linkattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/linkattributetype.md mode change 100755 => 100644 entity/docs/models/shared/multiselectattribute.md mode change 100755 => 100644 entity/docs/models/shared/multiselectattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/multiselectattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/multiselectattributeoptions2.md mode change 100755 => 100644 entity/docs/models/shared/multiselectattributetype.md mode change 100755 => 100644 entity/docs/models/shared/numberattribute.md mode change 100755 => 100644 entity/docs/models/shared/numberattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/numberattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/numberattributetype.md mode change 100755 => 100644 entity/docs/models/shared/orderedlistattribute.md mode change 100755 => 100644 entity/docs/models/shared/orderedlistattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/orderedlistattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/orderedlistattributetype.md mode change 100755 => 100644 entity/docs/models/shared/partnerstatusattribute.md mode change 100755 => 100644 entity/docs/models/shared/partnerstatusattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/partnerstatusattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/partnerstatusattributetype.md mode change 100755 => 100644 entity/docs/models/shared/paymentmethodrelationattribute.md mode change 100755 => 100644 entity/docs/models/shared/paymentmethodrelationattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/paymentmethodrelationattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/paymentmethodrelationattributetype.md mode change 100755 => 100644 entity/docs/models/shared/purposeattribute.md mode change 100755 => 100644 entity/docs/models/shared/purposeattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/purposeattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/purposeattributetype.md mode change 100755 => 100644 entity/docs/models/shared/redirectentityview.md mode change 100755 => 100644 entity/docs/models/shared/redirectentityviewviewtype.md mode change 100755 => 100644 entity/docs/models/shared/relationattribute.md mode change 100755 => 100644 entity/docs/models/shared/relationattributeactions.md mode change 100755 => 100644 entity/docs/models/shared/relationattributeactionsactiontype.md mode change 100755 => 100644 entity/docs/models/shared/relationattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/relationattributedrawersize.md mode change 100755 => 100644 entity/docs/models/shared/relationattributeeditmode.md mode change 100755 => 100644 entity/docs/models/shared/relationattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/relationattributerelationaffinitymode.md mode change 100755 => 100644 entity/docs/models/shared/relationattributerelationtype.md mode change 100755 => 100644 entity/docs/models/shared/relationattributetype.md mode change 100755 => 100644 entity/docs/models/shared/relationitem.md mode change 100755 => 100644 entity/docs/models/shared/repeatableattribute.md mode change 100755 => 100644 entity/docs/models/shared/repeatableattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/repeatableattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/repeatableattributerelationaffinitymode.md mode change 100755 => 100644 entity/docs/models/shared/repeatableattributetype.md mode change 100755 => 100644 entity/docs/models/shared/savedview.md mode change 100755 => 100644 entity/docs/models/shared/savedviewcreatedby1.md mode change 100755 => 100644 entity/docs/models/shared/savedviewitem.md mode change 100755 => 100644 entity/docs/models/shared/savedviewitemcreatedby1.md mode change 100755 => 100644 entity/docs/models/shared/searchmappings.md mode change 100755 => 100644 entity/docs/models/shared/searchmappingstype.md mode change 100755 => 100644 entity/docs/models/shared/security.md mode change 100755 => 100644 entity/docs/models/shared/selectattribute.md mode change 100755 => 100644 entity/docs/models/shared/selectattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/selectattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/selectattributeoptions1.md mode change 100755 => 100644 entity/docs/models/shared/selectattributetype.md mode change 100755 => 100644 entity/docs/models/shared/sequenceattribute.md mode change 100755 => 100644 entity/docs/models/shared/sequenceattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/sequenceattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/sequenceattributetype.md mode change 100755 => 100644 entity/docs/models/shared/statusattribute.md mode change 100755 => 100644 entity/docs/models/shared/statusattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/statusattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/statusattributeoptions2.md mode change 100755 => 100644 entity/docs/models/shared/statusattributetype.md mode change 100755 => 100644 entity/docs/models/shared/summaryattribute.md mode change 100755 => 100644 entity/docs/models/shared/summaryfield.md mode change 100755 => 100644 entity/docs/models/shared/tagsattribute.md mode change 100755 => 100644 entity/docs/models/shared/tagsattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/tagsattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/tagsattributetype.md mode change 100755 => 100644 entity/docs/models/shared/taxonomy.md mode change 100755 => 100644 entity/docs/models/shared/taxonomyclassification.md mode change 100755 => 100644 entity/docs/models/shared/textattribute.md mode change 100755 => 100644 entity/docs/models/shared/textattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/textattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/textattributetype.md mode change 100755 => 100644 entity/docs/models/shared/userrelationattribute.md mode change 100755 => 100644 entity/docs/models/shared/userrelationattributeconstraints.md mode change 100755 => 100644 entity/docs/models/shared/userrelationattributeinfohelpers.md mode change 100755 => 100644 entity/docs/models/shared/userrelationattributetype.md mode change 100755 => 100644 entity/docs/sdks/activity/README.md mode change 100755 => 100644 entity/docs/sdks/entities/README.md mode change 100755 => 100644 entity/docs/sdks/entityimport/README.md mode change 100755 => 100644 entity/docs/sdks/epilot/README.md mode change 100755 => 100644 entity/docs/sdks/export/README.md mode change 100755 => 100644 entity/docs/sdks/relations/README.md mode change 100755 => 100644 entity/docs/sdks/savedviews/README.md mode change 100755 => 100644 entity/docs/sdks/schemas/README.md mode change 100755 => 100644 entity/docs/sdks/taxonomy/README.md mode change 100755 => 100644 entity/pylintrc mode change 100755 => 100644 entity/setup.py mode change 100755 => 100644 entity/src/epilot/__init__.py mode change 100755 => 100644 entity/src/epilot/activity.py mode change 100755 => 100644 entity/src/epilot/entities.py mode change 100755 => 100644 entity/src/epilot/entity_import.py mode change 100755 => 100644 entity/src/epilot/export.py mode change 100755 => 100644 entity/src/epilot/models/__init__.py mode change 100755 => 100644 entity/src/epilot/models/errors/__init__.py mode change 100755 => 100644 entity/src/epilot/models/errors/sdkerror.py mode change 100755 => 100644 entity/src/epilot/models/operations/__init__.py mode change 100755 => 100644 entity/src/epilot/models/operations/addrelations.py mode change 100755 => 100644 entity/src/epilot/models/operations/attachactivity.py mode change 100755 => 100644 entity/src/epilot/models/operations/autocomplete.py mode change 100755 => 100644 entity/src/epilot/models/operations/createactivity.py mode change 100755 => 100644 entity/src/epilot/models/operations/createentity.py mode change 100755 => 100644 entity/src/epilot/models/operations/createsavedview.py mode change 100755 => 100644 entity/src/epilot/models/operations/deleteentity.py mode change 100755 => 100644 entity/src/epilot/models/operations/deleterelation.py mode change 100755 => 100644 entity/src/epilot/models/operations/deletesavedview.py mode change 100755 => 100644 entity/src/epilot/models/operations/deleteschema.py mode change 100755 => 100644 entity/src/epilot/models/operations/exportentities.py mode change 100755 => 100644 entity/src/epilot/models/operations/getactivity.py mode change 100755 => 100644 entity/src/epilot/models/operations/getentity.py mode change 100755 => 100644 entity/src/epilot/models/operations/getentityactivityfeed.py mode change 100755 => 100644 entity/src/epilot/models/operations/getrelations.py mode change 100755 => 100644 entity/src/epilot/models/operations/getrelationsv2.py mode change 100755 => 100644 entity/src/epilot/models/operations/getsavedview.py mode change 100755 => 100644 entity/src/epilot/models/operations/getschema.py mode change 100755 => 100644 entity/src/epilot/models/operations/getschemaversions.py mode change 100755 => 100644 entity/src/epilot/models/operations/gettaxonomy.py mode change 100755 => 100644 entity/src/epilot/models/operations/importentities.py mode change 100755 => 100644 entity/src/epilot/models/operations/listsavedviews.py mode change 100755 => 100644 entity/src/epilot/models/operations/listschemablueprints.py mode change 100755 => 100644 entity/src/epilot/models/operations/listschemas.py mode change 100755 => 100644 entity/src/epilot/models/operations/listtaxonomies.py mode change 100755 => 100644 entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py mode change 100755 => 100644 entity/src/epilot/models/operations/patchentity.py mode change 100755 => 100644 entity/src/epilot/models/operations/putschema.py mode change 100755 => 100644 entity/src/epilot/models/operations/searchentities.py mode change 100755 => 100644 entity/src/epilot/models/operations/taxonomiesclassificationssearch.py mode change 100755 => 100644 entity/src/epilot/models/operations/taxonomyautocomplete.py mode change 100755 => 100644 entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py mode change 100755 => 100644 entity/src/epilot/models/operations/updateentity.py mode change 100755 => 100644 entity/src/epilot/models/operations/updaterelation.py mode change 100755 => 100644 entity/src/epilot/models/operations/updatesavedview.py mode change 100755 => 100644 entity/src/epilot/models/operations/upsertentity.py mode change 100755 => 100644 entity/src/epilot/models/shared/__init__.py mode change 100755 => 100644 entity/src/epilot/models/shared/activity.py mode change 100755 => 100644 entity/src/epilot/models/shared/activityitem.py mode change 100755 => 100644 entity/src/epilot/models/shared/addressrelationattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/automationattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/booleanattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/classificationsupdate.py mode change 100755 => 100644 entity/src/epilot/models/shared/computedattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/consentattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/countryattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/currencyattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/dateattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/entitycapability.py mode change 100755 => 100644 entity/src/epilot/models/shared/entitydefaultcreate.py mode change 100755 => 100644 entity/src/epilot/models/shared/entitydefaultedit.py mode change 100755 => 100644 entity/src/epilot/models/shared/entitydefaulttable.py mode change 100755 => 100644 entity/src/epilot/models/shared/entityimportparams.py mode change 100755 => 100644 entity/src/epilot/models/shared/entityoperation.py mode change 100755 => 100644 entity/src/epilot/models/shared/entityschema.py mode change 100755 => 100644 entity/src/epilot/models/shared/entityschemaitem.py mode change 100755 => 100644 entity/src/epilot/models/shared/entitysearchparams.py mode change 100755 => 100644 entity/src/epilot/models/shared/entitysearchresults.py mode change 100755 => 100644 entity/src/epilot/models/shared/entityviewdisabled.py mode change 100755 => 100644 entity/src/epilot/models/shared/fileattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/getrelationsresp.py mode change 100755 => 100644 entity/src/epilot/models/shared/getrelationsrespwithpagination.py mode change 100755 => 100644 entity/src/epilot/models/shared/internalattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/internaluserattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/invitationemailattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/linkattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/multiselectattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/numberattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/orderedlistattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/partnerstatusattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/paymentmethodrelationattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/purposeattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/redirectentityview.py mode change 100755 => 100644 entity/src/epilot/models/shared/relationattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/relationitem.py mode change 100755 => 100644 entity/src/epilot/models/shared/repeatableattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/savedview.py mode change 100755 => 100644 entity/src/epilot/models/shared/savedviewitem.py mode change 100755 => 100644 entity/src/epilot/models/shared/searchmappings.py mode change 100755 => 100644 entity/src/epilot/models/shared/security.py mode change 100755 => 100644 entity/src/epilot/models/shared/selectattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/sequenceattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/statusattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/summaryattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/summaryfield.py mode change 100755 => 100644 entity/src/epilot/models/shared/tagsattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/taxonomy.py mode change 100755 => 100644 entity/src/epilot/models/shared/taxonomyclassification.py mode change 100755 => 100644 entity/src/epilot/models/shared/textattribute.py mode change 100755 => 100644 entity/src/epilot/models/shared/userrelationattribute.py mode change 100755 => 100644 entity/src/epilot/relations.py mode change 100755 => 100644 entity/src/epilot/saved_views.py mode change 100755 => 100644 entity/src/epilot/schemas.py mode change 100755 => 100644 entity/src/epilot/sdk.py mode change 100755 => 100644 entity/src/epilot/sdkconfiguration.py mode change 100755 => 100644 entity/src/epilot/taxonomy.py mode change 100755 => 100644 entity/src/epilot/utils/__init__.py mode change 100755 => 100644 entity/src/epilot/utils/retries.py mode change 100755 => 100644 entity/src/epilot/utils/utils.py diff --git a/entity/RELEASES.md b/entity/RELEASES.md index aaad12ac3..12597b0f5 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -160,4 +160,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.62.1 (2.70.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.62.1 (2.70.2) https://github.com/speakeasy-api/speakeasy + +## 2023-07-22 01:34:37 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.64.0 (2.71.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/USAGE.md b/entity/USAGE.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/addrelationsrequest.md b/entity/docs/models/operations/addrelationsrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/addrelationsresponse.md b/entity/docs/models/operations/addrelationsresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/attachactivityrequest.md b/entity/docs/models/operations/attachactivityrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/attachactivityresponse.md b/entity/docs/models/operations/attachactivityresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/autocomplete200applicationjson.md b/entity/docs/models/operations/autocomplete200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/autocompleterequest.md b/entity/docs/models/operations/autocompleterequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/autocompleteresponse.md b/entity/docs/models/operations/autocompleteresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/createactivityrequest.md b/entity/docs/models/operations/createactivityrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/createactivityresponse.md b/entity/docs/models/operations/createactivityresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/createentityrequest.md b/entity/docs/models/operations/createentityrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/createentityresponse.md b/entity/docs/models/operations/createentityresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/createsavedviewresponse.md b/entity/docs/models/operations/createsavedviewresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/deleteentityrequest.md b/entity/docs/models/operations/deleteentityrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/deleteentityresponse.md b/entity/docs/models/operations/deleteentityresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/deleterelationrequest.md b/entity/docs/models/operations/deleterelationrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/deleterelationresponse.md b/entity/docs/models/operations/deleterelationresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/deletesavedviewrequest.md b/entity/docs/models/operations/deletesavedviewrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/deletesavedviewresponse.md b/entity/docs/models/operations/deletesavedviewresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/deleteschemarequest.md b/entity/docs/models/operations/deleteschemarequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/deleteschemaresponse.md b/entity/docs/models/operations/deleteschemaresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/exportentitiesrequest.md b/entity/docs/models/operations/exportentitiesrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/exportentitiesresponse.md b/entity/docs/models/operations/exportentitiesresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getactivityrequest.md b/entity/docs/models/operations/getactivityrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getactivityresponse.md b/entity/docs/models/operations/getactivityresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getentity200applicationjson.md b/entity/docs/models/operations/getentity200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getentityactivityfeed200applicationjson.md b/entity/docs/models/operations/getentityactivityfeed200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getentityactivityfeedrequest.md b/entity/docs/models/operations/getentityactivityfeedrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getentityactivityfeedresponse.md b/entity/docs/models/operations/getentityactivityfeedresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getentityrequest.md b/entity/docs/models/operations/getentityrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getentityresponse.md b/entity/docs/models/operations/getentityresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getrelationsrequest.md b/entity/docs/models/operations/getrelationsrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getrelationsresponse.md b/entity/docs/models/operations/getrelationsresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getrelationsv2request.md b/entity/docs/models/operations/getrelationsv2request.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getrelationsv2response.md b/entity/docs/models/operations/getrelationsv2response.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getsavedview200applicationjson.md b/entity/docs/models/operations/getsavedview200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getsavedviewrequest.md b/entity/docs/models/operations/getsavedviewrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getsavedviewresponse.md b/entity/docs/models/operations/getsavedviewresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getschemarequest.md b/entity/docs/models/operations/getschemarequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getschemaresponse.md b/entity/docs/models/operations/getschemaresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getschemaversions200applicationjson.md b/entity/docs/models/operations/getschemaversions200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getschemaversionsrequest.md b/entity/docs/models/operations/getschemaversionsrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/getschemaversionsresponse.md b/entity/docs/models/operations/getschemaversionsresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/gettaxonomyrequest.md b/entity/docs/models/operations/gettaxonomyrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/gettaxonomyresponse.md b/entity/docs/models/operations/gettaxonomyresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/importentitiesrequest.md b/entity/docs/models/operations/importentitiesrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/importentitiesresponse.md b/entity/docs/models/operations/importentitiesresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listsavedviews200applicationjson.md b/entity/docs/models/operations/listsavedviews200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listsavedviewsresponse.md b/entity/docs/models/operations/listsavedviewsresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listschemablueprints200applicationjson.md b/entity/docs/models/operations/listschemablueprints200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listschemablueprintsresponse.md b/entity/docs/models/operations/listschemablueprintsresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listschemas200applicationjson.md b/entity/docs/models/operations/listschemas200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listschemasrequest.md b/entity/docs/models/operations/listschemasrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listschemasresponse.md b/entity/docs/models/operations/listschemasresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listtaxonomies200applicationjson.md b/entity/docs/models/operations/listtaxonomies200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listtaxonomiesresponse.md b/entity/docs/models/operations/listtaxonomiesresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md b/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/patchentityrequest.md b/entity/docs/models/operations/patchentityrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/patchentityresponse.md b/entity/docs/models/operations/patchentityresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/putschemarequest.md b/entity/docs/models/operations/putschemarequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/putschemaresponse.md b/entity/docs/models/operations/putschemaresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/searchentitiesresponse.md b/entity/docs/models/operations/searchentitiesresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md b/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md b/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md b/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md b/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md b/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/taxonomyautocompleterequest.md b/entity/docs/models/operations/taxonomyautocompleterequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/taxonomyautocompleteresponse.md b/entity/docs/models/operations/taxonomyautocompleteresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md b/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md b/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updateentityrequest.md b/entity/docs/models/operations/updateentityrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updateentityresponse.md b/entity/docs/models/operations/updateentityresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updaterelationrequest.md b/entity/docs/models/operations/updaterelationrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updaterelationrequestbody.md b/entity/docs/models/operations/updaterelationrequestbody.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updaterelationresponse.md b/entity/docs/models/operations/updaterelationresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updatesavedviewrequest.md b/entity/docs/models/operations/updatesavedviewrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/updatesavedviewresponse.md b/entity/docs/models/operations/updatesavedviewresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/upsertentityrequest.md b/entity/docs/models/operations/upsertentityrequest.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/upsertentityrequestbody.md b/entity/docs/models/operations/upsertentityrequestbody.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/operations/upsertentityresponse.md b/entity/docs/models/operations/upsertentityresponse.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/activity.md b/entity/docs/models/shared/activity.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/activityitem.md b/entity/docs/models/shared/activityitem.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/addressrelationattribute.md b/entity/docs/models/shared/addressrelationattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/addressrelationattributeconstraints.md b/entity/docs/models/shared/addressrelationattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/addressrelationattributeinfohelpers.md b/entity/docs/models/shared/addressrelationattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/addressrelationattributetype.md b/entity/docs/models/shared/addressrelationattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/automationattribute.md b/entity/docs/models/shared/automationattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/automationattributeconstraints.md b/entity/docs/models/shared/automationattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/automationattributeinfohelpers.md b/entity/docs/models/shared/automationattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/automationattributetype.md b/entity/docs/models/shared/automationattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/booleanattribute.md b/entity/docs/models/shared/booleanattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/booleanattributeconstraints.md b/entity/docs/models/shared/booleanattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/booleanattributeinfohelpers.md b/entity/docs/models/shared/booleanattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/booleanattributetype.md b/entity/docs/models/shared/booleanattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/classificationsupdate.md b/entity/docs/models/shared/classificationsupdate.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/computedattribute.md b/entity/docs/models/shared/computedattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/computedattributeconstraints.md b/entity/docs/models/shared/computedattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/computedattributeinfohelpers.md b/entity/docs/models/shared/computedattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/computedattributetype.md b/entity/docs/models/shared/computedattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/consentattribute.md b/entity/docs/models/shared/consentattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/consentattributeconstraints.md b/entity/docs/models/shared/consentattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/consentattributeinfohelpers.md b/entity/docs/models/shared/consentattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/consentattributetype.md b/entity/docs/models/shared/consentattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/countryattribute.md b/entity/docs/models/shared/countryattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/countryattributeconstraints.md b/entity/docs/models/shared/countryattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/countryattributeinfohelpers.md b/entity/docs/models/shared/countryattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/countryattributetype.md b/entity/docs/models/shared/countryattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/currencyattribute.md b/entity/docs/models/shared/currencyattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/currencyattributeconstraints.md b/entity/docs/models/shared/currencyattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/currencyattributecurrency1.md b/entity/docs/models/shared/currencyattributecurrency1.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/currencyattributeinfohelpers.md b/entity/docs/models/shared/currencyattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/currencyattributetype.md b/entity/docs/models/shared/currencyattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/dateattribute.md b/entity/docs/models/shared/dateattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/dateattributeconstraints.md b/entity/docs/models/shared/dateattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/dateattributeinfohelpers.md b/entity/docs/models/shared/dateattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/dateattributetype.md b/entity/docs/models/shared/dateattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitycapability.md b/entity/docs/models/shared/entitycapability.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaultcreate.md b/entity/docs/models/shared/entitydefaultcreate.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md b/entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaultcreateviewtype.md b/entity/docs/models/shared/entitydefaultcreateviewtype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaultedit.md b/entity/docs/models/shared/entitydefaultedit.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaultedittablemenuoptions.md b/entity/docs/models/shared/entitydefaultedittablemenuoptions.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaulteditviewtype.md b/entity/docs/models/shared/entitydefaulteditviewtype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaulttable.md b/entity/docs/models/shared/entitydefaulttable.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractions.md b/entity/docs/models/shared/entitydefaulttablenavbaractions.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitydefaulttableviewtype.md b/entity/docs/models/shared/entitydefaulttableviewtype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityimportparams.md b/entity/docs/models/shared/entityimportparams.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityimportparamss3reference.md b/entity/docs/models/shared/entityimportparamss3reference.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityoperation.md b/entity/docs/models/shared/entityoperation.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityoperationdiff.md b/entity/docs/models/shared/entityoperationdiff.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityoperationoperation.md b/entity/docs/models/shared/entityoperationoperation.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityoperationparams.md b/entity/docs/models/shared/entityoperationparams.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschema.md b/entity/docs/models/shared/entityschema.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemagroupsettings.md b/entity/docs/models/shared/entityschemagroupsettings.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md b/entity/docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemaitem.md b/entity/docs/models/shared/entityschemaitem.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemaitemgroupsettings.md b/entity/docs/models/shared/entityschemaitemgroupsettings.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md b/entity/docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemaitemsource.md b/entity/docs/models/shared/entityschemaitemsource.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemaitemuiconfig.md b/entity/docs/models/shared/entityschemaitemuiconfig.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemaitemuiconfigsharing.md b/entity/docs/models/shared/entityschemaitemuiconfigsharing.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemauiconfig.md b/entity/docs/models/shared/entityschemauiconfig.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemauiconfiglistitem.md b/entity/docs/models/shared/entityschemauiconfiglistitem.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityschemauiconfigsharing.md b/entity/docs/models/shared/entityschemauiconfigsharing.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitysearchparams.md b/entity/docs/models/shared/entitysearchparams.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitysearchparamsaggs.md b/entity/docs/models/shared/entitysearchparamsaggs.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitysearchresults.md b/entity/docs/models/shared/entitysearchresults.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entitysearchresultsaggregations.md b/entity/docs/models/shared/entitysearchresultsaggregations.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityviewdisabled.md b/entity/docs/models/shared/entityviewdisabled.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/entityviewdisabledviewtype.md b/entity/docs/models/shared/entityviewdisabledviewtype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/fileattribute.md b/entity/docs/models/shared/fileattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/fileattributeconstraints.md b/entity/docs/models/shared/fileattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/fileattributedefaultaccesscontrol.md b/entity/docs/models/shared/fileattributedefaultaccesscontrol.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/fileattributeinfohelpers.md b/entity/docs/models/shared/fileattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/fileattributetype.md b/entity/docs/models/shared/fileattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/getrelationsresp.md b/entity/docs/models/shared/getrelationsresp.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/getrelationsrespwithpagination.md b/entity/docs/models/shared/getrelationsrespwithpagination.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/internalattribute.md b/entity/docs/models/shared/internalattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/internalattributeconstraints.md b/entity/docs/models/shared/internalattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/internalattributeinfohelpers.md b/entity/docs/models/shared/internalattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/internalattributetype.md b/entity/docs/models/shared/internalattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/internaluserattribute.md b/entity/docs/models/shared/internaluserattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/internaluserattributeconstraints.md b/entity/docs/models/shared/internaluserattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/internaluserattributeinfohelpers.md b/entity/docs/models/shared/internaluserattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/internaluserattributetype.md b/entity/docs/models/shared/internaluserattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/invitationemailattribute.md b/entity/docs/models/shared/invitationemailattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/invitationemailattributeconstraints.md b/entity/docs/models/shared/invitationemailattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/invitationemailattributeinfohelpers.md b/entity/docs/models/shared/invitationemailattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/invitationemailattributetype.md b/entity/docs/models/shared/invitationemailattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/linkattribute.md b/entity/docs/models/shared/linkattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/linkattributeconstraints.md b/entity/docs/models/shared/linkattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/linkattributeinfohelpers.md b/entity/docs/models/shared/linkattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/linkattributetype.md b/entity/docs/models/shared/linkattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/multiselectattribute.md b/entity/docs/models/shared/multiselectattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/multiselectattributeconstraints.md b/entity/docs/models/shared/multiselectattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/multiselectattributeinfohelpers.md b/entity/docs/models/shared/multiselectattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/multiselectattributeoptions2.md b/entity/docs/models/shared/multiselectattributeoptions2.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/multiselectattributetype.md b/entity/docs/models/shared/multiselectattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/numberattribute.md b/entity/docs/models/shared/numberattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/numberattributeconstraints.md b/entity/docs/models/shared/numberattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/numberattributeinfohelpers.md b/entity/docs/models/shared/numberattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/numberattributetype.md b/entity/docs/models/shared/numberattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/orderedlistattribute.md b/entity/docs/models/shared/orderedlistattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/orderedlistattributeconstraints.md b/entity/docs/models/shared/orderedlistattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/orderedlistattributeinfohelpers.md b/entity/docs/models/shared/orderedlistattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/orderedlistattributetype.md b/entity/docs/models/shared/orderedlistattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/partnerstatusattribute.md b/entity/docs/models/shared/partnerstatusattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/partnerstatusattributeconstraints.md b/entity/docs/models/shared/partnerstatusattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/partnerstatusattributeinfohelpers.md b/entity/docs/models/shared/partnerstatusattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/partnerstatusattributetype.md b/entity/docs/models/shared/partnerstatusattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/paymentmethodrelationattribute.md b/entity/docs/models/shared/paymentmethodrelationattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/paymentmethodrelationattributeconstraints.md b/entity/docs/models/shared/paymentmethodrelationattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/paymentmethodrelationattributeinfohelpers.md b/entity/docs/models/shared/paymentmethodrelationattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/paymentmethodrelationattributetype.md b/entity/docs/models/shared/paymentmethodrelationattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/purposeattribute.md b/entity/docs/models/shared/purposeattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/purposeattributeconstraints.md b/entity/docs/models/shared/purposeattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/purposeattributeinfohelpers.md b/entity/docs/models/shared/purposeattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/purposeattributetype.md b/entity/docs/models/shared/purposeattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/redirectentityview.md b/entity/docs/models/shared/redirectentityview.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/redirectentityviewviewtype.md b/entity/docs/models/shared/redirectentityviewviewtype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationattribute.md b/entity/docs/models/shared/relationattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationattributeactions.md b/entity/docs/models/shared/relationattributeactions.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationattributeactionsactiontype.md b/entity/docs/models/shared/relationattributeactionsactiontype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationattributeconstraints.md b/entity/docs/models/shared/relationattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationattributedrawersize.md b/entity/docs/models/shared/relationattributedrawersize.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationattributeeditmode.md b/entity/docs/models/shared/relationattributeeditmode.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationattributeinfohelpers.md b/entity/docs/models/shared/relationattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationattributerelationaffinitymode.md b/entity/docs/models/shared/relationattributerelationaffinitymode.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationattributerelationtype.md b/entity/docs/models/shared/relationattributerelationtype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationattributetype.md b/entity/docs/models/shared/relationattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/relationitem.md b/entity/docs/models/shared/relationitem.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/repeatableattribute.md b/entity/docs/models/shared/repeatableattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/repeatableattributeconstraints.md b/entity/docs/models/shared/repeatableattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/repeatableattributeinfohelpers.md b/entity/docs/models/shared/repeatableattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/repeatableattributerelationaffinitymode.md b/entity/docs/models/shared/repeatableattributerelationaffinitymode.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/repeatableattributetype.md b/entity/docs/models/shared/repeatableattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/savedview.md b/entity/docs/models/shared/savedview.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/savedviewcreatedby1.md b/entity/docs/models/shared/savedviewcreatedby1.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/savedviewitem.md b/entity/docs/models/shared/savedviewitem.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/savedviewitemcreatedby1.md b/entity/docs/models/shared/savedviewitemcreatedby1.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/searchmappings.md b/entity/docs/models/shared/searchmappings.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/searchmappingstype.md b/entity/docs/models/shared/searchmappingstype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/security.md b/entity/docs/models/shared/security.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/selectattribute.md b/entity/docs/models/shared/selectattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/selectattributeconstraints.md b/entity/docs/models/shared/selectattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/selectattributeinfohelpers.md b/entity/docs/models/shared/selectattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/selectattributeoptions1.md b/entity/docs/models/shared/selectattributeoptions1.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/selectattributetype.md b/entity/docs/models/shared/selectattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/sequenceattribute.md b/entity/docs/models/shared/sequenceattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/sequenceattributeconstraints.md b/entity/docs/models/shared/sequenceattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/sequenceattributeinfohelpers.md b/entity/docs/models/shared/sequenceattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/sequenceattributetype.md b/entity/docs/models/shared/sequenceattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/statusattribute.md b/entity/docs/models/shared/statusattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/statusattributeconstraints.md b/entity/docs/models/shared/statusattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/statusattributeinfohelpers.md b/entity/docs/models/shared/statusattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/statusattributeoptions2.md b/entity/docs/models/shared/statusattributeoptions2.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/statusattributetype.md b/entity/docs/models/shared/statusattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/summaryattribute.md b/entity/docs/models/shared/summaryattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/summaryfield.md b/entity/docs/models/shared/summaryfield.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/tagsattribute.md b/entity/docs/models/shared/tagsattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/tagsattributeconstraints.md b/entity/docs/models/shared/tagsattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/tagsattributeinfohelpers.md b/entity/docs/models/shared/tagsattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/tagsattributetype.md b/entity/docs/models/shared/tagsattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/taxonomy.md b/entity/docs/models/shared/taxonomy.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/taxonomyclassification.md b/entity/docs/models/shared/taxonomyclassification.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/textattribute.md b/entity/docs/models/shared/textattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/textattributeconstraints.md b/entity/docs/models/shared/textattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/textattributeinfohelpers.md b/entity/docs/models/shared/textattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/textattributetype.md b/entity/docs/models/shared/textattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/userrelationattribute.md b/entity/docs/models/shared/userrelationattribute.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/userrelationattributeconstraints.md b/entity/docs/models/shared/userrelationattributeconstraints.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/userrelationattributeinfohelpers.md b/entity/docs/models/shared/userrelationattributeinfohelpers.md old mode 100755 new mode 100644 diff --git a/entity/docs/models/shared/userrelationattributetype.md b/entity/docs/models/shared/userrelationattributetype.md old mode 100755 new mode 100644 diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md old mode 100755 new mode 100644 diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md old mode 100755 new mode 100644 diff --git a/entity/docs/sdks/entityimport/README.md b/entity/docs/sdks/entityimport/README.md old mode 100755 new mode 100644 diff --git a/entity/docs/sdks/epilot/README.md b/entity/docs/sdks/epilot/README.md old mode 100755 new mode 100644 diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md old mode 100755 new mode 100644 diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md old mode 100755 new mode 100644 diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md old mode 100755 new mode 100644 diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md old mode 100755 new mode 100644 diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md old mode 100755 new mode 100644 diff --git a/entity/gen.yaml b/entity/gen.yaml index 209f595a0..85cb779b9 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.62.1 - generationVersion: 2.70.2 + speakeasyVersion: 1.64.0 + generationVersion: 2.71.0 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.17.1 + version: 1.18.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/pylintrc b/entity/pylintrc old mode 100755 new mode 100644 diff --git a/entity/setup.py b/entity/setup.py old mode 100755 new mode 100644 index dbd87b773..f790f42bb --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.17.1", + version="1.18.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, @@ -19,7 +19,7 @@ install_requires=[ "certifi>=2022.12.7", "charset-normalizer>=2.1.1", - "dataclasses-json-speakeasy>=0.5.8", + "dataclasses-json>=0.5.12", "idna>=3.3", "jsonpath-python>=1.0.6 ", "marshmallow>=3.17.1", diff --git a/entity/src/epilot/__init__.py b/entity/src/epilot/__init__.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/activity.py b/entity/src/epilot/activity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/entities.py b/entity/src/epilot/entities.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/entity_import.py b/entity/src/epilot/entity_import.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/export.py b/entity/src/epilot/export.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/__init__.py b/entity/src/epilot/models/__init__.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/errors/__init__.py b/entity/src/epilot/models/errors/__init__.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/errors/sdkerror.py b/entity/src/epilot/models/errors/sdkerror.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/__init__.py b/entity/src/epilot/models/operations/__init__.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/addrelations.py b/entity/src/epilot/models/operations/addrelations.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/attachactivity.py b/entity/src/epilot/models/operations/attachactivity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/autocomplete.py b/entity/src/epilot/models/operations/autocomplete.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/createactivity.py b/entity/src/epilot/models/operations/createactivity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/createentity.py b/entity/src/epilot/models/operations/createentity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/createsavedview.py b/entity/src/epilot/models/operations/createsavedview.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/deleteentity.py b/entity/src/epilot/models/operations/deleteentity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/deleterelation.py b/entity/src/epilot/models/operations/deleterelation.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/deletesavedview.py b/entity/src/epilot/models/operations/deletesavedview.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/deleteschema.py b/entity/src/epilot/models/operations/deleteschema.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/exportentities.py b/entity/src/epilot/models/operations/exportentities.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/getactivity.py b/entity/src/epilot/models/operations/getactivity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/getentity.py b/entity/src/epilot/models/operations/getentity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/getentityactivityfeed.py b/entity/src/epilot/models/operations/getentityactivityfeed.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/getrelationsv2.py b/entity/src/epilot/models/operations/getrelationsv2.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/getsavedview.py b/entity/src/epilot/models/operations/getsavedview.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/getschema.py b/entity/src/epilot/models/operations/getschema.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/getschemaversions.py b/entity/src/epilot/models/operations/getschemaversions.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/gettaxonomy.py b/entity/src/epilot/models/operations/gettaxonomy.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/importentities.py b/entity/src/epilot/models/operations/importentities.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/listsavedviews.py b/entity/src/epilot/models/operations/listsavedviews.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/listschemablueprints.py b/entity/src/epilot/models/operations/listschemablueprints.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/listschemas.py b/entity/src/epilot/models/operations/listschemas.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/listtaxonomies.py b/entity/src/epilot/models/operations/listtaxonomies.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/patchentity.py b/entity/src/epilot/models/operations/patchentity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/putschema.py b/entity/src/epilot/models/operations/putschema.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/searchentities.py b/entity/src/epilot/models/operations/searchentities.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py b/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/taxonomyautocomplete.py b/entity/src/epilot/models/operations/taxonomyautocomplete.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py b/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/updateentity.py b/entity/src/epilot/models/operations/updateentity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/updaterelation.py b/entity/src/epilot/models/operations/updaterelation.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/updatesavedview.py b/entity/src/epilot/models/operations/updatesavedview.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/operations/upsertentity.py b/entity/src/epilot/models/operations/upsertentity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/activity.py b/entity/src/epilot/models/shared/activity.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/activityitem.py b/entity/src/epilot/models/shared/activityitem.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/addressrelationattribute.py b/entity/src/epilot/models/shared/addressrelationattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/automationattribute.py b/entity/src/epilot/models/shared/automationattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/booleanattribute.py b/entity/src/epilot/models/shared/booleanattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/classificationsupdate.py b/entity/src/epilot/models/shared/classificationsupdate.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/computedattribute.py b/entity/src/epilot/models/shared/computedattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/consentattribute.py b/entity/src/epilot/models/shared/consentattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/countryattribute.py b/entity/src/epilot/models/shared/countryattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/currencyattribute.py b/entity/src/epilot/models/shared/currencyattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/dateattribute.py b/entity/src/epilot/models/shared/dateattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entitycapability.py b/entity/src/epilot/models/shared/entitycapability.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entitydefaultcreate.py b/entity/src/epilot/models/shared/entitydefaultcreate.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entitydefaultedit.py b/entity/src/epilot/models/shared/entitydefaultedit.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entityimportparams.py b/entity/src/epilot/models/shared/entityimportparams.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entityoperation.py b/entity/src/epilot/models/shared/entityoperation.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entityschema.py b/entity/src/epilot/models/shared/entityschema.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entityschemaitem.py b/entity/src/epilot/models/shared/entityschemaitem.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entitysearchparams.py b/entity/src/epilot/models/shared/entitysearchparams.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entitysearchresults.py b/entity/src/epilot/models/shared/entitysearchresults.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/entityviewdisabled.py b/entity/src/epilot/models/shared/entityviewdisabled.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/fileattribute.py b/entity/src/epilot/models/shared/fileattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/getrelationsresp.py b/entity/src/epilot/models/shared/getrelationsresp.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/internalattribute.py b/entity/src/epilot/models/shared/internalattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/internaluserattribute.py b/entity/src/epilot/models/shared/internaluserattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/invitationemailattribute.py b/entity/src/epilot/models/shared/invitationemailattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/linkattribute.py b/entity/src/epilot/models/shared/linkattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/multiselectattribute.py b/entity/src/epilot/models/shared/multiselectattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/numberattribute.py b/entity/src/epilot/models/shared/numberattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/orderedlistattribute.py b/entity/src/epilot/models/shared/orderedlistattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/partnerstatusattribute.py b/entity/src/epilot/models/shared/partnerstatusattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/purposeattribute.py b/entity/src/epilot/models/shared/purposeattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/redirectentityview.py b/entity/src/epilot/models/shared/redirectentityview.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/relationitem.py b/entity/src/epilot/models/shared/relationitem.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/repeatableattribute.py b/entity/src/epilot/models/shared/repeatableattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/savedview.py b/entity/src/epilot/models/shared/savedview.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/savedviewitem.py b/entity/src/epilot/models/shared/savedviewitem.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/searchmappings.py b/entity/src/epilot/models/shared/searchmappings.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/security.py b/entity/src/epilot/models/shared/security.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/selectattribute.py b/entity/src/epilot/models/shared/selectattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/sequenceattribute.py b/entity/src/epilot/models/shared/sequenceattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/summaryattribute.py b/entity/src/epilot/models/shared/summaryattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/summaryfield.py b/entity/src/epilot/models/shared/summaryfield.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/tagsattribute.py b/entity/src/epilot/models/shared/tagsattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/taxonomy.py b/entity/src/epilot/models/shared/taxonomy.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/taxonomyclassification.py b/entity/src/epilot/models/shared/taxonomyclassification.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/textattribute.py b/entity/src/epilot/models/shared/textattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/models/shared/userrelationattribute.py b/entity/src/epilot/models/shared/userrelationattribute.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/saved_views.py b/entity/src/epilot/saved_views.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/schemas.py b/entity/src/epilot/schemas.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/sdk.py b/entity/src/epilot/sdk.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py old mode 100755 new mode 100644 index c15edc426..5c5cfd75f --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.17.1' - gen_version: str = '2.70.2' + sdk_version: str = '1.18.0' + gen_version: str = '2.71.0' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: diff --git a/entity/src/epilot/taxonomy.py b/entity/src/epilot/taxonomy.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/utils/__init__.py b/entity/src/epilot/utils/__init__.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/utils/retries.py b/entity/src/epilot/utils/retries.py old mode 100755 new mode 100644 diff --git a/entity/src/epilot/utils/utils.py b/entity/src/epilot/utils/utils.py old mode 100755 new mode 100644 From e087a2c713cc8f3cdd2211369049825cc85d57c7 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 26 Jul 2023 01:38:26 +0000 Subject: [PATCH 23/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.0 --- entity/RELEASES.md | 8 +++++++- entity/USAGE.md | 0 entity/docs/models/operations/addrelationsrequest.md | 0 entity/docs/models/operations/addrelationsresponse.md | 0 entity/docs/models/operations/attachactivityrequest.md | 0 entity/docs/models/operations/attachactivityresponse.md | 0 .../models/operations/autocomplete200applicationjson.md | 0 entity/docs/models/operations/autocompleterequest.md | 0 entity/docs/models/operations/autocompleteresponse.md | 0 entity/docs/models/operations/createactivityrequest.md | 0 entity/docs/models/operations/createactivityresponse.md | 0 entity/docs/models/operations/createentityrequest.md | 0 entity/docs/models/operations/createentityresponse.md | 0 entity/docs/models/operations/createsavedviewresponse.md | 0 entity/docs/models/operations/deleteentityrequest.md | 0 entity/docs/models/operations/deleteentityresponse.md | 0 entity/docs/models/operations/deleterelationrequest.md | 0 entity/docs/models/operations/deleterelationresponse.md | 0 entity/docs/models/operations/deletesavedviewrequest.md | 0 entity/docs/models/operations/deletesavedviewresponse.md | 0 entity/docs/models/operations/deleteschemarequest.md | 0 entity/docs/models/operations/deleteschemaresponse.md | 0 entity/docs/models/operations/exportentitiesrequest.md | 0 entity/docs/models/operations/exportentitiesresponse.md | 0 entity/docs/models/operations/getactivityrequest.md | 0 entity/docs/models/operations/getactivityresponse.md | 0 .../docs/models/operations/getentity200applicationjson.md | 0 .../operations/getentityactivityfeed200applicationjson.md | 0 .../models/operations/getentityactivityfeedrequest.md | 0 .../models/operations/getentityactivityfeedresponse.md | 0 entity/docs/models/operations/getentityrequest.md | 0 entity/docs/models/operations/getentityresponse.md | 0 entity/docs/models/operations/getrelationsrequest.md | 0 entity/docs/models/operations/getrelationsresponse.md | 0 entity/docs/models/operations/getrelationsv2request.md | 0 entity/docs/models/operations/getrelationsv2response.md | 0 .../models/operations/getsavedview200applicationjson.md | 0 entity/docs/models/operations/getsavedviewrequest.md | 0 entity/docs/models/operations/getsavedviewresponse.md | 0 entity/docs/models/operations/getschemarequest.md | 0 entity/docs/models/operations/getschemaresponse.md | 0 .../operations/getschemaversions200applicationjson.md | 0 entity/docs/models/operations/getschemaversionsrequest.md | 0 .../docs/models/operations/getschemaversionsresponse.md | 0 entity/docs/models/operations/gettaxonomyrequest.md | 0 entity/docs/models/operations/gettaxonomyresponse.md | 0 entity/docs/models/operations/importentitiesrequest.md | 0 entity/docs/models/operations/importentitiesresponse.md | 0 .../models/operations/listsavedviews200applicationjson.md | 0 entity/docs/models/operations/listsavedviewsresponse.md | 0 .../operations/listschemablueprints200applicationjson.md | 0 .../models/operations/listschemablueprintsresponse.md | 0 .../models/operations/listschemas200applicationjson.md | 0 entity/docs/models/operations/listschemasrequest.md | 0 entity/docs/models/operations/listschemasresponse.md | 0 .../models/operations/listtaxonomies200applicationjson.md | 0 entity/docs/models/operations/listtaxonomiesresponse.md | 0 ...ttaxonomyclassificationsforschema200applicationjson.md | 0 .../listtaxonomyclassificationsforschemarequest.md | 0 .../listtaxonomyclassificationsforschemaresponse.md | 0 entity/docs/models/operations/patchentityrequest.md | 0 entity/docs/models/operations/patchentityresponse.md | 0 entity/docs/models/operations/putschemarequest.md | 0 entity/docs/models/operations/putschemaresponse.md | 0 entity/docs/models/operations/searchentitiesresponse.md | 0 .../taxonomiesclassificationssearch200applicationjson.md | 0 .../operations/taxonomiesclassificationssearchrequest.md | 0 .../taxonomiesclassificationssearchrequestbody.md | 0 .../operations/taxonomiesclassificationssearchresponse.md | 0 .../operations/taxonomyautocomplete200applicationjson.md | 0 .../docs/models/operations/taxonomyautocompleterequest.md | 0 .../models/operations/taxonomyautocompleteresponse.md | 0 .../updateclassificationsfortaxonomy200applicationjson.md | 0 ...classificationsfortaxonomy200applicationjsondeleted.md | 0 .../operations/updateclassificationsfortaxonomyrequest.md | 0 .../updateclassificationsfortaxonomyresponse.md | 0 entity/docs/models/operations/updateentityrequest.md | 0 entity/docs/models/operations/updateentityresponse.md | 0 entity/docs/models/operations/updaterelationrequest.md | 0 .../docs/models/operations/updaterelationrequestbody.md | 0 entity/docs/models/operations/updaterelationresponse.md | 0 entity/docs/models/operations/updatesavedviewrequest.md | 0 entity/docs/models/operations/updatesavedviewresponse.md | 0 entity/docs/models/operations/upsertentityrequest.md | 0 entity/docs/models/operations/upsertentityrequestbody.md | 0 entity/docs/models/operations/upsertentityresponse.md | 0 entity/docs/models/shared/activity.md | 0 entity/docs/models/shared/activityitem.md | 0 entity/docs/models/shared/addressrelationattribute.md | 0 .../models/shared/addressrelationattributeconstraints.md | 0 .../models/shared/addressrelationattributeinfohelpers.md | 0 entity/docs/models/shared/addressrelationattributetype.md | 0 entity/docs/models/shared/automationattribute.md | 0 .../docs/models/shared/automationattributeconstraints.md | 0 .../docs/models/shared/automationattributeinfohelpers.md | 0 entity/docs/models/shared/automationattributetype.md | 0 entity/docs/models/shared/booleanattribute.md | 0 entity/docs/models/shared/booleanattributeconstraints.md | 0 entity/docs/models/shared/booleanattributeinfohelpers.md | 0 entity/docs/models/shared/booleanattributetype.md | 0 entity/docs/models/shared/classificationsupdate.md | 0 entity/docs/models/shared/computedattribute.md | 0 entity/docs/models/shared/computedattributeconstraints.md | 0 entity/docs/models/shared/computedattributeinfohelpers.md | 0 entity/docs/models/shared/computedattributetype.md | 0 entity/docs/models/shared/consentattribute.md | 0 entity/docs/models/shared/consentattributeconstraints.md | 0 entity/docs/models/shared/consentattributeinfohelpers.md | 0 entity/docs/models/shared/consentattributetype.md | 0 entity/docs/models/shared/countryattribute.md | 0 entity/docs/models/shared/countryattributeconstraints.md | 0 entity/docs/models/shared/countryattributeinfohelpers.md | 0 entity/docs/models/shared/countryattributetype.md | 0 entity/docs/models/shared/currencyattribute.md | 0 entity/docs/models/shared/currencyattributeconstraints.md | 0 entity/docs/models/shared/currencyattributecurrency1.md | 0 entity/docs/models/shared/currencyattributeinfohelpers.md | 0 entity/docs/models/shared/currencyattributetype.md | 0 entity/docs/models/shared/dateattribute.md | 0 entity/docs/models/shared/dateattributeconstraints.md | 0 entity/docs/models/shared/dateattributeinfohelpers.md | 0 entity/docs/models/shared/dateattributetype.md | 0 entity/docs/models/shared/entitycapability.md | 0 entity/docs/models/shared/entitydefaultcreate.md | 0 .../models/shared/entitydefaultcreatetablemenuoptions.md | 0 entity/docs/models/shared/entitydefaultcreateviewtype.md | 0 entity/docs/models/shared/entitydefaultedit.md | 0 .../models/shared/entitydefaultedittablemenuoptions.md | 0 entity/docs/models/shared/entitydefaulteditviewtype.md | 0 entity/docs/models/shared/entitydefaulttable.md | 0 .../models/shared/entitydefaulttabledropdownitems1.md | 0 .../models/shared/entitydefaulttabledropdownitems1type.md | 0 .../models/shared/entitydefaulttabledropdownitems2.md | 0 .../models/shared/entitydefaulttabledropdownitems2type.md | 0 .../docs/models/shared/entitydefaulttablenavbaractions.md | 0 .../shared/entitydefaulttablenavbaractionsoptions.md | 0 .../entitydefaulttablenavbaractionsoptionsparams.md | 0 entity/docs/models/shared/entitydefaulttableviewtype.md | 0 entity/docs/models/shared/entityimportparams.md | 0 .../docs/models/shared/entityimportparamss3reference.md | 0 entity/docs/models/shared/entityoperation.md | 0 entity/docs/models/shared/entityoperationdiff.md | 0 entity/docs/models/shared/entityoperationoperation.md | 0 entity/docs/models/shared/entityoperationparams.md | 0 entity/docs/models/shared/entityschema.md | 0 entity/docs/models/shared/entityschemagroupsettings.md | 0 .../shared/entityschemagroupsettingsinfotooltiptitle.md | 0 entity/docs/models/shared/entityschemaitem.md | 0 .../docs/models/shared/entityschemaitemgroupsettings.md | 0 .../entityschemaitemgroupsettingsinfotooltiptitle.md | 0 entity/docs/models/shared/entityschemaitemsource.md | 0 entity/docs/models/shared/entityschemaitemuiconfig.md | 0 .../models/shared/entityschemaitemuiconfiglistitem.md | 0 .../docs/models/shared/entityschemaitemuiconfigsharing.md | 0 entity/docs/models/shared/entityschemauiconfig.md | 0 entity/docs/models/shared/entityschemauiconfiglistitem.md | 0 entity/docs/models/shared/entityschemauiconfigsharing.md | 0 entity/docs/models/shared/entitysearchparams.md | 0 entity/docs/models/shared/entitysearchparamsaggs.md | 0 entity/docs/models/shared/entitysearchresults.md | 0 .../docs/models/shared/entitysearchresultsaggregations.md | 0 entity/docs/models/shared/entityviewdisabled.md | 0 entity/docs/models/shared/entityviewdisabledviewtype.md | 0 entity/docs/models/shared/fileattribute.md | 0 entity/docs/models/shared/fileattributeconstraints.md | 0 .../models/shared/fileattributedefaultaccesscontrol.md | 0 entity/docs/models/shared/fileattributeinfohelpers.md | 0 entity/docs/models/shared/fileattributetype.md | 0 entity/docs/models/shared/getrelationsresp.md | 0 .../docs/models/shared/getrelationsrespwithpagination.md | 0 entity/docs/models/shared/internalattribute.md | 0 entity/docs/models/shared/internalattributeconstraints.md | 0 entity/docs/models/shared/internalattributeinfohelpers.md | 0 entity/docs/models/shared/internalattributetype.md | 0 entity/docs/models/shared/internaluserattribute.md | 0 .../models/shared/internaluserattributeconstraints.md | 0 .../models/shared/internaluserattributeinfohelpers.md | 0 entity/docs/models/shared/internaluserattributetype.md | 0 entity/docs/models/shared/invitationemailattribute.md | 0 .../models/shared/invitationemailattributeconstraints.md | 0 .../models/shared/invitationemailattributeinfohelpers.md | 0 entity/docs/models/shared/invitationemailattributetype.md | 0 entity/docs/models/shared/linkattribute.md | 0 entity/docs/models/shared/linkattributeconstraints.md | 0 entity/docs/models/shared/linkattributeinfohelpers.md | 0 entity/docs/models/shared/linkattributetype.md | 0 entity/docs/models/shared/multiselectattribute.md | 0 .../docs/models/shared/multiselectattributeconstraints.md | 0 .../docs/models/shared/multiselectattributeinfohelpers.md | 0 entity/docs/models/shared/multiselectattributeoptions2.md | 0 entity/docs/models/shared/multiselectattributetype.md | 0 entity/docs/models/shared/numberattribute.md | 0 entity/docs/models/shared/numberattributeconstraints.md | 0 entity/docs/models/shared/numberattributeinfohelpers.md | 0 entity/docs/models/shared/numberattributetype.md | 0 entity/docs/models/shared/orderedlistattribute.md | 0 .../docs/models/shared/orderedlistattributeconstraints.md | 0 .../docs/models/shared/orderedlistattributeinfohelpers.md | 0 entity/docs/models/shared/orderedlistattributetype.md | 0 entity/docs/models/shared/partnerstatusattribute.md | 0 .../models/shared/partnerstatusattributeconstraints.md | 0 .../models/shared/partnerstatusattributeinfohelpers.md | 0 entity/docs/models/shared/partnerstatusattributetype.md | 0 .../docs/models/shared/paymentmethodrelationattribute.md | 0 .../shared/paymentmethodrelationattributeconstraints.md | 0 .../shared/paymentmethodrelationattributeinfohelpers.md | 0 .../models/shared/paymentmethodrelationattributetype.md | 0 entity/docs/models/shared/purposeattribute.md | 0 entity/docs/models/shared/purposeattributeconstraints.md | 0 entity/docs/models/shared/purposeattributeinfohelpers.md | 0 entity/docs/models/shared/purposeattributetype.md | 0 entity/docs/models/shared/redirectentityview.md | 0 entity/docs/models/shared/redirectentityviewviewtype.md | 0 entity/docs/models/shared/relationattribute.md | 0 entity/docs/models/shared/relationattributeactions.md | 0 .../models/shared/relationattributeactionsactiontype.md | 0 entity/docs/models/shared/relationattributeconstraints.md | 0 entity/docs/models/shared/relationattributedrawersize.md | 0 entity/docs/models/shared/relationattributeeditmode.md | 0 entity/docs/models/shared/relationattributeinfohelpers.md | 0 .../shared/relationattributerelationaffinitymode.md | 0 .../docs/models/shared/relationattributerelationtype.md | 0 entity/docs/models/shared/relationattributetype.md | 0 entity/docs/models/shared/relationitem.md | 0 entity/docs/models/shared/repeatableattribute.md | 0 .../docs/models/shared/repeatableattributeconstraints.md | 0 .../docs/models/shared/repeatableattributeinfohelpers.md | 0 .../shared/repeatableattributerelationaffinitymode.md | 0 entity/docs/models/shared/repeatableattributetype.md | 0 entity/docs/models/shared/savedview.md | 0 entity/docs/models/shared/savedviewcreatedby1.md | 0 entity/docs/models/shared/savedviewitem.md | 0 entity/docs/models/shared/savedviewitemcreatedby1.md | 0 entity/docs/models/shared/searchmappings.md | 0 entity/docs/models/shared/searchmappingstype.md | 0 entity/docs/models/shared/security.md | 0 entity/docs/models/shared/selectattribute.md | 0 entity/docs/models/shared/selectattributeconstraints.md | 0 entity/docs/models/shared/selectattributeinfohelpers.md | 0 entity/docs/models/shared/selectattributeoptions1.md | 0 entity/docs/models/shared/selectattributetype.md | 0 entity/docs/models/shared/sequenceattribute.md | 0 entity/docs/models/shared/sequenceattributeconstraints.md | 0 entity/docs/models/shared/sequenceattributeinfohelpers.md | 0 entity/docs/models/shared/sequenceattributetype.md | 0 entity/docs/models/shared/statusattribute.md | 0 entity/docs/models/shared/statusattributeconstraints.md | 0 entity/docs/models/shared/statusattributeinfohelpers.md | 0 entity/docs/models/shared/statusattributeoptions2.md | 0 entity/docs/models/shared/statusattributetype.md | 0 entity/docs/models/shared/summaryattribute.md | 0 entity/docs/models/shared/summaryfield.md | 0 entity/docs/models/shared/tagsattribute.md | 0 entity/docs/models/shared/tagsattributeconstraints.md | 0 entity/docs/models/shared/tagsattributeinfohelpers.md | 0 entity/docs/models/shared/tagsattributetype.md | 0 entity/docs/models/shared/taxonomy.md | 0 entity/docs/models/shared/taxonomyclassification.md | 0 entity/docs/models/shared/textattribute.md | 0 entity/docs/models/shared/textattributeconstraints.md | 0 entity/docs/models/shared/textattributeinfohelpers.md | 0 entity/docs/models/shared/textattributetype.md | 0 entity/docs/models/shared/userrelationattribute.md | 0 .../models/shared/userrelationattributeconstraints.md | 0 .../models/shared/userrelationattributeinfohelpers.md | 0 entity/docs/models/shared/userrelationattributetype.md | 0 entity/docs/sdks/activity/README.md | 0 entity/docs/sdks/entities/README.md | 0 entity/docs/sdks/entityimport/README.md | 0 entity/docs/sdks/epilot/README.md | 0 entity/docs/sdks/export/README.md | 0 entity/docs/sdks/relations/README.md | 0 entity/docs/sdks/savedviews/README.md | 0 entity/docs/sdks/schemas/README.md | 0 entity/docs/sdks/taxonomy/README.md | 0 entity/gen.yaml | 6 +++--- entity/pylintrc | 0 entity/setup.py | 2 +- entity/src/epilot/__init__.py | 0 entity/src/epilot/activity.py | 0 entity/src/epilot/entities.py | 0 entity/src/epilot/entity_import.py | 0 entity/src/epilot/export.py | 0 entity/src/epilot/models/__init__.py | 0 entity/src/epilot/models/errors/__init__.py | 0 entity/src/epilot/models/errors/sdkerror.py | 0 entity/src/epilot/models/operations/__init__.py | 0 entity/src/epilot/models/operations/addrelations.py | 0 entity/src/epilot/models/operations/attachactivity.py | 0 entity/src/epilot/models/operations/autocomplete.py | 0 entity/src/epilot/models/operations/createactivity.py | 0 entity/src/epilot/models/operations/createentity.py | 0 entity/src/epilot/models/operations/createsavedview.py | 0 entity/src/epilot/models/operations/deleteentity.py | 0 entity/src/epilot/models/operations/deleterelation.py | 0 entity/src/epilot/models/operations/deletesavedview.py | 0 entity/src/epilot/models/operations/deleteschema.py | 0 entity/src/epilot/models/operations/exportentities.py | 0 entity/src/epilot/models/operations/getactivity.py | 0 entity/src/epilot/models/operations/getentity.py | 0 .../src/epilot/models/operations/getentityactivityfeed.py | 0 entity/src/epilot/models/operations/getrelations.py | 0 entity/src/epilot/models/operations/getrelationsv2.py | 0 entity/src/epilot/models/operations/getsavedview.py | 0 entity/src/epilot/models/operations/getschema.py | 0 entity/src/epilot/models/operations/getschemaversions.py | 0 entity/src/epilot/models/operations/gettaxonomy.py | 0 entity/src/epilot/models/operations/importentities.py | 0 entity/src/epilot/models/operations/listsavedviews.py | 0 .../src/epilot/models/operations/listschemablueprints.py | 0 entity/src/epilot/models/operations/listschemas.py | 0 entity/src/epilot/models/operations/listtaxonomies.py | 0 .../operations/listtaxonomyclassificationsforschema.py | 0 entity/src/epilot/models/operations/patchentity.py | 0 entity/src/epilot/models/operations/putschema.py | 0 entity/src/epilot/models/operations/searchentities.py | 0 .../models/operations/taxonomiesclassificationssearch.py | 0 .../src/epilot/models/operations/taxonomyautocomplete.py | 0 .../models/operations/updateclassificationsfortaxonomy.py | 0 entity/src/epilot/models/operations/updateentity.py | 0 entity/src/epilot/models/operations/updaterelation.py | 0 entity/src/epilot/models/operations/updatesavedview.py | 0 entity/src/epilot/models/operations/upsertentity.py | 0 entity/src/epilot/models/shared/__init__.py | 0 entity/src/epilot/models/shared/activity.py | 0 entity/src/epilot/models/shared/activityitem.py | 0 .../src/epilot/models/shared/addressrelationattribute.py | 0 entity/src/epilot/models/shared/automationattribute.py | 0 entity/src/epilot/models/shared/booleanattribute.py | 0 entity/src/epilot/models/shared/classificationsupdate.py | 0 entity/src/epilot/models/shared/computedattribute.py | 0 entity/src/epilot/models/shared/consentattribute.py | 0 entity/src/epilot/models/shared/countryattribute.py | 0 entity/src/epilot/models/shared/currencyattribute.py | 0 entity/src/epilot/models/shared/dateattribute.py | 0 entity/src/epilot/models/shared/entitycapability.py | 0 entity/src/epilot/models/shared/entitydefaultcreate.py | 0 entity/src/epilot/models/shared/entitydefaultedit.py | 0 entity/src/epilot/models/shared/entitydefaulttable.py | 0 entity/src/epilot/models/shared/entityimportparams.py | 0 entity/src/epilot/models/shared/entityoperation.py | 0 entity/src/epilot/models/shared/entityschema.py | 0 entity/src/epilot/models/shared/entityschemaitem.py | 0 entity/src/epilot/models/shared/entitysearchparams.py | 0 entity/src/epilot/models/shared/entitysearchresults.py | 0 entity/src/epilot/models/shared/entityviewdisabled.py | 0 entity/src/epilot/models/shared/fileattribute.py | 0 entity/src/epilot/models/shared/getrelationsresp.py | 0 .../models/shared/getrelationsrespwithpagination.py | 0 entity/src/epilot/models/shared/internalattribute.py | 0 entity/src/epilot/models/shared/internaluserattribute.py | 0 .../src/epilot/models/shared/invitationemailattribute.py | 0 entity/src/epilot/models/shared/linkattribute.py | 0 entity/src/epilot/models/shared/multiselectattribute.py | 0 entity/src/epilot/models/shared/numberattribute.py | 0 entity/src/epilot/models/shared/orderedlistattribute.py | 0 entity/src/epilot/models/shared/partnerstatusattribute.py | 0 .../models/shared/paymentmethodrelationattribute.py | 0 entity/src/epilot/models/shared/purposeattribute.py | 0 entity/src/epilot/models/shared/redirectentityview.py | 0 entity/src/epilot/models/shared/relationattribute.py | 0 entity/src/epilot/models/shared/relationitem.py | 0 entity/src/epilot/models/shared/repeatableattribute.py | 0 entity/src/epilot/models/shared/savedview.py | 0 entity/src/epilot/models/shared/savedviewitem.py | 0 entity/src/epilot/models/shared/searchmappings.py | 0 entity/src/epilot/models/shared/security.py | 0 entity/src/epilot/models/shared/selectattribute.py | 0 entity/src/epilot/models/shared/sequenceattribute.py | 0 entity/src/epilot/models/shared/statusattribute.py | 0 entity/src/epilot/models/shared/summaryattribute.py | 0 entity/src/epilot/models/shared/summaryfield.py | 0 entity/src/epilot/models/shared/tagsattribute.py | 0 entity/src/epilot/models/shared/taxonomy.py | 0 entity/src/epilot/models/shared/taxonomyclassification.py | 0 entity/src/epilot/models/shared/textattribute.py | 0 entity/src/epilot/models/shared/userrelationattribute.py | 0 entity/src/epilot/relations.py | 0 entity/src/epilot/saved_views.py | 0 entity/src/epilot/schemas.py | 0 entity/src/epilot/sdk.py | 0 entity/src/epilot/sdkconfiguration.py | 4 ++-- entity/src/epilot/taxonomy.py | 0 entity/src/epilot/utils/__init__.py | 0 entity/src/epilot/utils/retries.py | 0 entity/src/epilot/utils/utils.py | 0 386 files changed, 13 insertions(+), 7 deletions(-) mode change 100644 => 100755 entity/USAGE.md mode change 100644 => 100755 entity/docs/models/operations/addrelationsrequest.md mode change 100644 => 100755 entity/docs/models/operations/addrelationsresponse.md mode change 100644 => 100755 entity/docs/models/operations/attachactivityrequest.md mode change 100644 => 100755 entity/docs/models/operations/attachactivityresponse.md mode change 100644 => 100755 entity/docs/models/operations/autocomplete200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/autocompleterequest.md mode change 100644 => 100755 entity/docs/models/operations/autocompleteresponse.md mode change 100644 => 100755 entity/docs/models/operations/createactivityrequest.md mode change 100644 => 100755 entity/docs/models/operations/createactivityresponse.md mode change 100644 => 100755 entity/docs/models/operations/createentityrequest.md mode change 100644 => 100755 entity/docs/models/operations/createentityresponse.md mode change 100644 => 100755 entity/docs/models/operations/createsavedviewresponse.md mode change 100644 => 100755 entity/docs/models/operations/deleteentityrequest.md mode change 100644 => 100755 entity/docs/models/operations/deleteentityresponse.md mode change 100644 => 100755 entity/docs/models/operations/deleterelationrequest.md mode change 100644 => 100755 entity/docs/models/operations/deleterelationresponse.md mode change 100644 => 100755 entity/docs/models/operations/deletesavedviewrequest.md mode change 100644 => 100755 entity/docs/models/operations/deletesavedviewresponse.md mode change 100644 => 100755 entity/docs/models/operations/deleteschemarequest.md mode change 100644 => 100755 entity/docs/models/operations/deleteschemaresponse.md mode change 100644 => 100755 entity/docs/models/operations/exportentitiesrequest.md mode change 100644 => 100755 entity/docs/models/operations/exportentitiesresponse.md mode change 100644 => 100755 entity/docs/models/operations/getactivityrequest.md mode change 100644 => 100755 entity/docs/models/operations/getactivityresponse.md mode change 100644 => 100755 entity/docs/models/operations/getentity200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/getentityactivityfeed200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/getentityactivityfeedrequest.md mode change 100644 => 100755 entity/docs/models/operations/getentityactivityfeedresponse.md mode change 100644 => 100755 entity/docs/models/operations/getentityrequest.md mode change 100644 => 100755 entity/docs/models/operations/getentityresponse.md mode change 100644 => 100755 entity/docs/models/operations/getrelationsrequest.md mode change 100644 => 100755 entity/docs/models/operations/getrelationsresponse.md mode change 100644 => 100755 entity/docs/models/operations/getrelationsv2request.md mode change 100644 => 100755 entity/docs/models/operations/getrelationsv2response.md mode change 100644 => 100755 entity/docs/models/operations/getsavedview200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/getsavedviewrequest.md mode change 100644 => 100755 entity/docs/models/operations/getsavedviewresponse.md mode change 100644 => 100755 entity/docs/models/operations/getschemarequest.md mode change 100644 => 100755 entity/docs/models/operations/getschemaresponse.md mode change 100644 => 100755 entity/docs/models/operations/getschemaversions200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/getschemaversionsrequest.md mode change 100644 => 100755 entity/docs/models/operations/getschemaversionsresponse.md mode change 100644 => 100755 entity/docs/models/operations/gettaxonomyrequest.md mode change 100644 => 100755 entity/docs/models/operations/gettaxonomyresponse.md mode change 100644 => 100755 entity/docs/models/operations/importentitiesrequest.md mode change 100644 => 100755 entity/docs/models/operations/importentitiesresponse.md mode change 100644 => 100755 entity/docs/models/operations/listsavedviews200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/listsavedviewsresponse.md mode change 100644 => 100755 entity/docs/models/operations/listschemablueprints200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/listschemablueprintsresponse.md mode change 100644 => 100755 entity/docs/models/operations/listschemas200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/listschemasrequest.md mode change 100644 => 100755 entity/docs/models/operations/listschemasresponse.md mode change 100644 => 100755 entity/docs/models/operations/listtaxonomies200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/listtaxonomiesresponse.md mode change 100644 => 100755 entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md mode change 100644 => 100755 entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md mode change 100644 => 100755 entity/docs/models/operations/patchentityrequest.md mode change 100644 => 100755 entity/docs/models/operations/patchentityresponse.md mode change 100644 => 100755 entity/docs/models/operations/putschemarequest.md mode change 100644 => 100755 entity/docs/models/operations/putschemaresponse.md mode change 100644 => 100755 entity/docs/models/operations/searchentitiesresponse.md mode change 100644 => 100755 entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/taxonomiesclassificationssearchrequest.md mode change 100644 => 100755 entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md mode change 100644 => 100755 entity/docs/models/operations/taxonomiesclassificationssearchresponse.md mode change 100644 => 100755 entity/docs/models/operations/taxonomyautocomplete200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/taxonomyautocompleterequest.md mode change 100644 => 100755 entity/docs/models/operations/taxonomyautocompleteresponse.md mode change 100644 => 100755 entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md mode change 100644 => 100755 entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md mode change 100644 => 100755 entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md mode change 100644 => 100755 entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md mode change 100644 => 100755 entity/docs/models/operations/updateentityrequest.md mode change 100644 => 100755 entity/docs/models/operations/updateentityresponse.md mode change 100644 => 100755 entity/docs/models/operations/updaterelationrequest.md mode change 100644 => 100755 entity/docs/models/operations/updaterelationrequestbody.md mode change 100644 => 100755 entity/docs/models/operations/updaterelationresponse.md mode change 100644 => 100755 entity/docs/models/operations/updatesavedviewrequest.md mode change 100644 => 100755 entity/docs/models/operations/updatesavedviewresponse.md mode change 100644 => 100755 entity/docs/models/operations/upsertentityrequest.md mode change 100644 => 100755 entity/docs/models/operations/upsertentityrequestbody.md mode change 100644 => 100755 entity/docs/models/operations/upsertentityresponse.md mode change 100644 => 100755 entity/docs/models/shared/activity.md mode change 100644 => 100755 entity/docs/models/shared/activityitem.md mode change 100644 => 100755 entity/docs/models/shared/addressrelationattribute.md mode change 100644 => 100755 entity/docs/models/shared/addressrelationattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/addressrelationattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/addressrelationattributetype.md mode change 100644 => 100755 entity/docs/models/shared/automationattribute.md mode change 100644 => 100755 entity/docs/models/shared/automationattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/automationattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/automationattributetype.md mode change 100644 => 100755 entity/docs/models/shared/booleanattribute.md mode change 100644 => 100755 entity/docs/models/shared/booleanattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/booleanattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/booleanattributetype.md mode change 100644 => 100755 entity/docs/models/shared/classificationsupdate.md mode change 100644 => 100755 entity/docs/models/shared/computedattribute.md mode change 100644 => 100755 entity/docs/models/shared/computedattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/computedattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/computedattributetype.md mode change 100644 => 100755 entity/docs/models/shared/consentattribute.md mode change 100644 => 100755 entity/docs/models/shared/consentattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/consentattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/consentattributetype.md mode change 100644 => 100755 entity/docs/models/shared/countryattribute.md mode change 100644 => 100755 entity/docs/models/shared/countryattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/countryattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/countryattributetype.md mode change 100644 => 100755 entity/docs/models/shared/currencyattribute.md mode change 100644 => 100755 entity/docs/models/shared/currencyattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/currencyattributecurrency1.md mode change 100644 => 100755 entity/docs/models/shared/currencyattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/currencyattributetype.md mode change 100644 => 100755 entity/docs/models/shared/dateattribute.md mode change 100644 => 100755 entity/docs/models/shared/dateattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/dateattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/dateattributetype.md mode change 100644 => 100755 entity/docs/models/shared/entitycapability.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaultcreate.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaultcreateviewtype.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaultedit.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaultedittablemenuoptions.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaulteditviewtype.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaulttable.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaulttabledropdownitems1.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaulttabledropdownitems1type.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaulttabledropdownitems2.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaulttabledropdownitems2type.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaulttablenavbaractions.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md mode change 100644 => 100755 entity/docs/models/shared/entitydefaulttableviewtype.md mode change 100644 => 100755 entity/docs/models/shared/entityimportparams.md mode change 100644 => 100755 entity/docs/models/shared/entityimportparamss3reference.md mode change 100644 => 100755 entity/docs/models/shared/entityoperation.md mode change 100644 => 100755 entity/docs/models/shared/entityoperationdiff.md mode change 100644 => 100755 entity/docs/models/shared/entityoperationoperation.md mode change 100644 => 100755 entity/docs/models/shared/entityoperationparams.md mode change 100644 => 100755 entity/docs/models/shared/entityschema.md mode change 100644 => 100755 entity/docs/models/shared/entityschemagroupsettings.md mode change 100644 => 100755 entity/docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md mode change 100644 => 100755 entity/docs/models/shared/entityschemaitem.md mode change 100644 => 100755 entity/docs/models/shared/entityschemaitemgroupsettings.md mode change 100644 => 100755 entity/docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md mode change 100644 => 100755 entity/docs/models/shared/entityschemaitemsource.md mode change 100644 => 100755 entity/docs/models/shared/entityschemaitemuiconfig.md mode change 100644 => 100755 entity/docs/models/shared/entityschemaitemuiconfiglistitem.md mode change 100644 => 100755 entity/docs/models/shared/entityschemaitemuiconfigsharing.md mode change 100644 => 100755 entity/docs/models/shared/entityschemauiconfig.md mode change 100644 => 100755 entity/docs/models/shared/entityschemauiconfiglistitem.md mode change 100644 => 100755 entity/docs/models/shared/entityschemauiconfigsharing.md mode change 100644 => 100755 entity/docs/models/shared/entitysearchparams.md mode change 100644 => 100755 entity/docs/models/shared/entitysearchparamsaggs.md mode change 100644 => 100755 entity/docs/models/shared/entitysearchresults.md mode change 100644 => 100755 entity/docs/models/shared/entitysearchresultsaggregations.md mode change 100644 => 100755 entity/docs/models/shared/entityviewdisabled.md mode change 100644 => 100755 entity/docs/models/shared/entityviewdisabledviewtype.md mode change 100644 => 100755 entity/docs/models/shared/fileattribute.md mode change 100644 => 100755 entity/docs/models/shared/fileattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/fileattributedefaultaccesscontrol.md mode change 100644 => 100755 entity/docs/models/shared/fileattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/fileattributetype.md mode change 100644 => 100755 entity/docs/models/shared/getrelationsresp.md mode change 100644 => 100755 entity/docs/models/shared/getrelationsrespwithpagination.md mode change 100644 => 100755 entity/docs/models/shared/internalattribute.md mode change 100644 => 100755 entity/docs/models/shared/internalattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/internalattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/internalattributetype.md mode change 100644 => 100755 entity/docs/models/shared/internaluserattribute.md mode change 100644 => 100755 entity/docs/models/shared/internaluserattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/internaluserattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/internaluserattributetype.md mode change 100644 => 100755 entity/docs/models/shared/invitationemailattribute.md mode change 100644 => 100755 entity/docs/models/shared/invitationemailattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/invitationemailattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/invitationemailattributetype.md mode change 100644 => 100755 entity/docs/models/shared/linkattribute.md mode change 100644 => 100755 entity/docs/models/shared/linkattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/linkattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/linkattributetype.md mode change 100644 => 100755 entity/docs/models/shared/multiselectattribute.md mode change 100644 => 100755 entity/docs/models/shared/multiselectattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/multiselectattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/multiselectattributeoptions2.md mode change 100644 => 100755 entity/docs/models/shared/multiselectattributetype.md mode change 100644 => 100755 entity/docs/models/shared/numberattribute.md mode change 100644 => 100755 entity/docs/models/shared/numberattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/numberattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/numberattributetype.md mode change 100644 => 100755 entity/docs/models/shared/orderedlistattribute.md mode change 100644 => 100755 entity/docs/models/shared/orderedlistattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/orderedlistattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/orderedlistattributetype.md mode change 100644 => 100755 entity/docs/models/shared/partnerstatusattribute.md mode change 100644 => 100755 entity/docs/models/shared/partnerstatusattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/partnerstatusattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/partnerstatusattributetype.md mode change 100644 => 100755 entity/docs/models/shared/paymentmethodrelationattribute.md mode change 100644 => 100755 entity/docs/models/shared/paymentmethodrelationattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/paymentmethodrelationattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/paymentmethodrelationattributetype.md mode change 100644 => 100755 entity/docs/models/shared/purposeattribute.md mode change 100644 => 100755 entity/docs/models/shared/purposeattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/purposeattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/purposeattributetype.md mode change 100644 => 100755 entity/docs/models/shared/redirectentityview.md mode change 100644 => 100755 entity/docs/models/shared/redirectentityviewviewtype.md mode change 100644 => 100755 entity/docs/models/shared/relationattribute.md mode change 100644 => 100755 entity/docs/models/shared/relationattributeactions.md mode change 100644 => 100755 entity/docs/models/shared/relationattributeactionsactiontype.md mode change 100644 => 100755 entity/docs/models/shared/relationattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/relationattributedrawersize.md mode change 100644 => 100755 entity/docs/models/shared/relationattributeeditmode.md mode change 100644 => 100755 entity/docs/models/shared/relationattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/relationattributerelationaffinitymode.md mode change 100644 => 100755 entity/docs/models/shared/relationattributerelationtype.md mode change 100644 => 100755 entity/docs/models/shared/relationattributetype.md mode change 100644 => 100755 entity/docs/models/shared/relationitem.md mode change 100644 => 100755 entity/docs/models/shared/repeatableattribute.md mode change 100644 => 100755 entity/docs/models/shared/repeatableattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/repeatableattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/repeatableattributerelationaffinitymode.md mode change 100644 => 100755 entity/docs/models/shared/repeatableattributetype.md mode change 100644 => 100755 entity/docs/models/shared/savedview.md mode change 100644 => 100755 entity/docs/models/shared/savedviewcreatedby1.md mode change 100644 => 100755 entity/docs/models/shared/savedviewitem.md mode change 100644 => 100755 entity/docs/models/shared/savedviewitemcreatedby1.md mode change 100644 => 100755 entity/docs/models/shared/searchmappings.md mode change 100644 => 100755 entity/docs/models/shared/searchmappingstype.md mode change 100644 => 100755 entity/docs/models/shared/security.md mode change 100644 => 100755 entity/docs/models/shared/selectattribute.md mode change 100644 => 100755 entity/docs/models/shared/selectattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/selectattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/selectattributeoptions1.md mode change 100644 => 100755 entity/docs/models/shared/selectattributetype.md mode change 100644 => 100755 entity/docs/models/shared/sequenceattribute.md mode change 100644 => 100755 entity/docs/models/shared/sequenceattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/sequenceattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/sequenceattributetype.md mode change 100644 => 100755 entity/docs/models/shared/statusattribute.md mode change 100644 => 100755 entity/docs/models/shared/statusattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/statusattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/statusattributeoptions2.md mode change 100644 => 100755 entity/docs/models/shared/statusattributetype.md mode change 100644 => 100755 entity/docs/models/shared/summaryattribute.md mode change 100644 => 100755 entity/docs/models/shared/summaryfield.md mode change 100644 => 100755 entity/docs/models/shared/tagsattribute.md mode change 100644 => 100755 entity/docs/models/shared/tagsattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/tagsattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/tagsattributetype.md mode change 100644 => 100755 entity/docs/models/shared/taxonomy.md mode change 100644 => 100755 entity/docs/models/shared/taxonomyclassification.md mode change 100644 => 100755 entity/docs/models/shared/textattribute.md mode change 100644 => 100755 entity/docs/models/shared/textattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/textattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/textattributetype.md mode change 100644 => 100755 entity/docs/models/shared/userrelationattribute.md mode change 100644 => 100755 entity/docs/models/shared/userrelationattributeconstraints.md mode change 100644 => 100755 entity/docs/models/shared/userrelationattributeinfohelpers.md mode change 100644 => 100755 entity/docs/models/shared/userrelationattributetype.md mode change 100644 => 100755 entity/docs/sdks/activity/README.md mode change 100644 => 100755 entity/docs/sdks/entities/README.md mode change 100644 => 100755 entity/docs/sdks/entityimport/README.md mode change 100644 => 100755 entity/docs/sdks/epilot/README.md mode change 100644 => 100755 entity/docs/sdks/export/README.md mode change 100644 => 100755 entity/docs/sdks/relations/README.md mode change 100644 => 100755 entity/docs/sdks/savedviews/README.md mode change 100644 => 100755 entity/docs/sdks/schemas/README.md mode change 100644 => 100755 entity/docs/sdks/taxonomy/README.md mode change 100644 => 100755 entity/pylintrc mode change 100644 => 100755 entity/setup.py mode change 100644 => 100755 entity/src/epilot/__init__.py mode change 100644 => 100755 entity/src/epilot/activity.py mode change 100644 => 100755 entity/src/epilot/entities.py mode change 100644 => 100755 entity/src/epilot/entity_import.py mode change 100644 => 100755 entity/src/epilot/export.py mode change 100644 => 100755 entity/src/epilot/models/__init__.py mode change 100644 => 100755 entity/src/epilot/models/errors/__init__.py mode change 100644 => 100755 entity/src/epilot/models/errors/sdkerror.py mode change 100644 => 100755 entity/src/epilot/models/operations/__init__.py mode change 100644 => 100755 entity/src/epilot/models/operations/addrelations.py mode change 100644 => 100755 entity/src/epilot/models/operations/attachactivity.py mode change 100644 => 100755 entity/src/epilot/models/operations/autocomplete.py mode change 100644 => 100755 entity/src/epilot/models/operations/createactivity.py mode change 100644 => 100755 entity/src/epilot/models/operations/createentity.py mode change 100644 => 100755 entity/src/epilot/models/operations/createsavedview.py mode change 100644 => 100755 entity/src/epilot/models/operations/deleteentity.py mode change 100644 => 100755 entity/src/epilot/models/operations/deleterelation.py mode change 100644 => 100755 entity/src/epilot/models/operations/deletesavedview.py mode change 100644 => 100755 entity/src/epilot/models/operations/deleteschema.py mode change 100644 => 100755 entity/src/epilot/models/operations/exportentities.py mode change 100644 => 100755 entity/src/epilot/models/operations/getactivity.py mode change 100644 => 100755 entity/src/epilot/models/operations/getentity.py mode change 100644 => 100755 entity/src/epilot/models/operations/getentityactivityfeed.py mode change 100644 => 100755 entity/src/epilot/models/operations/getrelations.py mode change 100644 => 100755 entity/src/epilot/models/operations/getrelationsv2.py mode change 100644 => 100755 entity/src/epilot/models/operations/getsavedview.py mode change 100644 => 100755 entity/src/epilot/models/operations/getschema.py mode change 100644 => 100755 entity/src/epilot/models/operations/getschemaversions.py mode change 100644 => 100755 entity/src/epilot/models/operations/gettaxonomy.py mode change 100644 => 100755 entity/src/epilot/models/operations/importentities.py mode change 100644 => 100755 entity/src/epilot/models/operations/listsavedviews.py mode change 100644 => 100755 entity/src/epilot/models/operations/listschemablueprints.py mode change 100644 => 100755 entity/src/epilot/models/operations/listschemas.py mode change 100644 => 100755 entity/src/epilot/models/operations/listtaxonomies.py mode change 100644 => 100755 entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py mode change 100644 => 100755 entity/src/epilot/models/operations/patchentity.py mode change 100644 => 100755 entity/src/epilot/models/operations/putschema.py mode change 100644 => 100755 entity/src/epilot/models/operations/searchentities.py mode change 100644 => 100755 entity/src/epilot/models/operations/taxonomiesclassificationssearch.py mode change 100644 => 100755 entity/src/epilot/models/operations/taxonomyautocomplete.py mode change 100644 => 100755 entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py mode change 100644 => 100755 entity/src/epilot/models/operations/updateentity.py mode change 100644 => 100755 entity/src/epilot/models/operations/updaterelation.py mode change 100644 => 100755 entity/src/epilot/models/operations/updatesavedview.py mode change 100644 => 100755 entity/src/epilot/models/operations/upsertentity.py mode change 100644 => 100755 entity/src/epilot/models/shared/__init__.py mode change 100644 => 100755 entity/src/epilot/models/shared/activity.py mode change 100644 => 100755 entity/src/epilot/models/shared/activityitem.py mode change 100644 => 100755 entity/src/epilot/models/shared/addressrelationattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/automationattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/booleanattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/classificationsupdate.py mode change 100644 => 100755 entity/src/epilot/models/shared/computedattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/consentattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/countryattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/currencyattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/dateattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/entitycapability.py mode change 100644 => 100755 entity/src/epilot/models/shared/entitydefaultcreate.py mode change 100644 => 100755 entity/src/epilot/models/shared/entitydefaultedit.py mode change 100644 => 100755 entity/src/epilot/models/shared/entitydefaulttable.py mode change 100644 => 100755 entity/src/epilot/models/shared/entityimportparams.py mode change 100644 => 100755 entity/src/epilot/models/shared/entityoperation.py mode change 100644 => 100755 entity/src/epilot/models/shared/entityschema.py mode change 100644 => 100755 entity/src/epilot/models/shared/entityschemaitem.py mode change 100644 => 100755 entity/src/epilot/models/shared/entitysearchparams.py mode change 100644 => 100755 entity/src/epilot/models/shared/entitysearchresults.py mode change 100644 => 100755 entity/src/epilot/models/shared/entityviewdisabled.py mode change 100644 => 100755 entity/src/epilot/models/shared/fileattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/getrelationsresp.py mode change 100644 => 100755 entity/src/epilot/models/shared/getrelationsrespwithpagination.py mode change 100644 => 100755 entity/src/epilot/models/shared/internalattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/internaluserattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/invitationemailattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/linkattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/multiselectattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/numberattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/orderedlistattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/partnerstatusattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/paymentmethodrelationattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/purposeattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/redirectentityview.py mode change 100644 => 100755 entity/src/epilot/models/shared/relationattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/relationitem.py mode change 100644 => 100755 entity/src/epilot/models/shared/repeatableattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/savedview.py mode change 100644 => 100755 entity/src/epilot/models/shared/savedviewitem.py mode change 100644 => 100755 entity/src/epilot/models/shared/searchmappings.py mode change 100644 => 100755 entity/src/epilot/models/shared/security.py mode change 100644 => 100755 entity/src/epilot/models/shared/selectattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/sequenceattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/statusattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/summaryattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/summaryfield.py mode change 100644 => 100755 entity/src/epilot/models/shared/tagsattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/taxonomy.py mode change 100644 => 100755 entity/src/epilot/models/shared/taxonomyclassification.py mode change 100644 => 100755 entity/src/epilot/models/shared/textattribute.py mode change 100644 => 100755 entity/src/epilot/models/shared/userrelationattribute.py mode change 100644 => 100755 entity/src/epilot/relations.py mode change 100644 => 100755 entity/src/epilot/saved_views.py mode change 100644 => 100755 entity/src/epilot/schemas.py mode change 100644 => 100755 entity/src/epilot/sdk.py mode change 100644 => 100755 entity/src/epilot/sdkconfiguration.py mode change 100644 => 100755 entity/src/epilot/taxonomy.py mode change 100644 => 100755 entity/src/epilot/utils/__init__.py mode change 100644 => 100755 entity/src/epilot/utils/retries.py mode change 100644 => 100755 entity/src/epilot/utils/utils.py diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 12597b0f5..951ad113a 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -166,4 +166,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.64.0 (2.71.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.64.0 (2.71.0) https://github.com/speakeasy-api/speakeasy + +## 2023-07-26 01:38:03 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.65.0 (2.73.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/USAGE.md b/entity/USAGE.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/addrelationsrequest.md b/entity/docs/models/operations/addrelationsrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/addrelationsresponse.md b/entity/docs/models/operations/addrelationsresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/attachactivityrequest.md b/entity/docs/models/operations/attachactivityrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/attachactivityresponse.md b/entity/docs/models/operations/attachactivityresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/autocomplete200applicationjson.md b/entity/docs/models/operations/autocomplete200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/autocompleterequest.md b/entity/docs/models/operations/autocompleterequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/autocompleteresponse.md b/entity/docs/models/operations/autocompleteresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/createactivityrequest.md b/entity/docs/models/operations/createactivityrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/createactivityresponse.md b/entity/docs/models/operations/createactivityresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/createentityrequest.md b/entity/docs/models/operations/createentityrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/createentityresponse.md b/entity/docs/models/operations/createentityresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/createsavedviewresponse.md b/entity/docs/models/operations/createsavedviewresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/deleteentityrequest.md b/entity/docs/models/operations/deleteentityrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/deleteentityresponse.md b/entity/docs/models/operations/deleteentityresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/deleterelationrequest.md b/entity/docs/models/operations/deleterelationrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/deleterelationresponse.md b/entity/docs/models/operations/deleterelationresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/deletesavedviewrequest.md b/entity/docs/models/operations/deletesavedviewrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/deletesavedviewresponse.md b/entity/docs/models/operations/deletesavedviewresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/deleteschemarequest.md b/entity/docs/models/operations/deleteschemarequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/deleteschemaresponse.md b/entity/docs/models/operations/deleteschemaresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/exportentitiesrequest.md b/entity/docs/models/operations/exportentitiesrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/exportentitiesresponse.md b/entity/docs/models/operations/exportentitiesresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getactivityrequest.md b/entity/docs/models/operations/getactivityrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getactivityresponse.md b/entity/docs/models/operations/getactivityresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getentity200applicationjson.md b/entity/docs/models/operations/getentity200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getentityactivityfeed200applicationjson.md b/entity/docs/models/operations/getentityactivityfeed200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getentityactivityfeedrequest.md b/entity/docs/models/operations/getentityactivityfeedrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getentityactivityfeedresponse.md b/entity/docs/models/operations/getentityactivityfeedresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getentityrequest.md b/entity/docs/models/operations/getentityrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getentityresponse.md b/entity/docs/models/operations/getentityresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getrelationsrequest.md b/entity/docs/models/operations/getrelationsrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getrelationsresponse.md b/entity/docs/models/operations/getrelationsresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getrelationsv2request.md b/entity/docs/models/operations/getrelationsv2request.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getrelationsv2response.md b/entity/docs/models/operations/getrelationsv2response.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getsavedview200applicationjson.md b/entity/docs/models/operations/getsavedview200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getsavedviewrequest.md b/entity/docs/models/operations/getsavedviewrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getsavedviewresponse.md b/entity/docs/models/operations/getsavedviewresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getschemarequest.md b/entity/docs/models/operations/getschemarequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getschemaresponse.md b/entity/docs/models/operations/getschemaresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getschemaversions200applicationjson.md b/entity/docs/models/operations/getschemaversions200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getschemaversionsrequest.md b/entity/docs/models/operations/getschemaversionsrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/getschemaversionsresponse.md b/entity/docs/models/operations/getschemaversionsresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/gettaxonomyrequest.md b/entity/docs/models/operations/gettaxonomyrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/gettaxonomyresponse.md b/entity/docs/models/operations/gettaxonomyresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/importentitiesrequest.md b/entity/docs/models/operations/importentitiesrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/importentitiesresponse.md b/entity/docs/models/operations/importentitiesresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listsavedviews200applicationjson.md b/entity/docs/models/operations/listsavedviews200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listsavedviewsresponse.md b/entity/docs/models/operations/listsavedviewsresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listschemablueprints200applicationjson.md b/entity/docs/models/operations/listschemablueprints200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listschemablueprintsresponse.md b/entity/docs/models/operations/listschemablueprintsresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listschemas200applicationjson.md b/entity/docs/models/operations/listschemas200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listschemasrequest.md b/entity/docs/models/operations/listschemasrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listschemasresponse.md b/entity/docs/models/operations/listschemasresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listtaxonomies200applicationjson.md b/entity/docs/models/operations/listtaxonomies200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listtaxonomiesresponse.md b/entity/docs/models/operations/listtaxonomiesresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md b/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/patchentityrequest.md b/entity/docs/models/operations/patchentityrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/patchentityresponse.md b/entity/docs/models/operations/patchentityresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/putschemarequest.md b/entity/docs/models/operations/putschemarequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/putschemaresponse.md b/entity/docs/models/operations/putschemaresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/searchentitiesresponse.md b/entity/docs/models/operations/searchentitiesresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md b/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md b/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md b/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md b/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md b/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/taxonomyautocompleterequest.md b/entity/docs/models/operations/taxonomyautocompleterequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/taxonomyautocompleteresponse.md b/entity/docs/models/operations/taxonomyautocompleteresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md b/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md b/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updateentityrequest.md b/entity/docs/models/operations/updateentityrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updateentityresponse.md b/entity/docs/models/operations/updateentityresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updaterelationrequest.md b/entity/docs/models/operations/updaterelationrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updaterelationrequestbody.md b/entity/docs/models/operations/updaterelationrequestbody.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updaterelationresponse.md b/entity/docs/models/operations/updaterelationresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updatesavedviewrequest.md b/entity/docs/models/operations/updatesavedviewrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/updatesavedviewresponse.md b/entity/docs/models/operations/updatesavedviewresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/upsertentityrequest.md b/entity/docs/models/operations/upsertentityrequest.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/upsertentityrequestbody.md b/entity/docs/models/operations/upsertentityrequestbody.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/operations/upsertentityresponse.md b/entity/docs/models/operations/upsertentityresponse.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/activity.md b/entity/docs/models/shared/activity.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/activityitem.md b/entity/docs/models/shared/activityitem.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/addressrelationattribute.md b/entity/docs/models/shared/addressrelationattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/addressrelationattributeconstraints.md b/entity/docs/models/shared/addressrelationattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/addressrelationattributeinfohelpers.md b/entity/docs/models/shared/addressrelationattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/addressrelationattributetype.md b/entity/docs/models/shared/addressrelationattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/automationattribute.md b/entity/docs/models/shared/automationattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/automationattributeconstraints.md b/entity/docs/models/shared/automationattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/automationattributeinfohelpers.md b/entity/docs/models/shared/automationattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/automationattributetype.md b/entity/docs/models/shared/automationattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/booleanattribute.md b/entity/docs/models/shared/booleanattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/booleanattributeconstraints.md b/entity/docs/models/shared/booleanattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/booleanattributeinfohelpers.md b/entity/docs/models/shared/booleanattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/booleanattributetype.md b/entity/docs/models/shared/booleanattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/classificationsupdate.md b/entity/docs/models/shared/classificationsupdate.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/computedattribute.md b/entity/docs/models/shared/computedattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/computedattributeconstraints.md b/entity/docs/models/shared/computedattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/computedattributeinfohelpers.md b/entity/docs/models/shared/computedattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/computedattributetype.md b/entity/docs/models/shared/computedattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/consentattribute.md b/entity/docs/models/shared/consentattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/consentattributeconstraints.md b/entity/docs/models/shared/consentattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/consentattributeinfohelpers.md b/entity/docs/models/shared/consentattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/consentattributetype.md b/entity/docs/models/shared/consentattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/countryattribute.md b/entity/docs/models/shared/countryattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/countryattributeconstraints.md b/entity/docs/models/shared/countryattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/countryattributeinfohelpers.md b/entity/docs/models/shared/countryattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/countryattributetype.md b/entity/docs/models/shared/countryattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/currencyattribute.md b/entity/docs/models/shared/currencyattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/currencyattributeconstraints.md b/entity/docs/models/shared/currencyattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/currencyattributecurrency1.md b/entity/docs/models/shared/currencyattributecurrency1.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/currencyattributeinfohelpers.md b/entity/docs/models/shared/currencyattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/currencyattributetype.md b/entity/docs/models/shared/currencyattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/dateattribute.md b/entity/docs/models/shared/dateattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/dateattributeconstraints.md b/entity/docs/models/shared/dateattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/dateattributeinfohelpers.md b/entity/docs/models/shared/dateattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/dateattributetype.md b/entity/docs/models/shared/dateattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitycapability.md b/entity/docs/models/shared/entitycapability.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaultcreate.md b/entity/docs/models/shared/entitydefaultcreate.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md b/entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaultcreateviewtype.md b/entity/docs/models/shared/entitydefaultcreateviewtype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaultedit.md b/entity/docs/models/shared/entitydefaultedit.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaultedittablemenuoptions.md b/entity/docs/models/shared/entitydefaultedittablemenuoptions.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaulteditviewtype.md b/entity/docs/models/shared/entitydefaulteditviewtype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaulttable.md b/entity/docs/models/shared/entitydefaulttable.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractions.md b/entity/docs/models/shared/entitydefaulttablenavbaractions.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitydefaulttableviewtype.md b/entity/docs/models/shared/entitydefaulttableviewtype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityimportparams.md b/entity/docs/models/shared/entityimportparams.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityimportparamss3reference.md b/entity/docs/models/shared/entityimportparamss3reference.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityoperation.md b/entity/docs/models/shared/entityoperation.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityoperationdiff.md b/entity/docs/models/shared/entityoperationdiff.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityoperationoperation.md b/entity/docs/models/shared/entityoperationoperation.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityoperationparams.md b/entity/docs/models/shared/entityoperationparams.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschema.md b/entity/docs/models/shared/entityschema.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemagroupsettings.md b/entity/docs/models/shared/entityschemagroupsettings.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md b/entity/docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemaitem.md b/entity/docs/models/shared/entityschemaitem.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemaitemgroupsettings.md b/entity/docs/models/shared/entityschemaitemgroupsettings.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md b/entity/docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemaitemsource.md b/entity/docs/models/shared/entityschemaitemsource.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemaitemuiconfig.md b/entity/docs/models/shared/entityschemaitemuiconfig.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemaitemuiconfigsharing.md b/entity/docs/models/shared/entityschemaitemuiconfigsharing.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemauiconfig.md b/entity/docs/models/shared/entityschemauiconfig.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemauiconfiglistitem.md b/entity/docs/models/shared/entityschemauiconfiglistitem.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityschemauiconfigsharing.md b/entity/docs/models/shared/entityschemauiconfigsharing.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitysearchparams.md b/entity/docs/models/shared/entitysearchparams.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitysearchparamsaggs.md b/entity/docs/models/shared/entitysearchparamsaggs.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitysearchresults.md b/entity/docs/models/shared/entitysearchresults.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entitysearchresultsaggregations.md b/entity/docs/models/shared/entitysearchresultsaggregations.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityviewdisabled.md b/entity/docs/models/shared/entityviewdisabled.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/entityviewdisabledviewtype.md b/entity/docs/models/shared/entityviewdisabledviewtype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/fileattribute.md b/entity/docs/models/shared/fileattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/fileattributeconstraints.md b/entity/docs/models/shared/fileattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/fileattributedefaultaccesscontrol.md b/entity/docs/models/shared/fileattributedefaultaccesscontrol.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/fileattributeinfohelpers.md b/entity/docs/models/shared/fileattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/fileattributetype.md b/entity/docs/models/shared/fileattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/getrelationsresp.md b/entity/docs/models/shared/getrelationsresp.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/getrelationsrespwithpagination.md b/entity/docs/models/shared/getrelationsrespwithpagination.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/internalattribute.md b/entity/docs/models/shared/internalattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/internalattributeconstraints.md b/entity/docs/models/shared/internalattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/internalattributeinfohelpers.md b/entity/docs/models/shared/internalattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/internalattributetype.md b/entity/docs/models/shared/internalattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/internaluserattribute.md b/entity/docs/models/shared/internaluserattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/internaluserattributeconstraints.md b/entity/docs/models/shared/internaluserattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/internaluserattributeinfohelpers.md b/entity/docs/models/shared/internaluserattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/internaluserattributetype.md b/entity/docs/models/shared/internaluserattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/invitationemailattribute.md b/entity/docs/models/shared/invitationemailattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/invitationemailattributeconstraints.md b/entity/docs/models/shared/invitationemailattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/invitationemailattributeinfohelpers.md b/entity/docs/models/shared/invitationemailattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/invitationemailattributetype.md b/entity/docs/models/shared/invitationemailattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/linkattribute.md b/entity/docs/models/shared/linkattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/linkattributeconstraints.md b/entity/docs/models/shared/linkattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/linkattributeinfohelpers.md b/entity/docs/models/shared/linkattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/linkattributetype.md b/entity/docs/models/shared/linkattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/multiselectattribute.md b/entity/docs/models/shared/multiselectattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/multiselectattributeconstraints.md b/entity/docs/models/shared/multiselectattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/multiselectattributeinfohelpers.md b/entity/docs/models/shared/multiselectattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/multiselectattributeoptions2.md b/entity/docs/models/shared/multiselectattributeoptions2.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/multiselectattributetype.md b/entity/docs/models/shared/multiselectattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/numberattribute.md b/entity/docs/models/shared/numberattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/numberattributeconstraints.md b/entity/docs/models/shared/numberattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/numberattributeinfohelpers.md b/entity/docs/models/shared/numberattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/numberattributetype.md b/entity/docs/models/shared/numberattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/orderedlistattribute.md b/entity/docs/models/shared/orderedlistattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/orderedlistattributeconstraints.md b/entity/docs/models/shared/orderedlistattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/orderedlistattributeinfohelpers.md b/entity/docs/models/shared/orderedlistattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/orderedlistattributetype.md b/entity/docs/models/shared/orderedlistattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/partnerstatusattribute.md b/entity/docs/models/shared/partnerstatusattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/partnerstatusattributeconstraints.md b/entity/docs/models/shared/partnerstatusattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/partnerstatusattributeinfohelpers.md b/entity/docs/models/shared/partnerstatusattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/partnerstatusattributetype.md b/entity/docs/models/shared/partnerstatusattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/paymentmethodrelationattribute.md b/entity/docs/models/shared/paymentmethodrelationattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/paymentmethodrelationattributeconstraints.md b/entity/docs/models/shared/paymentmethodrelationattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/paymentmethodrelationattributeinfohelpers.md b/entity/docs/models/shared/paymentmethodrelationattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/paymentmethodrelationattributetype.md b/entity/docs/models/shared/paymentmethodrelationattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/purposeattribute.md b/entity/docs/models/shared/purposeattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/purposeattributeconstraints.md b/entity/docs/models/shared/purposeattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/purposeattributeinfohelpers.md b/entity/docs/models/shared/purposeattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/purposeattributetype.md b/entity/docs/models/shared/purposeattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/redirectentityview.md b/entity/docs/models/shared/redirectentityview.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/redirectentityviewviewtype.md b/entity/docs/models/shared/redirectentityviewviewtype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationattribute.md b/entity/docs/models/shared/relationattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationattributeactions.md b/entity/docs/models/shared/relationattributeactions.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationattributeactionsactiontype.md b/entity/docs/models/shared/relationattributeactionsactiontype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationattributeconstraints.md b/entity/docs/models/shared/relationattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationattributedrawersize.md b/entity/docs/models/shared/relationattributedrawersize.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationattributeeditmode.md b/entity/docs/models/shared/relationattributeeditmode.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationattributeinfohelpers.md b/entity/docs/models/shared/relationattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationattributerelationaffinitymode.md b/entity/docs/models/shared/relationattributerelationaffinitymode.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationattributerelationtype.md b/entity/docs/models/shared/relationattributerelationtype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationattributetype.md b/entity/docs/models/shared/relationattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/relationitem.md b/entity/docs/models/shared/relationitem.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/repeatableattribute.md b/entity/docs/models/shared/repeatableattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/repeatableattributeconstraints.md b/entity/docs/models/shared/repeatableattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/repeatableattributeinfohelpers.md b/entity/docs/models/shared/repeatableattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/repeatableattributerelationaffinitymode.md b/entity/docs/models/shared/repeatableattributerelationaffinitymode.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/repeatableattributetype.md b/entity/docs/models/shared/repeatableattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/savedview.md b/entity/docs/models/shared/savedview.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/savedviewcreatedby1.md b/entity/docs/models/shared/savedviewcreatedby1.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/savedviewitem.md b/entity/docs/models/shared/savedviewitem.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/savedviewitemcreatedby1.md b/entity/docs/models/shared/savedviewitemcreatedby1.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/searchmappings.md b/entity/docs/models/shared/searchmappings.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/searchmappingstype.md b/entity/docs/models/shared/searchmappingstype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/security.md b/entity/docs/models/shared/security.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/selectattribute.md b/entity/docs/models/shared/selectattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/selectattributeconstraints.md b/entity/docs/models/shared/selectattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/selectattributeinfohelpers.md b/entity/docs/models/shared/selectattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/selectattributeoptions1.md b/entity/docs/models/shared/selectattributeoptions1.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/selectattributetype.md b/entity/docs/models/shared/selectattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/sequenceattribute.md b/entity/docs/models/shared/sequenceattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/sequenceattributeconstraints.md b/entity/docs/models/shared/sequenceattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/sequenceattributeinfohelpers.md b/entity/docs/models/shared/sequenceattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/sequenceattributetype.md b/entity/docs/models/shared/sequenceattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/statusattribute.md b/entity/docs/models/shared/statusattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/statusattributeconstraints.md b/entity/docs/models/shared/statusattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/statusattributeinfohelpers.md b/entity/docs/models/shared/statusattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/statusattributeoptions2.md b/entity/docs/models/shared/statusattributeoptions2.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/statusattributetype.md b/entity/docs/models/shared/statusattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/summaryattribute.md b/entity/docs/models/shared/summaryattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/summaryfield.md b/entity/docs/models/shared/summaryfield.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/tagsattribute.md b/entity/docs/models/shared/tagsattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/tagsattributeconstraints.md b/entity/docs/models/shared/tagsattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/tagsattributeinfohelpers.md b/entity/docs/models/shared/tagsattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/tagsattributetype.md b/entity/docs/models/shared/tagsattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/taxonomy.md b/entity/docs/models/shared/taxonomy.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/taxonomyclassification.md b/entity/docs/models/shared/taxonomyclassification.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/textattribute.md b/entity/docs/models/shared/textattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/textattributeconstraints.md b/entity/docs/models/shared/textattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/textattributeinfohelpers.md b/entity/docs/models/shared/textattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/textattributetype.md b/entity/docs/models/shared/textattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/userrelationattribute.md b/entity/docs/models/shared/userrelationattribute.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/userrelationattributeconstraints.md b/entity/docs/models/shared/userrelationattributeconstraints.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/userrelationattributeinfohelpers.md b/entity/docs/models/shared/userrelationattributeinfohelpers.md old mode 100644 new mode 100755 diff --git a/entity/docs/models/shared/userrelationattributetype.md b/entity/docs/models/shared/userrelationattributetype.md old mode 100644 new mode 100755 diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md old mode 100644 new mode 100755 diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md old mode 100644 new mode 100755 diff --git a/entity/docs/sdks/entityimport/README.md b/entity/docs/sdks/entityimport/README.md old mode 100644 new mode 100755 diff --git a/entity/docs/sdks/epilot/README.md b/entity/docs/sdks/epilot/README.md old mode 100644 new mode 100755 diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md old mode 100644 new mode 100755 diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md old mode 100644 new mode 100755 diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md old mode 100644 new mode 100755 diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md old mode 100644 new mode 100755 diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md old mode 100644 new mode 100755 diff --git a/entity/gen.yaml b/entity/gen.yaml index 85cb779b9..a44945400 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.64.0 - generationVersion: 2.71.0 + speakeasyVersion: 1.65.0 + generationVersion: 2.73.0 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.18.0 + version: 1.19.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/pylintrc b/entity/pylintrc old mode 100644 new mode 100755 diff --git a/entity/setup.py b/entity/setup.py old mode 100644 new mode 100755 index f790f42bb..910014afc --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.18.0", + version="1.19.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/__init__.py b/entity/src/epilot/__init__.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/activity.py b/entity/src/epilot/activity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/entities.py b/entity/src/epilot/entities.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/entity_import.py b/entity/src/epilot/entity_import.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/export.py b/entity/src/epilot/export.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/__init__.py b/entity/src/epilot/models/__init__.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/errors/__init__.py b/entity/src/epilot/models/errors/__init__.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/errors/sdkerror.py b/entity/src/epilot/models/errors/sdkerror.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/__init__.py b/entity/src/epilot/models/operations/__init__.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/addrelations.py b/entity/src/epilot/models/operations/addrelations.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/attachactivity.py b/entity/src/epilot/models/operations/attachactivity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/autocomplete.py b/entity/src/epilot/models/operations/autocomplete.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/createactivity.py b/entity/src/epilot/models/operations/createactivity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/createentity.py b/entity/src/epilot/models/operations/createentity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/createsavedview.py b/entity/src/epilot/models/operations/createsavedview.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/deleteentity.py b/entity/src/epilot/models/operations/deleteentity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/deleterelation.py b/entity/src/epilot/models/operations/deleterelation.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/deletesavedview.py b/entity/src/epilot/models/operations/deletesavedview.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/deleteschema.py b/entity/src/epilot/models/operations/deleteschema.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/exportentities.py b/entity/src/epilot/models/operations/exportentities.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/getactivity.py b/entity/src/epilot/models/operations/getactivity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/getentity.py b/entity/src/epilot/models/operations/getentity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/getentityactivityfeed.py b/entity/src/epilot/models/operations/getentityactivityfeed.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/getrelationsv2.py b/entity/src/epilot/models/operations/getrelationsv2.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/getsavedview.py b/entity/src/epilot/models/operations/getsavedview.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/getschema.py b/entity/src/epilot/models/operations/getschema.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/getschemaversions.py b/entity/src/epilot/models/operations/getschemaversions.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/gettaxonomy.py b/entity/src/epilot/models/operations/gettaxonomy.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/importentities.py b/entity/src/epilot/models/operations/importentities.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/listsavedviews.py b/entity/src/epilot/models/operations/listsavedviews.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/listschemablueprints.py b/entity/src/epilot/models/operations/listschemablueprints.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/listschemas.py b/entity/src/epilot/models/operations/listschemas.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/listtaxonomies.py b/entity/src/epilot/models/operations/listtaxonomies.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/patchentity.py b/entity/src/epilot/models/operations/patchentity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/putschema.py b/entity/src/epilot/models/operations/putschema.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/searchentities.py b/entity/src/epilot/models/operations/searchentities.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py b/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/taxonomyautocomplete.py b/entity/src/epilot/models/operations/taxonomyautocomplete.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py b/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/updateentity.py b/entity/src/epilot/models/operations/updateentity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/updaterelation.py b/entity/src/epilot/models/operations/updaterelation.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/updatesavedview.py b/entity/src/epilot/models/operations/updatesavedview.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/operations/upsertentity.py b/entity/src/epilot/models/operations/upsertentity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/activity.py b/entity/src/epilot/models/shared/activity.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/activityitem.py b/entity/src/epilot/models/shared/activityitem.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/addressrelationattribute.py b/entity/src/epilot/models/shared/addressrelationattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/automationattribute.py b/entity/src/epilot/models/shared/automationattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/booleanattribute.py b/entity/src/epilot/models/shared/booleanattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/classificationsupdate.py b/entity/src/epilot/models/shared/classificationsupdate.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/computedattribute.py b/entity/src/epilot/models/shared/computedattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/consentattribute.py b/entity/src/epilot/models/shared/consentattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/countryattribute.py b/entity/src/epilot/models/shared/countryattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/currencyattribute.py b/entity/src/epilot/models/shared/currencyattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/dateattribute.py b/entity/src/epilot/models/shared/dateattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entitycapability.py b/entity/src/epilot/models/shared/entitycapability.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entitydefaultcreate.py b/entity/src/epilot/models/shared/entitydefaultcreate.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entitydefaultedit.py b/entity/src/epilot/models/shared/entitydefaultedit.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entityimportparams.py b/entity/src/epilot/models/shared/entityimportparams.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entityoperation.py b/entity/src/epilot/models/shared/entityoperation.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entityschema.py b/entity/src/epilot/models/shared/entityschema.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entityschemaitem.py b/entity/src/epilot/models/shared/entityschemaitem.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entitysearchparams.py b/entity/src/epilot/models/shared/entitysearchparams.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entitysearchresults.py b/entity/src/epilot/models/shared/entitysearchresults.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/entityviewdisabled.py b/entity/src/epilot/models/shared/entityviewdisabled.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/fileattribute.py b/entity/src/epilot/models/shared/fileattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/getrelationsresp.py b/entity/src/epilot/models/shared/getrelationsresp.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/internalattribute.py b/entity/src/epilot/models/shared/internalattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/internaluserattribute.py b/entity/src/epilot/models/shared/internaluserattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/invitationemailattribute.py b/entity/src/epilot/models/shared/invitationemailattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/linkattribute.py b/entity/src/epilot/models/shared/linkattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/multiselectattribute.py b/entity/src/epilot/models/shared/multiselectattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/numberattribute.py b/entity/src/epilot/models/shared/numberattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/orderedlistattribute.py b/entity/src/epilot/models/shared/orderedlistattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/partnerstatusattribute.py b/entity/src/epilot/models/shared/partnerstatusattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/purposeattribute.py b/entity/src/epilot/models/shared/purposeattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/redirectentityview.py b/entity/src/epilot/models/shared/redirectentityview.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/relationitem.py b/entity/src/epilot/models/shared/relationitem.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/repeatableattribute.py b/entity/src/epilot/models/shared/repeatableattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/savedview.py b/entity/src/epilot/models/shared/savedview.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/savedviewitem.py b/entity/src/epilot/models/shared/savedviewitem.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/searchmappings.py b/entity/src/epilot/models/shared/searchmappings.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/security.py b/entity/src/epilot/models/shared/security.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/selectattribute.py b/entity/src/epilot/models/shared/selectattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/sequenceattribute.py b/entity/src/epilot/models/shared/sequenceattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/summaryattribute.py b/entity/src/epilot/models/shared/summaryattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/summaryfield.py b/entity/src/epilot/models/shared/summaryfield.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/tagsattribute.py b/entity/src/epilot/models/shared/tagsattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/taxonomy.py b/entity/src/epilot/models/shared/taxonomy.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/taxonomyclassification.py b/entity/src/epilot/models/shared/taxonomyclassification.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/textattribute.py b/entity/src/epilot/models/shared/textattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/models/shared/userrelationattribute.py b/entity/src/epilot/models/shared/userrelationattribute.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/saved_views.py b/entity/src/epilot/saved_views.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/schemas.py b/entity/src/epilot/schemas.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/sdk.py b/entity/src/epilot/sdk.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py old mode 100644 new mode 100755 index 5c5cfd75f..2b4d6ff02 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.18.0' - gen_version: str = '2.71.0' + sdk_version: str = '1.19.0' + gen_version: str = '2.73.0' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: diff --git a/entity/src/epilot/taxonomy.py b/entity/src/epilot/taxonomy.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/utils/__init__.py b/entity/src/epilot/utils/__init__.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/utils/retries.py b/entity/src/epilot/utils/retries.py old mode 100644 new mode 100755 diff --git a/entity/src/epilot/utils/utils.py b/entity/src/epilot/utils/utils.py old mode 100644 new mode 100755 From 9d3ec536bfaab881e1e5f473f5631f21c391bcc2 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Thu, 27 Jul 2023 01:20:56 +0000 Subject: [PATCH 24/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.1 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 951ad113a..7901c5649 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -172,4 +172,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.65.0 (2.73.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.65.0 (2.73.0) https://github.com/speakeasy-api/speakeasy + +## 2023-07-27 01:20:33 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.65.1 (2.73.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index a44945400..97e7f9ce4 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.65.0 - generationVersion: 2.73.0 + speakeasyVersion: 1.65.1 + generationVersion: 2.73.1 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.19.0 + version: 1.19.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 910014afc..7bff21a0a 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.19.0", + version="1.19.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 2b4d6ff02..3eccd2ddf 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.19.0' - gen_version: str = '2.73.0' + sdk_version: str = '1.19.1' + gen_version: str = '2.73.1' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From a9cea4f1e4a663f7949dcfef8996fd8236114b1e Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 28 Jul 2023 01:21:53 +0000 Subject: [PATCH 25/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.2 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 7901c5649..3c24c77fe 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -178,4 +178,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.65.1 (2.73.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.65.1 (2.73.1) https://github.com/speakeasy-api/speakeasy + +## 2023-07-28 01:21:29 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.65.2 (2.75.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 97e7f9ce4..bb92cac43 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 205b7e10a9fbc76b94b89450226fac40 docVersion: 1.0.0 - speakeasyVersion: 1.65.1 - generationVersion: 2.73.1 + speakeasyVersion: 1.65.2 + generationVersion: 2.75.1 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.19.1 + version: 1.20.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 7bff21a0a..64407a340 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.19.1", + version="1.20.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 3eccd2ddf..3f214a745 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.19.1' - gen_version: str = '2.73.1' + sdk_version: str = '1.20.0' + gen_version: str = '2.75.1' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From a61c16aa7ff5deb46efa3ba06b14ae0daa56ee40 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 29 Jul 2023 01:22:16 +0000 Subject: [PATCH 26/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.2 --- entity/RELEASES.md | 6 ++++++ entity/docs/models/shared/entitydefaultedit.md | 1 + entity/gen.yaml | 4 ++-- entity/setup.py | 2 +- entity/src/epilot/models/shared/entitydefaultedit.py | 2 ++ entity/src/epilot/sdkconfiguration.py | 2 +- 6 files changed, 13 insertions(+), 4 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 3c24c77fe..706a9a19a 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -184,4 +184,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.65.2 (2.75.1) https://github.com/speakeasy-api/speakeasy + +## 2023-07-29 01:21:49 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.65.2 (2.75.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultedit.md b/entity/docs/models/shared/entitydefaultedit.md index 0f5e451a1..bb7faa418 100755 --- a/entity/docs/models/shared/entitydefaultedit.md +++ b/entity/docs/models/shared/entitydefaultedit.md @@ -6,5 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | | `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | +| `summary_attributes` | list[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | | `table_menu_options` | [Optional[EntityDefaultEditTableMenuOptions]](../../models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | | `view_type` | [Optional[EntityDefaultEditViewType]](../../models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index bb92cac43..7aab60f71 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,6 +1,6 @@ configVersion: 1.0.0 management: - docChecksum: 205b7e10a9fbc76b94b89450226fac40 + docChecksum: 948c6e8800f9e029729cf09b040766f9 docVersion: 1.0.0 speakeasyVersion: 1.65.2 generationVersion: 2.75.1 @@ -10,7 +10,7 @@ generation: singleTagPerOp: false telemetryEnabled: false python: - version: 1.20.0 + version: 1.20.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 64407a340..19992643b 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.20.0", + version="1.20.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/shared/entitydefaultedit.py b/entity/src/epilot/models/shared/entitydefaultedit.py index 0b18bfaeb..0538a7bcc 100755 --- a/entity/src/epilot/models/shared/entitydefaultedit.py +++ b/entity/src/epilot/models/shared/entitydefaultedit.py @@ -26,6 +26,8 @@ class EntityDefaultEditViewType(str, Enum): @dataclasses.dataclass class EntityDefaultEdit: search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) + summary_attributes: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) + r"""List of attribute names that we show in the summary header""" table_menu_options: Optional[EntityDefaultEditTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) view_type: Optional[EntityDefaultEditViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 3f214a745..d86b5c761 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,7 +17,7 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.20.0' + sdk_version: str = '1.20.1' gen_version: str = '2.75.1' def get_server_details(self) -> tuple[str, dict[str, str]]: From b79c7ebb332a4196e62ca76a40f8a95b2bf4be46 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 1 Aug 2023 01:40:50 +0000 Subject: [PATCH 27/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.66.1 --- entity/RELEASES.md | 8 +++++++- entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 706a9a19a..7344161bd 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -190,4 +190,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.65.2 (2.75.1) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.65.2 (2.75.1) https://github.com/speakeasy-api/speakeasy + +## 2023-08-01 01:40:22 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.66.1 (2.75.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 7aab60f71..87b600c81 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,15 +2,15 @@ configVersion: 1.0.0 management: docChecksum: 948c6e8800f9e029729cf09b040766f9 docVersion: 1.0.0 - speakeasyVersion: 1.65.2 - generationVersion: 2.75.1 + speakeasyVersion: 1.66.1 + generationVersion: 2.75.2 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false python: - version: 1.20.1 + version: 1.20.2 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 19992643b..28f41d33f 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.20.1", + version="1.20.2", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index d86b5c761..82582a14b 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.20.1' - gen_version: str = '2.75.1' + sdk_version: str = '1.20.2' + gen_version: str = '2.75.2' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From f9f273f6a633cda407702331015ca14a9b3cc387 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 26 Aug 2023 01:10:03 +0000 Subject: [PATCH 28/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.16 --- entity/README.md | 1 + entity/RELEASES.md | 10 +++- .../getentityactivityfeedrequest.md | 3 +- ...tfavoriteviewsforuser200applicationjson.md | 10 ++++ .../listfavoriteviewsforuserresponse.md | 11 +++++ entity/docs/models/shared/savedview.md | 1 + entity/docs/models/shared/savedviewitem.md | 1 + .../models/shared/statusattributeoptions2.md | 8 ++-- entity/docs/sdks/activity/README.md | 1 + entity/docs/sdks/savedviews/README.md | 47 +++++++++++++++++-- entity/files.gen | 3 ++ entity/gen.yaml | 13 +++-- entity/setup.py | 2 +- entity/src/epilot/entities.py | 12 ++++- .../src/epilot/models/operations/__init__.py | 3 +- .../operations/getentityactivityfeed.py | 4 +- .../operations/listfavoriteviewsforuser.py | 31 ++++++++++++ entity/src/epilot/models/shared/savedview.py | 2 + .../src/epilot/models/shared/savedviewitem.py | 2 + .../epilot/models/shared/statusattribute.py | 2 + entity/src/epilot/saved_views.py | 28 +++++++++++ entity/src/epilot/sdkconfiguration.py | 4 +- entity/src/epilot/utils/utils.py | 7 ++- 23 files changed, 182 insertions(+), 24 deletions(-) create mode 100755 entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md create mode 100755 entity/docs/models/operations/listfavoriteviewsforuserresponse.md create mode 100755 entity/src/epilot/models/operations/listfavoriteviewsforuser.py diff --git a/entity/README.md b/entity/README.md index a08fa7fd4..25da3e72a 100755 --- a/entity/README.md +++ b/entity/README.md @@ -81,6 +81,7 @@ if res.activity_item is not None: * [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 diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 7344161bd..35bf65aa6 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -196,4 +196,12 @@ Based on: ### Changes Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml -- Speakeasy CLI 1.66.1 (2.75.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.66.1 (2.75.2) https://github.com/speakeasy-api/speakeasy + +## 2023-08-26 01:09:32 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.74.16 (2.88.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.21.0] entity \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeedrequest.md b/entity/docs/models/operations/getentityactivityfeedrequest.md index f5ef71847..f60f393f5 100755 --- a/entity/docs/models/operations/getentityactivityfeedrequest.md +++ b/entity/docs/models/operations/getentityactivityfeedrequest.md @@ -9,6 +9,7 @@ | `before` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | get activities before this timestamp | | | `from_` | *Optional[int]* | :heavy_minus_sign: | start from page | | | `id` | *str* | :heavy_check_mark: | Entity id | | +| `include_relations` | *Optional[bool]* | :heavy_minus_sign: | Include activities from related entities | | | `size` | *Optional[int]* | :heavy_minus_sign: | max number of results to return | | | `slug` | *str* | :heavy_check_mark: | Entity Type | contact | -| `type` | *Optional[str]* | :heavy_minus_sign: | Activity type | SyncActivity | \ No newline at end of file +| `type` | *Optional[str]* | :heavy_minus_sign: | Filter by activity type | SyncActivity | \ No newline at end of file diff --git a/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md b/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md new file mode 100755 index 000000000..c0ef2ddef --- /dev/null +++ b/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md @@ -0,0 +1,10 @@ +# ListFavoriteViewsForUser200ApplicationJSON + +Success + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `results` | list[[shared.SavedViewItem](../../models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listfavoriteviewsforuserresponse.md b/entity/docs/models/operations/listfavoriteviewsforuserresponse.md new file mode 100755 index 000000000..45b9b82a3 --- /dev/null +++ b/entity/docs/models/operations/listfavoriteviewsforuserresponse.md @@ -0,0 +1,11 @@ +# ListFavoriteViewsForUserResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `list_favorite_views_for_user_200_application_json_object` | [Optional[ListFavoriteViewsForUser200ApplicationJSON]](../../models/operations/listfavoriteviewsforuser200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/shared/savedview.md b/entity/docs/models/shared/savedview.md index b51d00a51..7df2a2ccb 100755 --- a/entity/docs/models/shared/savedview.md +++ b/entity/docs/models/shared/savedview.md @@ -8,6 +8,7 @@ A saved entity view | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | `created_by` | *Any* | :heavy_check_mark: | N/A | | +| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | | `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | | `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | | `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | diff --git a/entity/docs/models/shared/savedviewitem.md b/entity/docs/models/shared/savedviewitem.md index ab01479e2..626a49369 100755 --- a/entity/docs/models/shared/savedviewitem.md +++ b/entity/docs/models/shared/savedviewitem.md @@ -10,6 +10,7 @@ A saved entity view | `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `created_by` | *Any* | :heavy_check_mark: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | +| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | | `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | | `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | | `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | diff --git a/entity/docs/models/shared/statusattributeoptions2.md b/entity/docs/models/shared/statusattributeoptions2.md index 38643452f..b363733b6 100755 --- a/entity/docs/models/shared/statusattributeoptions2.md +++ b/entity/docs/models/shared/statusattributeoptions2.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | +| `title` | *Optional[str]* | :heavy_minus_sign: | The displayed title of the option | +| `value` | *str* | :heavy_check_mark: | The stored value of the option | \ No newline at end of file diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md index 7f551e5e1..fcee391ab 100755 --- a/entity/docs/sdks/activity/README.md +++ b/entity/docs/sdks/activity/README.md @@ -170,6 +170,7 @@ req = operations.GetEntityActivityFeedRequest( before=dateutil.parser.isoparse('2022-08-14T00:52:14.624Z'), from_=618016, id='b6e21419-5989-40af-a563-e2516fe4c8b7', + include_relations=False, size=100226, slug='contact', type='SyncActivity', diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index 28874f366..49dc2f17e 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -9,6 +9,7 @@ Saved Views for Entities * [create_saved_view](#create_saved_view) - createSavedView * [delete_saved_view](#delete_saved_view) - deleteSavedView * [get_saved_view](#get_saved_view) - getSavedView +* [list_favorite_views_for_user](#list_favorite_views_for_user) - listFavoriteViewsForUser * [list_saved_views](#list_saved_views) - listSavedViews * [update_saved_view](#update_saved_view) - updateSavedView @@ -35,6 +36,11 @@ req = shared.SavedView( "facere": 'veritatis', "consequuntur": 'quasi', }, + is_favorited_by=[ + '11701', + '11701', + '11701', + ], name='View listing German', org='66', shared=True, @@ -44,9 +50,8 @@ req = shared.SavedView( 'contact', ], ui_config={ - "aliquid": 'tenetur', - "quae": 'earum', - "vel": 'in', + "tenetur": 'quae', + "earum": 'vel', }, ) @@ -85,7 +90,7 @@ s = epilot.Epilot( ) req = operations.DeleteSavedViewRequest( - id='4bdb04f1-5756-4082-968e-a19f1d170513', + id='74bdb04f-1575-4608-ad68-ea19f1d17051', ) res = s.saved_views.delete_saved_view(req) @@ -123,7 +128,7 @@ s = epilot.Epilot( ) req = operations.GetSavedViewRequest( - id='39d08086-a184-4039-8c26-071f93f5f064', + id='339d0808-6a18-4403-94c2-6071f93f5f06', ) res = s.saved_views.get_saved_view(req) @@ -144,6 +149,35 @@ if res.get_saved_view_200_application_json_object is not None: **[operations.GetSavedViewResponse](../../models/operations/getsavedviewresponse.md)** +## list_favorite_views_for_user + +Get the Favorite Saved Views for user based on the schema + +### Example Usage + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.saved_views.list_favorite_views_for_user() + +if res.list_favorite_views_for_user_200_application_json_object is not None: + # handle response +``` + + +### Response + +**[operations.ListFavoriteViewsForUserResponse](../../models/operations/listfavoriteviewsforuserresponse.md)** + + ## list_saved_views Get the Saved Views based on the schema @@ -194,6 +228,9 @@ req = operations.UpdateSavedViewRequest( created_by=shared.SavedViewCreatedBy1( user_id='10598', ), + is_favorited_by=[ + '11701', + ], name='View listing German', org='66', shared=True, diff --git a/entity/files.gen b/entity/files.gen index 31113becb..3faae25dc 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -38,6 +38,7 @@ src/epilot/models/operations/updaterelation.py src/epilot/models/operations/createsavedview.py src/epilot/models/operations/deletesavedview.py src/epilot/models/operations/getsavedview.py +src/epilot/models/operations/listfavoriteviewsforuser.py src/epilot/models/operations/listsavedviews.py src/epilot/models/operations/updatesavedview.py src/epilot/models/operations/deleteschema.py @@ -166,6 +167,8 @@ docs/models/operations/deletesavedviewresponse.md docs/models/operations/getsavedviewrequest.md docs/models/operations/getsavedview200applicationjson.md docs/models/operations/getsavedviewresponse.md +docs/models/operations/listfavoriteviewsforuser200applicationjson.md +docs/models/operations/listfavoriteviewsforuserresponse.md docs/models/operations/listsavedviews200applicationjson.md docs/models/operations/listsavedviewsresponse.md docs/models/operations/updatesavedviewrequest.md diff --git a/entity/gen.yaml b/entity/gen.yaml index 87b600c81..7d9128b3a 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,16 +1,21 @@ configVersion: 1.0.0 management: - docChecksum: 948c6e8800f9e029729cf09b040766f9 + docChecksum: da8519d9328e11a8d680212f59139216 docVersion: 1.0.0 - speakeasyVersion: 1.66.1 - generationVersion: 2.75.2 + speakeasyVersion: 1.74.16 + generationVersion: 2.88.2 generation: sdkClassName: epilot sdkFlattening: true singleTagPerOp: false telemetryEnabled: false +features: + python: + core: 2.83.1 + globalSecurity: 2.81.1 + globalServerURLs: 2.82.0 python: - version: 1.20.2 + version: 1.21.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 28f41d33f..de4575d12 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.20.2", + version="1.21.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/entities.py b/entity/src/epilot/entities.py index a1c1c407e..df189e55f 100755 --- a/entity/src/epilot/entities.py +++ b/entity/src/epilot/entities.py @@ -1,10 +1,15 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" from .sdkconfiguration import SDKConfiguration +from enum import Enum from epilot import utils from epilot.models import errors, operations, shared from typing import Any, Optional +class SearchEntitiesAcceptEnum(str, Enum): + APPLICATION_JSON = "application/json" + TEXT_CSV = "text/csv" + class Entities: r"""CRUD Access for Entities""" sdk_configuration: SDKConfiguration @@ -278,7 +283,7 @@ def patch_entity(self, request: operations.PatchEntityRequest) -> operations.Pat return res - def search_entities(self, request: shared.EntitySearchParams) -> operations.SearchEntitiesResponse: + def search_entities(self, request: shared.EntitySearchParams, accept_header_override: Optional[SearchEntitiesAcceptEnum] = None) -> operations.SearchEntitiesResponse: r"""searchEntities Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying. @@ -353,7 +358,10 @@ def search_entities(self, request: shared.EntitySearchParams) -> operations.Sear req_content_type, data, form = utils.serialize_request_body(request, "request", 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type - headers['Accept'] = 'application/json;q=1, text/csv;q=0' + if accept_header_override is not None: + headers['Accept'] = accept_header_override.value + else: + headers['Accept'] = 'application/json;q=1, text/csv;q=0' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client diff --git a/entity/src/epilot/models/operations/__init__.py b/entity/src/epilot/models/operations/__init__.py index 32be57784..a33e3caa3 100755 --- a/entity/src/epilot/models/operations/__init__.py +++ b/entity/src/epilot/models/operations/__init__.py @@ -21,6 +21,7 @@ from .getschemaversions import * from .gettaxonomy import * from .importentities import * +from .listfavoriteviewsforuser import * from .listsavedviews import * from .listschemablueprints import * from .listschemas import * @@ -37,4 +38,4 @@ from .updatesavedview import * from .upsertentity import * -__all__ = ["AddRelationsRequest","AddRelationsResponse","AttachActivityRequest","AttachActivityResponse","Autocomplete200ApplicationJSON","AutocompleteRequest","AutocompleteResponse","CreateActivityRequest","CreateActivityResponse","CreateEntityRequest","CreateEntityResponse","CreateSavedViewResponse","DeleteEntityRequest","DeleteEntityResponse","DeleteRelationRequest","DeleteRelationResponse","DeleteSavedViewRequest","DeleteSavedViewResponse","DeleteSchemaRequest","DeleteSchemaResponse","ExportEntitiesRequest","ExportEntitiesResponse","GetActivityRequest","GetActivityResponse","GetEntity200ApplicationJSON","GetEntityActivityFeed200ApplicationJSON","GetEntityActivityFeedRequest","GetEntityActivityFeedResponse","GetEntityRequest","GetEntityResponse","GetRelationsRequest","GetRelationsResponse","GetRelationsV2Request","GetRelationsV2Response","GetSavedView200ApplicationJSON","GetSavedViewRequest","GetSavedViewResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaVersions200ApplicationJSON","GetSchemaVersionsRequest","GetSchemaVersionsResponse","GetTaxonomyRequest","GetTaxonomyResponse","ImportEntitiesRequest","ImportEntitiesResponse","ListSavedViews200ApplicationJSON","ListSavedViewsResponse","ListSchemaBlueprints200ApplicationJSON","ListSchemaBlueprintsResponse","ListSchemas200ApplicationJSON","ListSchemasRequest","ListSchemasResponse","ListTaxonomies200ApplicationJSON","ListTaxonomiesResponse","ListTaxonomyClassificationsForSchema200ApplicationJSON","ListTaxonomyClassificationsForSchemaRequest","ListTaxonomyClassificationsForSchemaResponse","PatchEntityRequest","PatchEntityResponse","PutSchemaRequest","PutSchemaResponse","SearchEntitiesResponse","TaxonomiesClassificationsSearch200ApplicationJSON","TaxonomiesClassificationsSearchRequest","TaxonomiesClassificationsSearchRequestBody","TaxonomiesClassificationsSearchResponse","TaxonomyAutocomplete200ApplicationJSON","TaxonomyAutocompleteRequest","TaxonomyAutocompleteResponse","UpdateClassificationsForTaxonomy200ApplicationJSON","UpdateClassificationsForTaxonomy200ApplicationJSONDeleted","UpdateClassificationsForTaxonomyRequest","UpdateClassificationsForTaxonomyResponse","UpdateEntityRequest","UpdateEntityResponse","UpdateRelationRequest","UpdateRelationRequestBody","UpdateRelationResponse","UpdateSavedViewRequest","UpdateSavedViewResponse","UpsertEntityRequest","UpsertEntityRequestBody","UpsertEntityResponse"] +__all__ = ["AddRelationsRequest","AddRelationsResponse","AttachActivityRequest","AttachActivityResponse","Autocomplete200ApplicationJSON","AutocompleteRequest","AutocompleteResponse","CreateActivityRequest","CreateActivityResponse","CreateEntityRequest","CreateEntityResponse","CreateSavedViewResponse","DeleteEntityRequest","DeleteEntityResponse","DeleteRelationRequest","DeleteRelationResponse","DeleteSavedViewRequest","DeleteSavedViewResponse","DeleteSchemaRequest","DeleteSchemaResponse","ExportEntitiesRequest","ExportEntitiesResponse","GetActivityRequest","GetActivityResponse","GetEntity200ApplicationJSON","GetEntityActivityFeed200ApplicationJSON","GetEntityActivityFeedRequest","GetEntityActivityFeedResponse","GetEntityRequest","GetEntityResponse","GetRelationsRequest","GetRelationsResponse","GetRelationsV2Request","GetRelationsV2Response","GetSavedView200ApplicationJSON","GetSavedViewRequest","GetSavedViewResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaVersions200ApplicationJSON","GetSchemaVersionsRequest","GetSchemaVersionsResponse","GetTaxonomyRequest","GetTaxonomyResponse","ImportEntitiesRequest","ImportEntitiesResponse","ListFavoriteViewsForUser200ApplicationJSON","ListFavoriteViewsForUserResponse","ListSavedViews200ApplicationJSON","ListSavedViewsResponse","ListSchemaBlueprints200ApplicationJSON","ListSchemaBlueprintsResponse","ListSchemas200ApplicationJSON","ListSchemasRequest","ListSchemasResponse","ListTaxonomies200ApplicationJSON","ListTaxonomiesResponse","ListTaxonomyClassificationsForSchema200ApplicationJSON","ListTaxonomyClassificationsForSchemaRequest","ListTaxonomyClassificationsForSchemaResponse","PatchEntityRequest","PatchEntityResponse","PutSchemaRequest","PutSchemaResponse","SearchEntitiesResponse","TaxonomiesClassificationsSearch200ApplicationJSON","TaxonomiesClassificationsSearchRequest","TaxonomiesClassificationsSearchRequestBody","TaxonomiesClassificationsSearchResponse","TaxonomyAutocomplete200ApplicationJSON","TaxonomyAutocompleteRequest","TaxonomyAutocompleteResponse","UpdateClassificationsForTaxonomy200ApplicationJSON","UpdateClassificationsForTaxonomy200ApplicationJSONDeleted","UpdateClassificationsForTaxonomyRequest","UpdateClassificationsForTaxonomyResponse","UpdateEntityRequest","UpdateEntityResponse","UpdateRelationRequest","UpdateRelationRequestBody","UpdateRelationResponse","UpdateSavedViewRequest","UpdateSavedViewResponse","UpsertEntityRequest","UpsertEntityRequestBody","UpsertEntityResponse"] diff --git a/entity/src/epilot/models/operations/getentityactivityfeed.py b/entity/src/epilot/models/operations/getentityactivityfeed.py index c16fc2455..f92e43d67 100755 --- a/entity/src/epilot/models/operations/getentityactivityfeed.py +++ b/entity/src/epilot/models/operations/getentityactivityfeed.py @@ -23,10 +23,12 @@ class GetEntityActivityFeedRequest: r"""get activities before this timestamp""" from_: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) r"""start from page""" + include_relations: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'include_relations', 'style': 'form', 'explode': True }}) + r"""Include activities from related entities""" size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) r"""max number of results to return""" type: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'type', 'style': 'form', 'explode': True }}) - r"""Activity type""" + r"""Filter by activity type""" diff --git a/entity/src/epilot/models/operations/listfavoriteviewsforuser.py b/entity/src/epilot/models/operations/listfavoriteviewsforuser.py new file mode 100755 index 000000000..aed861205 --- /dev/null +++ b/entity/src/epilot/models/operations/listfavoriteviewsforuser.py @@ -0,0 +1,31 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from ..shared import savedviewitem as shared_savedviewitem +from dataclasses_json import Undefined, dataclass_json +from epilot import utils +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class ListFavoriteViewsForUser200ApplicationJSON: + r"""Success""" + results: Optional[list[shared_savedviewitem.SavedViewItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + + + + + +@dataclasses.dataclass +class ListFavoriteViewsForUserResponse: + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + list_favorite_views_for_user_200_application_json_object: Optional[ListFavoriteViewsForUser200ApplicationJSON] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + + diff --git a/entity/src/epilot/models/shared/savedview.py b/entity/src/epilot/models/shared/savedview.py index ee6b616e3..b1bbb0c84 100755 --- a/entity/src/epilot/models/shared/savedview.py +++ b/entity/src/epilot/models/shared/savedview.py @@ -28,6 +28,8 @@ class SavedView: slug: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) r"""list of schemas a view can belong to""" ui_config: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config') }}) + is_favorited_by: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isFavoritedBy'), 'exclude': lambda f: f is None }}) + r"""List of users (IDs) that have favorited the view""" org: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org'), 'exclude': lambda f: f is None }}) r"""Organisation ID a view belongs to""" shared: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shared'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/savedviewitem.py b/entity/src/epilot/models/shared/savedviewitem.py index 5a710cec6..416c60f18 100755 --- a/entity/src/epilot/models/shared/savedviewitem.py +++ b/entity/src/epilot/models/shared/savedviewitem.py @@ -31,6 +31,8 @@ class SavedViewItem: created_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Generated uuid for a saved view""" + is_favorited_by: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isFavoritedBy'), 'exclude': lambda f: f is None }}) + r"""List of users (IDs) that have favorited the view""" org: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org'), 'exclude': lambda f: f is None }}) r"""Organisation ID a view belongs to""" shared: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shared'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py index 18e2d3497..52e804b31 100755 --- a/entity/src/epilot/models/shared/statusattribute.py +++ b/entity/src/epilot/models/shared/statusattribute.py @@ -49,7 +49,9 @@ class StatusAttributeInfoHelpers: @dataclasses.dataclass class StatusAttributeOptions2: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) + r"""The stored value of the option""" title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) + r"""The displayed title of the option""" diff --git a/entity/src/epilot/saved_views.py b/entity/src/epilot/saved_views.py index 2f1d5ec2f..382d3a3d0 100755 --- a/entity/src/epilot/saved_views.py +++ b/entity/src/epilot/saved_views.py @@ -94,6 +94,34 @@ def get_saved_view(self, request: operations.GetSavedViewRequest) -> operations. return res + def list_favorite_views_for_user(self) -> operations.ListFavoriteViewsForUserResponse: + r"""listFavoriteViewsForUser + Get the Favorite Saved Views for user based on the schema + """ + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/v1/entity/views/favorites' + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + + client = self.sdk_configuration.security_client + + http_res = client.request('GET', url, headers=headers) + content_type = http_res.headers.get('Content-Type') + + res = operations.ListFavoriteViewsForUserResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[operations.ListFavoriteViewsForUser200ApplicationJSON]) + res.list_favorite_views_for_user_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + + return res + + def list_saved_views(self) -> operations.ListSavedViewsResponse: r"""listSavedViews Get the Saved Views based on the schema diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 82582a14b..1053cc408 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.20.2' - gen_version: str = '2.75.2' + sdk_version: str = '1.21.0' + gen_version: str = '2.88.2' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: diff --git a/entity/src/epilot/utils/utils.py b/entity/src/epilot/utils/utils.py index 6b39ecf74..ea9792d0d 100755 --- a/entity/src/epilot/utils/utils.py +++ b/entity/src/epilot/utils/utils.py @@ -675,10 +675,13 @@ def _serialize_header(explode: bool, obj: any) -> str: def unmarshal_json(data, typ): - unmarhsal = make_dataclass('Unmarhsal', [('res', typ)], + unmarshal = make_dataclass('Unmarshal', [('res', typ)], bases=(DataClassJsonMixin,)) json_dict = json.loads(data) - out = unmarhsal.from_dict({"res": json_dict}) + try: + out = unmarshal.from_dict({"res": json_dict}) + except AttributeError as attr_err: + raise AttributeError(f'unable to unmarshal {data} as {typ}') from attr_err return out.res From 87e16d098a44ad1f46b04fee9dbbfba47f8a8a14 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 29 Aug 2023 01:13:03 +0000 Subject: [PATCH 29/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.17 --- entity/RELEASES.md | 10 +++++++++- entity/gen.yaml | 8 ++++---- entity/pylintrc | 2 +- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 5 files changed, 17 insertions(+), 9 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 35bf65aa6..eb0e4c323 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -204,4 +204,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.74.16 (2.88.2) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.21.0] entity \ No newline at end of file +- [python v1.21.0] entity + +## 2023-08-29 01:12:32 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.74.17 (2.88.5) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.21.1] entity \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 7d9128b3a..abd02eaab 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: da8519d9328e11a8d680212f59139216 docVersion: 1.0.0 - speakeasyVersion: 1.74.16 - generationVersion: 2.88.2 + speakeasyVersion: 1.74.17 + generationVersion: 2.88.5 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.83.1 + core: 2.83.2 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.21.0 + version: 1.21.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/pylintrc b/entity/pylintrc index 0302fb809..7dfa89ef2 100755 --- a/entity/pylintrc +++ b/entity/pylintrc @@ -622,7 +622,7 @@ additional-builtins= allow-global-unused-variables=yes # List of names allowed to shadow builtins -allowed-redefined-builtins= +allowed-redefined-builtins=id,object # List of strings which can identify a callback function by name. A callback # name must start or end with one of those strings. diff --git a/entity/setup.py b/entity/setup.py index de4575d12..9fc23c500 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.21.0", + version="1.21.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 1053cc408..8fdc5ec06 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.21.0' - gen_version: str = '2.88.2' + sdk_version: str = '1.21.1' + gen_version: str = '2.88.5' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From cbc6cc6429e2aab7625d54323e58618d2b63cd48 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Thu, 31 Aug 2023 01:12:59 +0000 Subject: [PATCH 30/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.76.1 --- entity/.gitattributes | 2 ++ entity/RELEASES.md | 10 +++++++++- entity/files.gen | 3 ++- entity/gen.yaml | 8 ++++---- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 6 files changed, 20 insertions(+), 9 deletions(-) create mode 100755 entity/.gitattributes diff --git a/entity/.gitattributes b/entity/.gitattributes new file mode 100755 index 000000000..4d75d5900 --- /dev/null +++ b/entity/.gitattributes @@ -0,0 +1,2 @@ +# This allows generated code to be indexed correctly +*.py linguist-generated=false \ No newline at end of file diff --git a/entity/RELEASES.md b/entity/RELEASES.md index eb0e4c323..92e6236c9 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -212,4 +212,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.74.17 (2.88.5) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.21.1] entity \ No newline at end of file +- [python v1.21.1] entity + +## 2023-08-31 01:12:33 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.76.1 (2.89.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.22.0] entity \ No newline at end of file diff --git a/entity/files.gen b/entity/files.gen index 3faae25dc..a6ac03533 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -384,4 +384,5 @@ docs/models/shared/entityschemauiconfig.md docs/models/shared/entityschema.md docs/models/shared/taxonomy.md docs/models/shared/classificationsupdate.md -docs/models/shared/security.md \ No newline at end of file +docs/models/shared/security.md +.gitattributes \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index abd02eaab..83339d5d4 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: da8519d9328e11a8d680212f59139216 docVersion: 1.0.0 - speakeasyVersion: 1.74.17 - generationVersion: 2.88.5 + speakeasyVersion: 1.76.1 + generationVersion: 2.89.1 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.83.2 + core: 2.84.0 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.21.1 + version: 1.22.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 9fc23c500..adaa538b0 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.21.1", + version="1.22.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 8fdc5ec06..58e5575fc 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.21.1' - gen_version: str = '2.88.5' + sdk_version: str = '1.22.0' + gen_version: str = '2.89.1' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From dc47176d4168da037724305a13daf7a487fb22fd Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 1 Sep 2023 01:17:33 +0000 Subject: [PATCH 31/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.0 --- entity/RELEASES.md | 10 +++++++++- entity/gen.yaml | 8 ++++---- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 16 insertions(+), 8 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 92e6236c9..f8d88149d 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -220,4 +220,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.76.1 (2.89.1) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.22.0] entity \ No newline at end of file +- [python v1.22.0] entity + +## 2023-09-01 01:17:05 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.77.0 (2.91.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.23.0] entity \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 83339d5d4..af3d53ae8 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: da8519d9328e11a8d680212f59139216 docVersion: 1.0.0 - speakeasyVersion: 1.76.1 - generationVersion: 2.89.1 + speakeasyVersion: 1.77.0 + generationVersion: 2.91.2 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.84.0 + core: 2.85.0 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.22.0 + version: 1.23.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index adaa538b0..7fc416a4f 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.22.0", + version="1.23.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 58e5575fc..fca36c794 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.22.0' - gen_version: str = '2.89.1' + sdk_version: str = '1.23.0' + gen_version: str = '2.91.2' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From 74721a3cb36555780709dd57b26b939480a60166 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 2 Sep 2023 01:10:15 +0000 Subject: [PATCH 32/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.2 --- entity/RELEASES.md | 10 +++++++++- entity/gen.yaml | 8 ++++---- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 16 insertions(+), 8 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index f8d88149d..bf483daa1 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -228,4 +228,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.77.0 (2.91.2) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.23.0] entity \ No newline at end of file +- [python v1.23.0] entity + +## 2023-09-02 01:09:50 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.77.2 (2.93.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.23.1] entity \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index af3d53ae8..a23106b2e 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: da8519d9328e11a8d680212f59139216 docVersion: 1.0.0 - speakeasyVersion: 1.77.0 - generationVersion: 2.91.2 + speakeasyVersion: 1.77.2 + generationVersion: 2.93.0 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.85.0 + core: 2.85.2 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.23.0 + version: 1.23.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 7fc416a4f..8f41cbd64 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.23.0", + version="1.23.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index fca36c794..af2b21de0 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.23.0' - gen_version: str = '2.91.2' + sdk_version: str = '1.23.1' + gen_version: str = '2.93.0' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: From bba82f23aa2c09eca4ecc2594c32e76b0a7c9978 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 5 Sep 2023 01:11:47 +0000 Subject: [PATCH 33/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.78.3 --- entity/RELEASES.md | 10 +++++++++- entity/gen.yaml | 8 ++++---- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- entity/src/epilot/utils/utils.py | 19 +++++++++++-------- 5 files changed, 27 insertions(+), 16 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index bf483daa1..bb6657cff 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -236,4 +236,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.77.2 (2.93.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.23.1] entity \ No newline at end of file +- [python v1.23.1] entity + +## 2023-09-05 01:11:16 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.78.3 (2.96.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.23.2] entity \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index a23106b2e..5799d4444 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: da8519d9328e11a8d680212f59139216 docVersion: 1.0.0 - speakeasyVersion: 1.77.2 - generationVersion: 2.93.0 + speakeasyVersion: 1.78.3 + generationVersion: 2.96.3 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.85.2 + core: 2.85.3 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.23.1 + version: 1.23.2 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 8f41cbd64..70ae3d0f6 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.23.1", + version="1.23.2", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index af2b21de0..90fed593c 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -17,8 +17,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.23.1' - gen_version: str = '2.93.0' + sdk_version: str = '1.23.2' + gen_version: str = '2.96.3' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: diff --git a/entity/src/epilot/utils/utils.py b/entity/src/epilot/utils/utils.py index ea9792d0d..c91b0c049 100755 --- a/entity/src/epilot/utils/utils.py +++ b/entity/src/epilot/utils/utils.py @@ -112,7 +112,8 @@ def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: dict, client.client.headers[header_name] = value elif scheme_type == 'http': if sub_type == 'bearer': - client.client.headers[header_name] = value.lower().startswith('bearer ') and value or f'Bearer {value}' + client.client.headers[header_name] = value.lower().startswith( + 'bearer ') and value or f'Bearer {value}' else: raise Exception('not supported') else: @@ -235,7 +236,7 @@ def template_url(url_with_params: str, params: dict[str, str]) -> str: def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[str, dict[str, Any]]] = None) -> dict[ - str, list[str]]: + str, list[str]]: params: dict[str, list[str]] = {} param_fields: Tuple[Field, ...] = fields(clazz) @@ -377,7 +378,7 @@ def _get_query_param_field_name(obj_field: Field) -> str: def _get_delimited_query_params(metadata: dict, field_name: str, obj: any, delimiter: str) -> dict[ - str, list[str]]: + str, list[str]]: return _populate_form(field_name, metadata.get("explode", True), obj, _get_query_param_field_name, delimiter) @@ -391,9 +392,9 @@ def _get_delimited_query_params(metadata: dict, field_name: str, obj: any, delim def serialize_request_body(request: dataclass, request_field_name: str, serialization_method: str) -> Tuple[ - str, any, any]: + str, any, any]: if request is None: - return None, None, None, None + return None, None, None if not is_dataclass(request) or not hasattr(request, request_field_name): return serialize_content_type(request_field_name, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], @@ -486,7 +487,7 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, def serialize_dict(original: dict, explode: bool, field_name, existing: Optional[dict[str, list[str]]]) -> dict[ - str, list[str]]: + str, list[str]]: if existing is None: existing = [] @@ -604,7 +605,8 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f items.append(_val_to_string(value)) if len(items) > 0: - params[field_name] = [delimiter.join([str(item) for item in items])] + params[field_name] = [delimiter.join( + [str(item) for item in items])] else: params[field_name] = [_val_to_string(obj)] @@ -681,7 +683,8 @@ def unmarshal_json(data, typ): try: out = unmarshal.from_dict({"res": json_dict}) except AttributeError as attr_err: - raise AttributeError(f'unable to unmarshal {data} as {typ}') from attr_err + raise AttributeError( + f'unable to unmarshal {data} as {typ}') from attr_err return out.res From 344dfd3edd68a052cdf5d1717664ef44c02018b4 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 8 Sep 2023 01:13:21 +0000 Subject: [PATCH 34/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.82.0 --- entity/README.md | 4 +- entity/RELEASES.md | 10 +- entity/USAGE.md | 4 +- entity/docs/models/shared/activityitem.md | 2 - .../docs/models/shared/entitysearchresults.md | 2 - .../shared/getrelationsrespwithpagination.md | 2 - .../shared/partnerorganisationattribute.md | 34 + ...partnerorganisationattributeconstraints.md | 11 + ...partnerorganisationattributeinfohelpers.md | 13 + .../partnerorganisationattributetype.md | 8 + entity/docs/models/shared/relationitem.md | 2 - entity/docs/models/shared/taxonomy.md | 2 - entity/docs/sdks/activity/README.md | 23 +- entity/docs/sdks/entities/README.md | 33 +- entity/docs/sdks/export/README.md | 10 +- entity/docs/sdks/relations/README.md | 65 +- entity/docs/sdks/savedviews/README.md | 35 +- entity/docs/sdks/schemas/README.md | 828 ++---------------- entity/docs/sdks/taxonomy/README.md | 95 +- entity/files.gen | 5 + entity/gen.yaml | 8 +- entity/setup.py | 2 +- entity/src/epilot/models/shared/__init__.py | 3 +- .../src/epilot/models/shared/activityitem.py | 4 +- .../models/shared/entitysearchresults.py | 1 - .../shared/getrelationsrespwithpagination.py | 1 - .../shared/partnerorganisationattribute.py | 101 +++ .../epilot/models/shared/purposeattribute.py | 5 +- .../src/epilot/models/shared/relationitem.py | 1 - entity/src/epilot/models/shared/taxonomy.py | 6 +- .../models/shared/taxonomyclassification.py | 5 +- entity/src/epilot/sdk.py | 9 +- entity/src/epilot/sdkconfiguration.py | 7 +- entity/src/epilot/utils/utils.py | 33 +- 34 files changed, 402 insertions(+), 972 deletions(-) create mode 100755 entity/docs/models/shared/partnerorganisationattribute.md create mode 100755 entity/docs/models/shared/partnerorganisationattributeconstraints.md create mode 100755 entity/docs/models/shared/partnerorganisationattributeinfohelpers.md create mode 100755 entity/docs/models/shared/partnerorganisationattributetype.md create mode 100755 entity/src/epilot/models/shared/partnerorganisationattribute.py diff --git a/entity/README.md b/entity/README.md index 25da3e72a..8ffab887f 100755 --- a/entity/README.md +++ b/entity/README.md @@ -24,9 +24,7 @@ s = epilot.Epilot( req = operations.AttachActivityRequest( entities=[ - '9bd9d8d6-9a67-44e0-b467-cc8796ed151a', - '05dfc2dd-f7cc-478c-a1ba-928fc816742c', - 'b7392059-2939-46fe-a759-6eb10faaa235', + '89bd9d8d-69a6-474e-8f46-7cc8796ed151', ], id='01F130Q52Q6MWSNS8N2AVXV4JN', ) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index bb6657cff..e668d0814 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -244,4 +244,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.78.3 (2.96.3) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.23.2] entity \ No newline at end of file +- [python v1.23.2] entity + +## 2023-09-08 01:12:56 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.82.0 (2.107.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.23.3] entity \ No newline at end of file diff --git a/entity/USAGE.md b/entity/USAGE.md index 79ecb397a..5cebff912 100755 --- a/entity/USAGE.md +++ b/entity/USAGE.md @@ -13,9 +13,7 @@ s = epilot.Epilot( req = operations.AttachActivityRequest( entities=[ - '9bd9d8d6-9a67-44e0-b467-cc8796ed151a', - '05dfc2dd-f7cc-478c-a1ba-928fc816742c', - 'b7392059-2939-46fe-a759-6eb10faaa235', + '89bd9d8d-69a6-474e-8f46-7cc8796ed151', ], id='01F130Q52Q6MWSNS8N2AVXV4JN', ) diff --git a/entity/docs/models/shared/activityitem.md b/entity/docs/models/shared/activityitem.md index 5fd93b53d..0918052ca 100755 --- a/entity/docs/models/shared/activityitem.md +++ b/entity/docs/models/shared/activityitem.md @@ -1,7 +1,5 @@ # ActivityItem -Success - ## Fields diff --git a/entity/docs/models/shared/entitysearchresults.md b/entity/docs/models/shared/entitysearchresults.md index 04ed9600f..bc0247253 100755 --- a/entity/docs/models/shared/entitysearchresults.md +++ b/entity/docs/models/shared/entitysearchresults.md @@ -1,7 +1,5 @@ # EntitySearchResults -Success - ## Fields diff --git a/entity/docs/models/shared/getrelationsrespwithpagination.md b/entity/docs/models/shared/getrelationsrespwithpagination.md index fed10afc1..e53ea39ac 100755 --- a/entity/docs/models/shared/getrelationsrespwithpagination.md +++ b/entity/docs/models/shared/getrelationsrespwithpagination.md @@ -1,7 +1,5 @@ # GetRelationsRespWithPagination -Success - ## Fields diff --git a/entity/docs/models/shared/partnerorganisationattribute.md b/entity/docs/models/shared/partnerorganisationattribute.md new file mode 100755 index 000000000..afed1e185 --- /dev/null +++ b/entity/docs/models/shared/partnerorganisationattribute.md @@ -0,0 +1,34 @@ +# PartnerOrganisationAttribute + +Shared Partner Organisations + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[PartnerOrganisationAttributeConstraints]](../../models/shared/partnerorganisationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group` | *Optional[str]* | :heavy_minus_sign: | Which group the attribute should appear in. Accepts group ID or group name | | +| `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | +| `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | +| `info_helpers` | [Optional[PartnerOrganisationAttributeInfoHelpers]](../../models/shared/partnerorganisationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | +| `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | +| `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | +| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | +| `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `type` | [Optional[PartnerOrganisationAttributeType]](../../models/shared/partnerorganisationattributetype.md) | :heavy_minus_sign: | N/A | | +| `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerorganisationattributeconstraints.md b/entity/docs/models/shared/partnerorganisationattributeconstraints.md new file mode 100755 index 000000000..c3894bf20 --- /dev/null +++ b/entity/docs/models/shared/partnerorganisationattributeconstraints.md @@ -0,0 +1,11 @@ +# PartnerOrganisationAttributeConstraints + +A set of constraints applicable to the attribute. +These constraints should and will be enforced by the attribute renderer. + + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerorganisationattributeinfohelpers.md b/entity/docs/models/shared/partnerorganisationattributeinfohelpers.md new file mode 100755 index 000000000..38edcd01d --- /dev/null +++ b/entity/docs/models/shared/partnerorganisationattributeinfohelpers.md @@ -0,0 +1,13 @@ +# PartnerOrganisationAttributeInfoHelpers + +A set of configurations meant to document and assist the user in filling the attribute. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `hint_custom_component` | *Optional[str]* | :heavy_minus_sign: | The name of the custom component to be used as the hint helper.
The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
When specified it overrides the `hint_text` or `hint_text_key` configuration.
| | +| `hint_text` | *Optional[str]* | :heavy_minus_sign: | The text to be displayed in the attribute hint helper.
When specified it overrides the `hint_text_key` configuration.
| | +| `hint_text_key` | *Optional[str]* | :heavy_minus_sign: | The key of the hint text to be displayed in the attribute hint helper.
The key should be a valid i18n key.
| | +| `hint_tooltip_placement` | *Optional[str]* | :heavy_minus_sign: | The placement of the hint tooltip.
The value should be a valid `@mui/core` tooltip placement.
| top | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerorganisationattributetype.md b/entity/docs/models/shared/partnerorganisationattributetype.md new file mode 100755 index 000000000..2ed31a1e1 --- /dev/null +++ b/entity/docs/models/shared/partnerorganisationattributetype.md @@ -0,0 +1,8 @@ +# PartnerOrganisationAttributeType + + +## Values + +| Name | Value | +| ---------------------- | ---------------------- | +| `PARTNER_ORGANISATION` | partner_organisation | \ No newline at end of file diff --git a/entity/docs/models/shared/relationitem.md b/entity/docs/models/shared/relationitem.md index 87511ed41..900acb8c8 100755 --- a/entity/docs/models/shared/relationitem.md +++ b/entity/docs/models/shared/relationitem.md @@ -1,7 +1,5 @@ # RelationItem -Success - ## Fields diff --git a/entity/docs/models/shared/taxonomy.md b/entity/docs/models/shared/taxonomy.md index 00013a4e9..84674090e 100755 --- a/entity/docs/models/shared/taxonomy.md +++ b/entity/docs/models/shared/taxonomy.md @@ -1,7 +1,5 @@ # Taxonomy -Taxonomy - ## Fields diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md index fcee391ab..c2f412d39 100755 --- a/entity/docs/sdks/activity/README.md +++ b/entity/docs/sdks/activity/README.md @@ -29,7 +29,7 @@ s = epilot.Epilot( req = operations.AttachActivityRequest( entities=[ - 'c5955907-aff1-4a3a-afa9-467739251aa5', + 'a05dfc2d-df7c-4c78-8a1b-a928fc816742', ], id='01F130Q52Q6MWSNS8N2AVXV4JN', ) @@ -76,16 +76,13 @@ req = operations.CreateActivityRequest( activity=shared.Activity( message='{{caller}} did something with {{entity payload.entity.id}}.', payload={ - "quo": 'sequi', + "impedit": 'cum', }, title='My custom activity', type='MyCustomActivity', ), entities=[ - '5ad019da-1ffe-478f-897b-0074f15471b5', - 'e6e13b99-d488-4e1e-91e4-50ad2abd4426', - '9802d502-a94b-4b4f-a3c9-69e9a3efa77d', - 'fb14cd66-ae39-45ef-b9ba-88f3a6699707', + '73920592-9396-4fea-b596-eb10faaa2352', ], ) @@ -125,8 +122,8 @@ s = epilot.Epilot( req = operations.GetActivityRequest( id='01F130Q52Q6MWSNS8N2AVXV4JN', - operations_from=301575, - operations_size=716075, + operations_from=750686, + operations_size=315428, ) res = s.activity.get_activity(req) @@ -166,12 +163,12 @@ s = epilot.Epilot( ) req = operations.GetEntityActivityFeedRequest( - after=dateutil.parser.isoparse('2022-06-04T18:23:50.695Z'), - before=dateutil.parser.isoparse('2022-08-14T00:52:14.624Z'), - from_=618016, - id='b6e21419-5989-40af-a563-e2516fe4c8b7', + after=dateutil.parser.isoparse('2022-04-10T11:47:13.463Z'), + before=dateutil.parser.isoparse('2022-06-06T21:04:34.044Z'), + from_=38425, + id='7aff1a3a-2fa9-4467-b392-51aa52c3f5ad', include_relations=False, - size=100226, + size=13571, slug='contact', type='SyncActivity', ) diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index d615f4100..97ed4db8b 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -34,8 +34,8 @@ s = epilot.Epilot( req = operations.AutocompleteRequest( attribute='_tags', - input='architecto', - size=919483, + input='quasi', + size=622846, slug='contact', ) @@ -100,8 +100,7 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( request_body={ - "expedita": 'nihil', - "repellat": 'quibusdam', + "temporibus": 'laborum', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, @@ -149,7 +148,7 @@ s = epilot.Epilot( req = operations.DeleteEntityRequest( activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - id='2ed02892-1cdd-4c69-a601-fb576b0d5f0d', + id='1ffe78f0-97b0-4074-b154-71b5e6e13b99', slug='contact', ) @@ -252,7 +251,7 @@ s = epilot.Epilot( req = operations.GetEntityRequest( hydrate=False, - id='30c5fbb2-5870-4532-82c7-3d5fe9b90c28', + id='d488e1e9-1e45-40ad-aabd-44269802d502', slug='contact', ) @@ -319,14 +318,12 @@ s = epilot.Epilot( req = operations.PatchEntityRequest( request_body={ - "eaque": 'occaecati', - "rerum": 'adipisci', - "asperiores": 'earum', + "dolorum": 'excepturi', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, dry_run=False, - id='49a8d9cb-f486-4333-a3f9-b77f3a410067', + id='4bb4f63c-969e-49a3-afa7-7dfb14cd66ae', slug='contact', ) @@ -432,14 +429,13 @@ s = epilot.Epilot( req = shared.EntitySearchParams( aggs=shared.EntitySearchParamsAggs(), fields_=[ - 'accusamus', - 'quidem', + 'non', ], - from_=976405, + from_=581273, hydrate=False, include_scores=False, q='_schema:contact AND status:active', - size=377752, + size=313218, sort='_created_at:desc', ) @@ -504,13 +500,11 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( request_body={ - "eos": 'atque', - "sit": 'fugiat', - "ab": 'soluta', + "accusamus": 'delectus', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, - id='a77a89eb-f737-4ae4-a03c-e5e6a95d8a0d', + id='b9ba88f3-a669-4970-b4ba-4469b6e21419', slug='contact', ) @@ -560,8 +554,7 @@ s = epilot.Epilot( req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( entity={ - "tempora": 'vel', - "quod": 'officiis', + "ullam": 'provident', }, unique_key=[ 'email.0.email', diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md index de5cb0765..09c89b007 100755 --- a/entity/docs/sdks/export/README.md +++ b/entity/docs/sdks/export/README.md @@ -28,20 +28,18 @@ req = operations.ExportEntitiesRequest( entity_search_params=shared.EntitySearchParams( aggs=shared.EntitySearchParamsAggs(), fields_=[ - 'a', - 'esse', - 'harum', + 'quos', ], - from_=483409, + from_=574325, hydrate=False, include_scores=False, q='_schema:contact AND status:active', - size=215507, + size=33625, sort='_created_at:desc', ), is_template=False, job_id='abc123', - language='quisquam', + language='mollitia', ) res = s.export.export_entities(req) diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index dbdd33c5d..24ab6d640 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -32,43 +32,15 @@ req = operations.AddRelationsRequest( request_body=[ shared.RelationItem( tags=[ - 'tempore', + 'reiciendis', ], - attribute='accusamus', - entity_id='453f870b-326b-45a7-b429-cdb1a8422bb6', - reverse=False, - ), - shared.RelationItem( - tags=[ - 'molestias', - 'temporibus', - ], - attribute='qui', - entity_id='322715bf-0cbb-41e3-9b8b-90f3443a1108', - reverse=False, - ), - shared.RelationItem( - tags=[ - 'consequatur', - 'est', - 'repellendus', - 'porro', - ], - attribute='doloribus', - entity_id='4b921879-fce9-453f-b3ef-7fbc7abd74dd', - reverse=False, - ), - shared.RelationItem( - tags=[ - 'natus', - ], - attribute='impedit', - entity_id='0f5d2cff-7c70-4a45-a26d-436813f16d9f', + attribute='mollitia', + entity_id='563e2516-fe4c-48b7-91e5-b7fd2ed02892', reverse=False, ), ], async_=False, - id='5fce6c55-6146-4c3e-a50f-b008c42e141a', + id='1cddc692-601f-4b57-ab0d-5f0d30c5fbb2', slug='contact', ) @@ -108,9 +80,9 @@ s = epilot.Epilot( req = operations.DeleteRelationRequest( async_=False, - attribute='laborum', - entity_id='placeat', - id='366c8dd6-b144-4290-b474-778a7bd466d2', + attribute='quis', + entity_id='totam', + id='7053202c-73d5-4fe9-b90c-28909b3fe49a', slug='contact', ) @@ -155,7 +127,7 @@ s = epilot.Epilot( req = operations.GetRelationsRequest( hydrate=False, - id='8c10ab3c-dca4-4251-904e-523c7e0bc717', + id='8d9cbf48-6333-423f-9b77-f3a4100674eb', include_reverse=False, slug='contact', ) @@ -201,16 +173,14 @@ s = epilot.Epilot( req = operations.GetRelationsV2Request( fields_=[ - 'accusamus', - 'aliquam', - 'odio', + 'voluptatibus', ], - from_=577543, + from_=377752, hydrate=False, - id='6f2a70c6-8828-42aa-8825-62f222e9817e', + id='9280d1ba-77a8-49eb-b737-ae4203ce5e6a', include_reverse=False, - query='accusamus', - size=82971, + query='provident', + size=324683, slug='contact', ) @@ -251,14 +221,13 @@ s = epilot.Epilot( req = operations.UpdateRelationRequest( request_body=operations.UpdateRelationRequestBody( tags=[ - 'quod', - 'nam', + 'repellendus', ], ), async_=False, - attribute='vero', - entity_id='aliquid', - id='1e6b7b95-bc0a-4b3c-a0c4-f3789fd871f9', + attribute='totam', + entity_id='similique', + id='0d446ce2-af7a-473c-b3be-453f870b326b', slug='contact', ) diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index 49dc2f17e..a1ab0a97f 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -30,28 +30,20 @@ s = epilot.Epilot( ) req = shared.SavedView( - created_by={ - "possimus": 'quia', - "eveniet": 'asperiores', - "facere": 'veritatis', - "consequuntur": 'quasi', - }, + created_by=shared.SavedViewCreatedBy1( + user_id='10598', + ), is_favorited_by=[ '11701', - '11701', - '11701', ], name='View listing German', org='66', shared=True, slug=[ 'contact', - 'contact', - 'contact', ], ui_config={ - "tenetur": 'quae', - "earum": 'vel', + "deserunt": 'quam', }, ) @@ -90,7 +82,7 @@ s = epilot.Epilot( ) req = operations.DeleteSavedViewRequest( - id='74bdb04f-1575-4608-ad68-ea19f1d17051', + id='3429cdb1-a842-42bb-a79d-2322715bf0cb', ) res = s.saved_views.delete_saved_view(req) @@ -128,7 +120,7 @@ s = epilot.Epilot( ) req = operations.GetSavedViewRequest( - id='339d0808-6a18-4403-94c2-6071f93f5f06', + id='b1e31b8b-90f3-4443-a110-8e0adcf4b921', ) res = s.saved_views.get_saved_view(req) @@ -225,9 +217,9 @@ s = epilot.Epilot( req = operations.UpdateSavedViewRequest( saved_view=shared.SavedView( - created_by=shared.SavedViewCreatedBy1( - user_id='10598', - ), + created_by={ + "odio": 'occaecati', + }, is_favorited_by=[ '11701', ], @@ -236,17 +228,12 @@ req = operations.UpdateSavedViewRequest( shared=True, slug=[ 'contact', - 'contact', - 'contact', - 'contact', ], ui_config={ - "maxime": 'dignissimos', - "officia": 'asperiores', - "nemo": 'quae', + "voluptatibus": 'quisquam', }, ), - id='5cc413aa-63aa-4e8d-a786-4dbb675fd5e6', + id='e953f73e-f7fb-4c7a-bd74-dd39c0f5d2cf', ) res = s.saved_views.update_saved_view(req) diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index 1e228f732..05271ac08 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -69,7 +69,7 @@ s = epilot.Epilot( ) req = operations.GetSchemaRequest( - id='0b375ed4-f6fb-4ee4-9f33-317fe35b60eb', + id='f7c70a45-626d-4436-813f-16d9f5fce6c5', slug='contact', ) @@ -108,11 +108,11 @@ s = epilot.Epilot( ) req = operations.GetSchemaVersionsRequest( - drafts_from=1138.16, - drafts_size=8817.21, + drafts_from=3331.45, + drafts_size=3994.99, slug='contact', - versions_from=6311.26, - versions_size=2724.37, + versions_from=811.01, + versions_size=3018.31, ) res = s.schemas.get_schema_versions(req) @@ -217,8 +217,8 @@ s = epilot.Epilot( ) req = operations.ListTaxonomyClassificationsForSchemaRequest( - query='aspernatur', - size=3790.57, + query='ea', + size=7752.2, slug='contact', taxonomy_slug='purpose', ) @@ -261,662 +261,96 @@ s = epilot.Epilot( req = operations.PutSchemaRequest( entity_schema=shared.EntitySchema( attributes=[ - shared.UserRelationAttribute( + shared.MultiSelectAttribute( purpose=[ - 'ba3c2874-4ed5-43b8-8f3a-8d8f5c0b2f2f', - 'b7b194a2-76b2-4691-afe1-f08f4294e369', + 'e250fb00-8c42-4e14-9aac-366c8dd6b144', ], - constraints=shared.UserRelationAttributeConstraints(), - default_value='quos', + allow_any=False, + allow_extra_options=False, + constraints=shared.MultiSelectAttributeConstraints(), + default_value='explicabo', deprecated=False, + disable_case_sensitive=False, entity_builder_disable_edit=False, feature_flag='FF_MY_FEATURE_FLAG', - group='voluptatibus', + group='provident', hidden=False, hide_label=False, - icon='tempora', - info_helpers=shared.UserRelationAttributeInfoHelpers( - hint_custom_component='tempora', - hint_text='voluptate', - hint_text_key='reiciendis', + icon='ipsa', + info_helpers=shared.MultiSelectAttributeInfoHelpers( + hint_custom_component='molestiae', + hint_text='magnam', + hint_text_key='odio', hint_tooltip_placement='top', ), - label='ex', + label='eius', layout='full_width', - multiple=False, - name='Ethel Towne', - order=0, - placeholder='quaerat', - preview_value_formatter='incidunt', - protected=False, - readonly=False, - render_condition='ipsam', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.UserRelationAttributeType.RELATION_USER, - value_formatter='debitis', - ), - shared.RepeatableAttribute( - purpose=[ - 'ca55efd2-0e45-47e1-858b-6a89fbe3a5aa', + name='Tamara Leffler', + options=[ + shared.MultiSelectAttributeOptions2( + title='Dr.', + value='ut', + ), ], - constraints=shared.RepeatableAttributeConstraints(), - default_value='corrupti', - deprecated=False, - enable_relation_picker=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='accusamus', - has_primary=False, - hidden=False, - hide_label=False, - icon='tempora', - info_helpers=shared.RepeatableAttributeInfoHelpers( - hint_custom_component='atque', - hint_text='fugit', - hint_text_key='ut', - hint_tooltip_placement='top', - ), - label='fugiat', - layout='full_width', - name='Cecilia Quitzon IV', order=0, - placeholder='ipsam', - preview_value_formatter='sit', + placeholder='eum', + preview_value_formatter='suscipit', protected=False, readonly=False, - relation_affinity_mode=shared.RepeatableAttributeRelationAffinityMode.STRONG, - render_condition='quas', - repeatable=False, + render_condition='assumenda', required=False, setting_flag='MY_SETTING', show_in_table=False, - type=shared.RepeatableAttributeType.DATE, - value_formatter='corporis', + type=shared.MultiSelectAttributeType.MULTISELECT, + value_formatter='praesentium', ), ], - blueprint='1862065e-904f-43b1-994b-8abf603a79f9', + blueprint='c10ab3cd-ca42-4519-84e5-23c7e0bc7178', capabilities=[ shared.EntityCapability( purpose=[ - 'e0ab7da8-a50c-4e18-bf86-bc173d689eee', - '9526f8d9-86e8-481e-ad4f-0e1012563f94', - 'e29e973e-922a-457a-95be-3e060807e2b6', - 'e3ab8845-f059-47a6-8ff2-a54a31e94764', + 'e4796f2a-70c6-4882-82aa-482562f222e9', ], attributes=[ - shared.MultiSelectAttribute( - purpose=[ - '865e7956-f925-41a5-a9da-660ff57bfaad', - '4f9efc1b-4512-4c10-b264-8dc2f615199e', - 'bfd0e9fe-6c63-42ca-baed-0117996312fd', - 'e0477177-8ff6-41d0-9747-6360a15db6a6', - ], - allow_any=False, - allow_extra_options=False, - constraints=shared.MultiSelectAttributeConstraints(), - default_value='aliquid', - deprecated=False, - disable_case_sensitive=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='perferendis', - hidden=False, - hide_label=False, - icon='eum', - info_helpers=shared.MultiSelectAttributeInfoHelpers( - hint_custom_component='voluptas', - hint_text='iste', - hint_text_key='id', - hint_tooltip_placement='top', - ), - label='ab', - layout='full_width', - name='Woodrow Volkman', - options=[ - 'deleniti', - 'vitae', - shared.MultiSelectAttributeOptions2( - title='Ms.', - value='quo', - ), - ], - order=0, - placeholder='ex', - preview_value_formatter='ut', - protected=False, - readonly=False, - render_condition='ad', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.MultiSelectAttributeType.CHECKBOX, - value_formatter='voluptatem', - ), - shared.TagsAttribute( - purpose=[ - '61891baa-0fe1-4ade-808e-6f8c5f350d8c', - 'db5a3418-1430-4104-a181-3d5208ece7e2', - '53b66845-1c6c-46e2-85e1-6deab3fec957', - ], - constraints=shared.TagsAttributeConstraints(), - default_value='blanditiis', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='officia', - hidden=False, - hide_label=False, - icon='voluptas', - info_helpers=shared.TagsAttributeInfoHelpers( - hint_custom_component='numquam', - hint_text='nemo', - hint_text_key='quos', - hint_tooltip_placement='top', - ), - label='eius', - layout='full_width', - name='Caroline Dooley', - options=[ - 'quasi', - 'rem', - ], - order=0, - placeholder='fugiat', - preview_value_formatter='dicta', - protected=False, - readonly=False, - render_condition='nisi', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - suggestions=[ - 'consectetur', - ], - type=shared.TagsAttributeType.TAGS, - value_formatter='aperiam', - ), shared.TagsAttribute( purpose=[ - 'b0929921-aefb-49f5-8c4d-86e68e4be056', - '013f59da-757a-459e-8fef-66ef1caa3383', - 'c2beb477-373c-48d7-af64-d1db1f2c4310', - '661e9634-9e1c-4f9e-86e3-a437000ae6b6', + '17ee17cb-e61e-46b7-b95b-c0ab3c20c4f3', ], constraints=shared.TagsAttributeConstraints(), - default_value='facilis', + default_value='esse', deprecated=False, entity_builder_disable_edit=False, feature_flag='FF_MY_FEATURE_FLAG', - group='placeat', + group='blanditiis', hidden=False, hide_label=False, - icon='perspiciatis', + icon='provident', info_helpers=shared.TagsAttributeInfoHelpers( - hint_custom_component='expedita', - hint_text='deleniti', - hint_text_key='a', + hint_custom_component='a', + hint_text='nulla', + hint_text_key='quas', hint_tooltip_placement='top', ), - label='voluptate', + label='esse', layout='full_width', - name='Lindsey Treutel', + name='Lorene Mueller', options=[ - 'corporis', - 'est', + 'possimus', ], order=0, - placeholder='error', - preview_value_formatter='esse', + placeholder='quia', + preview_value_formatter='eveniet', protected=False, readonly=False, - render_condition='labore', + render_condition='asperiores', required=False, setting_flag='MY_SETTING', show_in_table=False, suggestions=[ - 'vero', + 'facere', ], type=shared.TagsAttributeType.TAGS, - value_formatter='consectetur', - ), - ], - feature_flag='FF_MY_FEATURE_FLAG', - legacy=False, - name='customer_messaging', - setting_flag='MY_SETTING', - title='Messaging', - ui_hooks=[ - { - "dolorem": 'ad', - }, - ], - ), - shared.EntityCapability( - purpose=[ - '965bb8a7-2026-4114-b5e1-39dbc2259b1a', - ], - attributes=[ - shared.InvitationEmailAttribute( - purpose=[ - '8c070e10-84cb-4067-ad1a-d879eeb9665b', - '85efbd02-bae0-4be2-9782-259e3ea4b519', - '7f92443d-a7ce-452b-895c-537c6454efb0', - ], - constraints=shared.InvitationEmailAttributeConstraints(), - default_value='libero', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='ratione', - hidden=False, - hide_label=False, - icon='labore', - info_helpers=shared.InvitationEmailAttributeInfoHelpers( - hint_custom_component='totam', - hint_text='occaecati', - hint_text_key='voluptas', - hint_tooltip_placement='top', - ), - label='quo', - layout='full_width', - name='Bethany Paucek', - order=0, - placeholder='impedit', - preview_value_formatter='delectus', - protected=False, - readonly=False, - render_condition='tempore', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.InvitationEmailAttributeType.INVITATION_EMAIL, - value_formatter='vero', - ), - shared.CountryAttribute( - purpose=[ - 'd5707577-9291-477d-aac6-46ecb573409e', - '3eb1e5a2-b12e-4b07-b116-db99545fc95f', - 'a88970e1-89db-4b30-bcb3-3ea055b197cd', - '44e2f52d-82d3-4513-bb6f-48b656bcdb35', - ], - constraints=shared.CountryAttributeConstraints(), - default_value='voluptatibus', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='voluptatibus', - hidden=False, - hide_label=False, - icon='consequuntur', - info_helpers=shared.CountryAttributeInfoHelpers( - hint_custom_component='debitis', - hint_text='labore', - hint_text_key='rerum', - hint_tooltip_placement='top', - ), - label='eos', - layout='full_width', - name='Audrey Durgan', - order=0, - placeholder='rem', - preview_value_formatter='eligendi', - protected=False, - readonly=False, - render_condition='fugiat', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.CountryAttributeType.COUNTRY, - value_formatter='unde', - ), - shared.AutomationAttribute( - purpose=[ - '319c177d-525f-477b-914e-eb52ff785fc3', - '7814d4c9-8e0c-42bb-89eb-75dad636c600', - ], - constraints=shared.AutomationAttributeConstraints(), - default_value='ad', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='quae', - hidden=False, - hide_label=False, - icon='amet', - info_helpers=shared.AutomationAttributeInfoHelpers( - hint_custom_component='illum', - hint_text='praesentium', - hint_text_key='quidem', - hint_tooltip_placement='top', - ), - label='cum', - layout='full_width', - name='Joyce Carroll DVM', - order=0, - placeholder='iusto', - preview_value_formatter='amet', - protected=False, - readonly=False, - render_condition='provident', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.AutomationAttributeType.AUTOMATION, - value_formatter='dolorum', - ), - ], - feature_flag='FF_MY_FEATURE_FLAG', - legacy=False, - name='customer_messaging', - setting_flag='MY_SETTING', - title='Messaging', - ui_hooks=[ - { - "repudiandae": 'consequatur', - "nemo": 'molestiae', - "itaque": 'facilis', - }, - { - "aperiam": 'sint', - "accusamus": 'eos', - "totam": 'dicta', - }, - { - "velit": 'dolor', - }, - { - "a": 'dolor', - }, - ], - ), - shared.EntityCapability( - purpose=[ - '81d4c700-b607-4f3c-93c7-3b9da3f2ceda', - '7e23f225-7411-4faf-8b75-44e472e80285', - '7a5b4046-3a7d-4575-b140-0e764ad7334e', - ], - attributes=[ - shared.CountryAttribute( - purpose=[ - '781b36a0-8088-4d10-8efa-da200ef0422e', - 'b2164cf9-ab83-466c-b23f-fda9e06bee48', - '25c1fc0e-115c-480b-bf91-8544ec42defc', - ], - constraints=shared.CountryAttributeConstraints(), - default_value='porro', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='accusamus', - hidden=False, - hide_label=False, - icon='totam', - info_helpers=shared.CountryAttributeInfoHelpers( - hint_custom_component='reiciendis', - hint_text='ab', - hint_text_key='sint', - hint_tooltip_placement='top', - ), - label='nihil', - layout='full_width', - name='Charlene Kuhic', - order=0, - placeholder='vel', - preview_value_formatter='neque', - protected=False, - readonly=False, - render_condition='corporis', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.CountryAttributeType.COUNTRY, - value_formatter='voluptas', - ), - shared.BooleanAttribute( - purpose=[ - '7b408f05-e3d4-48fd-af31-3a1f5fd94259', - 'c0b36f25-ea94-44f3-b756-c11f6c37a512', - '6243835b-bc05-4a23-a45c-efc5fde10a0c', - ], - constraints=shared.BooleanAttributeConstraints(), - default_value='necessitatibus', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='quia', - hidden=False, - hide_label=False, - icon='dicta', - info_helpers=shared.BooleanAttributeInfoHelpers( - hint_custom_component='vel', - hint_text='perspiciatis', - hint_text_key='debitis', - hint_tooltip_placement='top', - ), - label='ullam', - layout='full_width', - name='Ms. Donna Auer', - order=0, - placeholder='iure', - preview_value_formatter='quibusdam', - protected=False, - readonly=False, - render_condition='quod', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.BooleanAttributeType.BOOLEAN, - value_formatter='nemo', - ), - shared.AutomationAttribute( - purpose=[ - '4762799b-fbbe-4694-9fb2-bb4ecae6c3d5', - ], - constraints=shared.AutomationAttributeConstraints(), - default_value='illum', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='facilis', - hidden=False, - hide_label=False, - icon='non', - info_helpers=shared.AutomationAttributeInfoHelpers( - hint_custom_component='mollitia', - hint_text='assumenda', - hint_text_key='recusandae', - hint_tooltip_placement='top', - ), - label='distinctio', - layout='full_width', - name='Leon Schumm', - order=0, - placeholder='laborum', - preview_value_formatter='incidunt', - protected=False, - readonly=False, - render_condition='maxime', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.AutomationAttributeType.AUTOMATION, - value_formatter='ipsam', - ), - shared.TextAttribute( - purpose=[ - 'a8aa94c0-2644-4cf5-a9d9-a4578adc1ac6', - '00dec001-ac80-42e2-ac09-ff8f0f816ff3', - ], - constraints=shared.TextAttributeConstraints(), - default_value='eius', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='esse', - hidden=False, - hide_label=False, - icon='in', - info_helpers=shared.TextAttributeInfoHelpers( - hint_custom_component='eligendi', - hint_text='quasi', - hint_text_key='neque', - hint_tooltip_placement='top', - ), - label='vero', - layout='full_width', - multiline=False, - name='Edward Denesik II', - order=0, - placeholder='dicta', - preview_value_formatter='odit', - protected=False, - readonly=False, - render_condition='corporis', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.TextAttributeType.STRING, - value_formatter='rerum', - ), - ], - feature_flag='FF_MY_FEATURE_FLAG', - legacy=False, - name='customer_messaging', - setting_flag='MY_SETTING', - title='Messaging', - ui_hooks=[ - { - "vel": 'accusantium', - "id": 'laboriosam', - "ex": 'quas', - }, - ], - ), - shared.EntityCapability( - purpose=[ - '51a472af-923c-4594-9f83-f350cf876ffb', - ], - attributes=[ - shared.TextAttribute( - purpose=[ - 'c6ecbb4e-243c-4f78-9ffa-feda53e5ae6e', - ], - constraints=shared.TextAttributeConstraints(), - default_value='accusantium', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='officia', - hidden=False, - hide_label=False, - icon='impedit', - info_helpers=shared.TextAttributeInfoHelpers( - hint_custom_component='quasi', - hint_text='blanditiis', - hint_text_key='eius', - hint_tooltip_placement='top', - ), - label='quisquam', - layout='full_width', - multiline=False, - name='Gayle Mraz', - order=0, - placeholder='magnam', - preview_value_formatter='reprehenderit', - protected=False, - readonly=False, - render_condition='quod', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.TextAttributeType.STRING, - value_formatter='quos', - ), - shared.RepeatableAttribute( - purpose=[ - '73a40e19-42f3-42e5-9055-756f5d56d0bd', - ], - constraints=shared.RepeatableAttributeConstraints(), - default_value='perferendis', - deprecated=False, - enable_relation_picker=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='id', - has_primary=False, - hidden=False, - hide_label=False, - icon='sapiente', - info_helpers=shared.RepeatableAttributeInfoHelpers( - hint_custom_component='sed', - hint_text='possimus', - hint_text_key='repellat', - hint_tooltip_placement='top', - ), - label='repudiandae', - layout='full_width', - name='Josephine Stroman', - order=0, - placeholder='voluptatibus', - preview_value_formatter='iure', - protected=False, - readonly=False, - relation_affinity_mode=shared.RepeatableAttributeRelationAffinityMode.WEAK, - render_condition='minus', - repeatable=False, - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.RepeatableAttributeType.PAYMENT, - value_formatter='dolorum', - ), - shared.MultiSelectAttribute( - purpose=[ - '8941aebc-0b80-4a69-a4d3-b2ecfcc8f895', - '010f5dd3-d6fa-4180-8e54-c82f168a363c', - '8873e484-380b-41f6-b8ca-275a60a04c49', - '5cc69917-1b51-4c1b-9b1c-f4b888ebdfc4', - ], - allow_any=False, - allow_extra_options=False, - constraints=shared.MultiSelectAttributeConstraints(), - default_value='quod', - deprecated=False, - disable_case_sensitive=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='minus', - hidden=False, - hide_label=False, - icon='porro', - info_helpers=shared.MultiSelectAttributeInfoHelpers( - hint_custom_component='id', - hint_text='excepturi', - hint_text_key='occaecati', - hint_tooltip_placement='top', - ), - label='libero', - layout='full_width', - name='Cory Welch DDS', - options=[ - shared.MultiSelectAttributeOptions2( - title='Miss', - value='recusandae', - ), - ], - order=0, - placeholder='veritatis', - preview_value_formatter='aut', - protected=False, - readonly=False, - render_condition='laudantium', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - type=shared.MultiSelectAttributeType.MULTISELECT, - value_formatter='dolor', + value_formatter='veritatis', ), ], feature_flag='FF_MY_FEATURE_FLAG', @@ -926,126 +360,49 @@ req = operations.PutSchemaRequest( title='Messaging', ui_hooks=[ { - "magni": 'rerum', - "doloremque": 'voluptatem', - }, - { - "at": 'eum', - "reprehenderit": 'voluptatum', - }, - { - "nihil": 'atque', - "rerum": 'deserunt', - "atque": 'nostrum', - }, - { - "architecto": 'est', - "enim": 'rem', - "magni": 'quae', + "consequuntur": 'quasi', }, ], ), ], dialog_config={ - "placeat": 'enim', - "labore": 'sapiente', - "saepe": 'delectus', + "similique": 'culpa', }, draft=False, enable_setting=[ '360_features', - '360_features', - '360_features', ], explicit_search_mappings={ - "cumque": shared.SearchMappings( + "aliquid": shared.SearchMappings( fields_={ - "quaerat": 'doloribus', - "quia": 'officiis', - "mollitia": 'cumque', + "tenetur": 'quae', }, index=False, - type=shared.SearchMappingsType.INTEGER, - ), - "enim": shared.SearchMappings( - fields_={ - "nemo": 'illum', - "nesciunt": 'sit', - }, - index=False, - type=shared.SearchMappingsType.LONG, - ), - "minus": shared.SearchMappings( - fields_={ - "recusandae": 'voluptates', - "praesentium": 'dicta', - "fugit": 'sit', - "aliquid": 'necessitatibus', - }, - index=False, - type=shared.SearchMappingsType.TEXT, + type=shared.SearchMappingsType.NESTED, ), }, feature_flag='FF_MY_FEATURE_FLAG', group_settings=[ shared.EntitySchemaGroupSettings( purpose=[ - '3fa4a41c-480d-43f2-932a-f03102d514f4', - ], - expanded=False, - feature_flag='FF_MY_FEATURE_FLAG', - id='cc6f18bf-9621-4a6a-8f77-a87ee3e4be75', - info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( - default='explicabo', - key='impedit', - ), - label='aliquid', - order=339843, - render_condition='_is_composite_price = "false"', - setting_flag='MY_SETTING', - ), - shared.EntitySchemaGroupSettings( - purpose=[ - '34418e3b-b91c-48d9-b5e0-e8419d8f84f1', - '44f3e07e-dcc4-4aa5-b3ca-bd905a972e05', - '6728227b-2d30-4947-8bf7-a4fa87cf535a', - ], - expanded=False, - feature_flag='FF_MY_FEATURE_FLAG', - id='6fae54eb-f60c-4321-b023-b75d2367fe1a', - info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( - default='accusantium', - key='quod', - ), - label='minus', - order=550994, - render_condition='_is_composite_price = "false"', - setting_flag='MY_SETTING', - ), - shared.EntitySchemaGroupSettings( - purpose=[ - 'f79f0a39-6d90-4c36-8b7c-15dfbace188b', - '1c4ee2c8-c6ce-4611-beeb-1c7cbdb6eec7', - '4378ba25-3177-447d-8915-ad2caf5dd672', - '3dc0f5ae-2f3a-46b7-8087-8756143f5a6c', + '674bdb04-f157-4560-82d6-8ea19f1d1705', ], expanded=False, feature_flag='FF_MY_FEATURE_FLAG', - id='98b55554-080d-440b-8acc-6cbd6b5f3ec9', + id='1339d080-86a1-4840-b94c-26071f93f5f0', info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( - default='voluptatem', - key='provident', + default='ea', + key='quaerat', ), - label='adipisci', - order=34267, + label='consequuntur', + order=831520, render_condition='_is_composite_price = "false"', setting_flag='MY_SETTING', ), ], icon='person', layout_settings={ - "repellat": 'omnis', - "explicabo": 'vel', + "officia": 'maxime', }, name='Contact', plural='Contacts', @@ -1053,8 +410,9 @@ req = operations.PutSchemaRequest( slug='contact', title_template='{{first_name}} {{last_name}}', ui_config=shared.EntitySchemaUIConfig( - create_view=shared.EntityViewDisabled( - view_type=shared.EntityViewDisabledViewType.DISABLED, + create_view=shared.RedirectEntityView( + route='/app/pricing-hub/product/:entityId', + view_type=shared.RedirectEntityViewViewType.REDIRECT, ), edit_view=shared.RedirectEntityView( route='/app/pricing-hub/product/:entityId', @@ -1062,34 +420,7 @@ req = operations.PutSchemaRequest( ), list_item=shared.EntitySchemaUIConfigListItem( summary_attributes=[ - shared.SummaryAttribute( - feature_flag='ipsam', - label='nostrum', - render_condition='sequi', - setting_flag='voluptatum', - show_as_tag=False, - tag_color='quasi', - value='error', - ), 'email', - shared.SummaryAttribute( - feature_flag='voluptate', - label='eius', - render_condition='expedita', - setting_flag='aperiam', - show_as_tag=False, - tag_color='voluptates', - value='possimus', - ), - shared.SummaryAttribute( - feature_flag='voluptatem', - label='repudiandae', - render_condition='corporis', - setting_flag='ea', - show_as_tag=False, - tag_color='eos', - value='aliquam', - ), ], ), sharing=shared.EntitySchemaUIConfigSharing( @@ -1099,11 +430,36 @@ req = operations.PutSchemaRequest( route='/app/pricing-hub/product/:entityId', view_type=shared.RedirectEntityViewViewType.REDIRECT, ), - table_view=shared.EntityViewDisabled( - view_type=shared.EntityViewDisabledViewType.DISABLED, + table_view=shared.EntityDefaultTable( + classic_view='quaerat', + dropdown_items=[ + shared.EntityDefaultTableDropdownItems2( + feature_flag='FF_MY_FEATURE_FLAG', + legacy=False, + title='Opportunities', + type=shared.EntityDefaultTableDropdownItems2Type.LINK, + uri='quod', + ), + ], + enable_thumbnails=False, + navbar_actions=[ + shared.EntityDefaultTableNavbarActions( + options=[ + shared.EntityDefaultTableNavbarActionsOptions( + label='labore', + params=shared.EntityDefaultTableNavbarActionsOptionsParams(), + ), + ], + type='ab', + ), + ], + row_actions=[ + 'adipisci', + ], + view_type=shared.EntityDefaultTableViewType.DEFAULT, ), ), - version=980649, + version=683573, ), draft=False, slug='contact', diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index 796522792..4d17f5253 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -98,13 +98,10 @@ s = epilot.Epilot( req = operations.TaxonomiesClassificationsSearchRequest( request_body=operations.TaxonomiesClassificationsSearchRequestBody( classification_ids=[ - '639a910a-bdca-4b62-a766-96e1ec00221b', - '335d89ac-b3ec-4fda-8d0c-549ef0300497', - '8a61fa1c-f206-488f-b7c1-ffc71dca163f', - '2a3c80a9-7ff3-434c-9df8-57a9e61876c6', + 'a63aae8d-6786-44db-b675-fd5e60b375ed', ], ), - taxonomy_slug='mollitia', + taxonomy_slug='numquam', ) res = s.taxonomy.taxonomies_classifications_search(req) @@ -142,9 +139,9 @@ s = epilot.Epilot( ) req = operations.TaxonomyAutocompleteRequest( - query='quidem', - size=1265.12, - taxonomy_slug='et', + query='doloribus', + size=3817.6, + taxonomy_slug='reiciendis', ) res = s.taxonomy.taxonomy_autocomplete(req) @@ -186,93 +183,31 @@ req = operations.UpdateClassificationsForTaxonomyRequest( classifications_update=shared.ClassificationsUpdate( create=[ shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-05-20T09:40:46.168Z'), - id='dfc94d6f-ecd7-4993-9006-6a6d2d000355', + created_at=dateutil.parser.isoparse('2021-03-11T09:18:18.070Z'), + id='e41f3331-7fe3-45b6-8eb1-ea426555ba3c', name='Wallbox PV', parents=[ - '38cec086-fa21-4e91-92cb-3119167b8e3c', + '28744ed5-3b88-4f3a-8d8f-5c0b2f2fb7b1', ], - updated_at=dateutil.parser.isoparse('2021-04-20T17:26:00.007Z'), - ), - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-12-07T22:47:43.718Z'), - id='3408d6d3-64ff-4d45-9906-d1263d48e935', - name='Wallbox PV', - parents=[ - '2c9e81f3-0be3-4e43-a02d-721657650664', - '1870d9d2-1f9a-4d03-8c4e-cc11a0836429', - '068b8502-a55e-47f7-bbc8-45e320a319f4', - 'badf947c-9a86-47bc-8242-6665816ddca8', - ], - updated_at=dateutil.parser.isoparse('2020-01-24T15:21:03.821Z'), - ), - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-12-05T12:01:23.554Z'), - id='fcb4c593-ec12-4cda-ad0e-c7afedbd80df', - name='Wallbox PV', - parents=[ - '48a47f93-90c5-4888-8983-dabf9ef3ffdd', - '9f7f079a-f4d3-4572-8cdb-0f4d281187d5', - ], - updated_at=dateutil.parser.isoparse('2022-06-27T23:18:05.509Z'), - ), - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-09-12T21:05:38.468Z'), - id='eded85a9-065e-4628-bdfc-2032b6c87992', - name='Wallbox PV', - parents=[ - 'b7e13584-f7ae-412c-a891-f82ce1157172', - ], - updated_at=dateutil.parser.isoparse('2022-12-12T20:07:27.803Z'), + updated_at=dateutil.parser.isoparse('2022-06-01T06:14:54.164Z'), ), ], delete=[ - '377dcfa8-9df9-475e-b566-86092e9c3ddc', - '5f111dea-1026-4d54-9a4d-190feb21780b', + 'a276b269-16fe-41f0-8f42-94e3698f447f', ], update=[ shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2020-09-25T02:22:59.870Z'), - id='0dbbddb4-8470-48fb-8e39-1e6bc158c4c4', - name='Wallbox PV', - parents=[ - '54599ea3-4226-40e9-b200-ce78a1bd8fb7', - 'a0a116ce-723d-4409-bfa3-0e9af725b291', - '22030d83-f5ae-4b77-99d2-2e8c1f849382', - '5fdc42c8-76c2-4c2d-bb4c-fc1c76230f84', - ], - updated_at=dateutil.parser.isoparse('2022-01-08T03:54:51.622Z'), - ), - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-10-18T09:43:56.655Z'), - id='bd23fdb1-4db6-4be5-a685-998e22ae20da', - name='Wallbox PV', - parents=[ - '6fc2b271-a289-4c57-a854-e90439d22246', - ], - updated_at=dateutil.parser.isoparse('2022-07-29T05:03:39.225Z'), - ), - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-06-19T06:43:31.808Z'), - id='62407084-f7ab-437c-af02-225194db5541', - name='Wallbox PV', - parents=[ - 'adc669af-90a2-46c7-8dc9-81f068981d6b', - ], - updated_at=dateutil.parser.isoparse('2022-07-20T11:17:27.497Z'), - ), - shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-03-17T08:05:23.562Z'), - id='faa348c3-1bf4-407e-a4fc-f0c42b78f156', + created_at=dateutil.parser.isoparse('2022-12-22T16:38:34.482Z'), + id='3e8b445e-80ca-455e-bd20-e457e1858b6a', name='Wallbox PV', parents=[ - '6398a0dc-7663-424c-8b06-c8ca12d02529', + '89fbe3a5-aa8e-4482-8d0a-b4075088e518', ], - updated_at=dateutil.parser.isoparse('2022-07-07T09:19:49.741Z'), + updated_at=dateutil.parser.isoparse('2022-11-05T22:13:21.002Z'), ), ], ), - taxonomy_slug='alias', + taxonomy_slug='sit', ) res = s.taxonomy.update_classifications_for_taxonomy(req) diff --git a/entity/files.gen b/entity/files.gen index a6ac03533..a4f404b6a 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -102,6 +102,7 @@ src/epilot/models/shared/invitationemailattribute.py src/epilot/models/shared/automationattribute.py src/epilot/models/shared/internaluserattribute.py src/epilot/models/shared/purposeattribute.py +src/epilot/models/shared/partnerorganisationattribute.py src/epilot/models/shared/taxonomyclassification.py src/epilot/models/shared/entityschema.py src/epilot/models/shared/taxonomy.py @@ -375,6 +376,10 @@ docs/models/shared/purposeattributeconstraints.md docs/models/shared/purposeattributeinfohelpers.md docs/models/shared/purposeattributetype.md docs/models/shared/purposeattribute.md +docs/models/shared/partnerorganisationattributeconstraints.md +docs/models/shared/partnerorganisationattributeinfohelpers.md +docs/models/shared/partnerorganisationattributetype.md +docs/models/shared/partnerorganisationattribute.md docs/models/shared/taxonomyclassification.md docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md docs/models/shared/entityschemagroupsettings.md diff --git a/entity/gen.yaml b/entity/gen.yaml index 5799d4444..a6d44e472 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,9 +1,9 @@ configVersion: 1.0.0 management: - docChecksum: da8519d9328e11a8d680212f59139216 + docChecksum: d9e9a66c98b8d69e3c80131964ce5f1f docVersion: 1.0.0 - speakeasyVersion: 1.78.3 - generationVersion: 2.96.3 + speakeasyVersion: 1.82.0 + generationVersion: 2.107.0 generation: sdkClassName: epilot sdkFlattening: true @@ -15,7 +15,7 @@ features: globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.23.2 + version: 1.23.3 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 70ae3d0f6..eda8e8708 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.23.2", + version="1.23.3", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index 2b3ee246f..1cba58da5 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -32,6 +32,7 @@ from .multiselectattribute import * from .numberattribute import * from .orderedlistattribute import * +from .partnerorganisationattribute import * from .partnerstatusattribute import * from .paymentmethodrelationattribute import * from .purposeattribute import * @@ -54,4 +55,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigSharing","EntitySchemaUIConfig","EntitySchemaUIConfigListItem","EntitySchemaUIConfigSharing","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsResp","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] +__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigSharing","EntitySchemaUIConfig","EntitySchemaUIConfigListItem","EntitySchemaUIConfigSharing","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsResp","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] diff --git a/entity/src/epilot/models/shared/activityitem.py b/entity/src/epilot/models/shared/activityitem.py index 390675793..366474d32 100755 --- a/entity/src/epilot/models/shared/activityitem.py +++ b/entity/src/epilot/models/shared/activityitem.py @@ -7,7 +7,6 @@ from dataclasses_json import Undefined, dataclass_json from datetime import datetime from epilot import utils -from marshmallow import fields from typing import Any, Optional @@ -15,7 +14,6 @@ @dataclasses.dataclass class ActivityItem: - r"""Success""" message: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message') }}) r"""Message for activity. Supports handlebars syntax.""" title: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title') }}) @@ -28,6 +26,6 @@ class ActivityItem: operations_total: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('operations_total'), 'exclude': lambda f: f is None }}) r"""Count of total operations attached to this activity""" payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) - timestamp: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timestamp'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + timestamp: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timestamp'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitysearchresults.py b/entity/src/epilot/models/shared/entitysearchresults.py index 2136d4995..80028671e 100755 --- a/entity/src/epilot/models/shared/entitysearchresults.py +++ b/entity/src/epilot/models/shared/entitysearchresults.py @@ -17,7 +17,6 @@ class EntitySearchResultsAggregations: @dataclasses.dataclass class EntitySearchResults: - r"""Success""" aggregations: Optional[EntitySearchResultsAggregations] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggregations'), 'exclude': lambda f: f is None }}) hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) results: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py index 0e2cac0b6..5c28fe277 100755 --- a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py +++ b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py @@ -11,7 +11,6 @@ @dataclasses.dataclass class GetRelationsRespWithPagination: - r"""Success""" hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) relations: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/partnerorganisationattribute.py b/entity/src/epilot/models/shared/partnerorganisationattribute.py new file mode 100755 index 000000000..bc0920b78 --- /dev/null +++ b/entity/src/epilot/models/shared/partnerorganisationattribute.py @@ -0,0 +1,101 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from dataclasses_json import Undefined, dataclass_json +from enum import Enum +from epilot import utils +from typing import Any, Optional + + + +@dataclasses.dataclass +class PartnerOrganisationAttributeConstraints: + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + + + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class PartnerOrganisationAttributeInfoHelpers: + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + hint_custom_component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_custom_component'), 'exclude': lambda f: f is None }}) + r"""The name of the custom component to be used as the hint helper. + The component should be registered in the `@epilot360/entity-ui` on the index of the components directory. + When specified it overrides the `hint_text` or `hint_text_key` configuration. + """ + hint_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text'), 'exclude': lambda f: f is None }}) + r"""The text to be displayed in the attribute hint helper. + When specified it overrides the `hint_text_key` configuration. + """ + hint_text_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_text_key'), 'exclude': lambda f: f is None }}) + r"""The key of the hint text to be displayed in the attribute hint helper. + The key should be a valid i18n key. + """ + hint_tooltip_placement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hint_tooltip_placement'), 'exclude': lambda f: f is None }}) + r"""The placement of the hint tooltip. + The value should be a valid `@mui/core` tooltip placement. + """ + + + +class PartnerOrganisationAttributeType(str, Enum): + PARTNER_ORGANISATION = 'partner_organisation' + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class PartnerOrganisationAttribute: + r"""Shared Partner Organisations""" + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + constraints: Optional[PartnerOrganisationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) + r"""A set of constraints applicable to the attribute. + These constraints should and will be enforced by the attribute renderer. + """ + default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` disables editing the attribute on the entity builder UI""" + feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) + r"""This attribute should only be active when the feature flag is enabled""" + group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) + r"""Which group the attribute should appear in. Accepts group ID or group name""" + hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + r"""Do not render attribute in entity views""" + hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) + r"""When set to true, will hide the label of the field.""" + icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) + r"""Code name of the icon to used to represent this attribute. + The value must be a valid @epilot/base-elements Icon name + """ + info_helpers: Optional[PartnerOrganisationAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) + r"""A set of configurations meant to document and assist the user in filling the attribute.""" + layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) + order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) + r"""Attribute sort order (ascending) in group""" + placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) + preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + r"""Setting to `true` prevents the attribute from being modified / deleted""" + readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) + r"""Defines the conditional rendering expression for showing this field. + When a valid expression is parsed, their evaluation defines the visibility of this attribute. + Note: Empty or invalid expression have no effect on the field visibility. + """ + required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) + r"""This attribute should only be active when the setting is enabled""" + show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) + r"""Render as a column in table views. When defined, overrides `hidden`""" + type: Optional[PartnerOrganisationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) + + diff --git a/entity/src/epilot/models/shared/purposeattribute.py b/entity/src/epilot/models/shared/purposeattribute.py index ea4ceadd3..1d741768d 100755 --- a/entity/src/epilot/models/shared/purposeattribute.py +++ b/entity/src/epilot/models/shared/purposeattribute.py @@ -7,7 +7,6 @@ from datetime import datetime from enum import Enum from epilot import utils -from marshmallow import fields from typing import Any, Optional @@ -62,7 +61,7 @@ class PurposeAttribute: r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) @@ -102,7 +101,7 @@ class PurposeAttribute: show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" type: Optional[PurposeAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/relationitem.py b/entity/src/epilot/models/shared/relationitem.py index 0a022d9b0..20b199cce 100755 --- a/entity/src/epilot/models/shared/relationitem.py +++ b/entity/src/epilot/models/shared/relationitem.py @@ -11,7 +11,6 @@ @dataclasses.dataclass class RelationItem: - r"""Success""" attribute: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attribute') }}) entity_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_id') }}) tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/taxonomy.py b/entity/src/epilot/models/shared/taxonomy.py index 586d1c42d..698366dee 100755 --- a/entity/src/epilot/models/shared/taxonomy.py +++ b/entity/src/epilot/models/shared/taxonomy.py @@ -6,7 +6,6 @@ from dataclasses_json import Undefined, dataclass_json from datetime import datetime from epilot import utils -from marshmallow import fields from typing import Optional @@ -14,14 +13,13 @@ @dataclasses.dataclass class Taxonomy: - r"""Taxonomy""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag""" slug: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) r"""URL-friendly name for taxonomy""" - created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) plural: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plural'), 'exclude': lambda f: f is None }}) r"""Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags""" - updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/taxonomyclassification.py b/entity/src/epilot/models/shared/taxonomyclassification.py index 07a70195b..3e28a7c16 100755 --- a/entity/src/epilot/models/shared/taxonomyclassification.py +++ b/entity/src/epilot/models/shared/taxonomyclassification.py @@ -6,7 +6,6 @@ from dataclasses_json import Undefined, dataclass_json from datetime import datetime from epilot import utils -from marshmallow import fields from typing import Optional @@ -15,9 +14,9 @@ @dataclasses.dataclass class TaxonomyClassification: name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) parents: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) - updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) + updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/sdk.py b/entity/src/epilot/sdk.py index 822107785..5e8e22ac2 100755 --- a/entity/src/epilot/sdk.py +++ b/entity/src/epilot/sdk.py @@ -43,7 +43,8 @@ def __init__(self, server_idx: int = None, server_url: str = None, url_params: dict[str, str] = None, - client: requests_http.Session = None + client: requests_http.Session = None, + retry_config: utils.RetryConfig = None ) -> None: """Instantiates the SDK configuring it with the provided parameters. @@ -56,7 +57,9 @@ def __init__(self, :param url_params: Parameters to optionally template the server URL with :type url_params: dict[str, str] :param client: The requests.Session HTTP client to use for all operations - :type client: requests_http.Session + :type client: requests_http.Session + :param retry_config: The utils.RetryConfig to use globally + :type retry_config: utils.RetryConfig """ if client is None: client = requests_http.Session() @@ -67,7 +70,7 @@ def __init__(self, if url_params is not None: server_url = utils.template_url(server_url, url_params) - self.sdk_configuration = SDKConfiguration(client, security_client, server_url, server_idx) + self.sdk_configuration = SDKConfiguration(client, security_client, server_url, server_idx, retry_config=retry_config) self._init_sdks() diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 90fed593c..5256feeb7 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -3,6 +3,8 @@ import requests from dataclasses import dataclass +from .utils.retries import RetryConfig + SERVERS = [ 'https://entity.sls.epilot.io', @@ -17,8 +19,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.23.2' - gen_version: str = '2.96.3' + sdk_version: str = '1.23.3' + gen_version: str = '2.107.0' + retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: diff --git a/entity/src/epilot/utils/utils.py b/entity/src/epilot/utils/utils.py index c91b0c049..05eafba6c 100755 --- a/entity/src/epilot/utils/utils.py +++ b/entity/src/epilot/utils/utils.py @@ -5,6 +5,7 @@ import re from dataclasses import Field, dataclass, fields, is_dataclass, make_dataclass from datetime import date, datetime +from decimal import Decimal from email.message import Message from enum import Enum from typing import Any, Callable, Optional, Tuple, Union, get_args, get_origin @@ -193,7 +194,7 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass f"{pp_key},{_val_to_string(param[pp_key])}") path = path.replace( '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - elif not isinstance(param, (str, int, float, complex, bool)): + elif not isinstance(param, (str, int, float, complex, bool, Decimal)): pp_vals: list[str] = [] param_fields: Tuple[Field, ...] = fields(param) for param_field in param_fields: @@ -737,6 +738,36 @@ def datefromisoformat(date_str: str): return dateutil.parser.parse(date_str).date() +def bigintencoder(optional: bool): + def bigintencode(val: int): + if optional and val is None: + return None + return str(val) + + return bigintencode + + +def bigintdecoder(val): + return int(val) + + +def decimalencoder(optional: bool, as_str: bool): + def decimalencode(val: Decimal): + if optional and val is None: + return None + + if as_str: + return str(val) + + return float(val) + + return decimalencode + + +def decimaldecoder(val): + return Decimal(str(val)) + + def get_field_name(name): def override(_, _field_name=name): return _field_name From 552585bd494307945c6a7a624162566d2cd02a1e Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 12 Sep 2023 01:11:22 +0000 Subject: [PATCH 35/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.82.5 --- entity/RELEASES.md | 10 +++++++++- entity/gen.yaml | 8 ++++---- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 16 insertions(+), 8 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index e668d0814..929b2da45 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -252,4 +252,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.82.0 (2.107.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.23.3] entity \ No newline at end of file +- [python v1.23.3] entity + +## 2023-09-12 01:10:58 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.82.5 (2.108.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.23.4] entity \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index a6d44e472..82d44fd36 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: d9e9a66c98b8d69e3c80131964ce5f1f docVersion: 1.0.0 - speakeasyVersion: 1.82.0 - generationVersion: 2.107.0 + speakeasyVersion: 1.82.5 + generationVersion: 2.108.3 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.85.3 + core: 2.85.4 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.23.3 + version: 1.23.4 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index eda8e8708..198a13de0 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.23.3", + version="1.23.4", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 5256feeb7..e03c5cdb7 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,8 +19,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.23.3' - gen_version: str = '2.107.0' + sdk_version: str = '1.23.4' + gen_version: str = '2.108.3' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: From 0ffe6ace6a775935adade5b4d6787827f8163ff4 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 13 Sep 2023 01:14:17 +0000 Subject: [PATCH 36/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.82.5 --- entity/RELEASES.md | 10 +++++++++- entity/docs/models/operations/addrelationsrequest.md | 1 + entity/docs/models/operations/deleterelationrequest.md | 1 + entity/docs/models/operations/updaterelationrequest.md | 1 + entity/docs/sdks/relations/README.md | 3 +++ entity/gen.yaml | 4 ++-- entity/setup.py | 2 +- entity/src/epilot/models/operations/addrelations.py | 2 ++ entity/src/epilot/models/operations/deleterelation.py | 2 ++ entity/src/epilot/models/operations/updaterelation.py | 2 ++ entity/src/epilot/sdkconfiguration.py | 2 +- 11 files changed, 25 insertions(+), 5 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 929b2da45..56ea45dc3 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -260,4 +260,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.82.5 (2.108.3) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.23.4] entity \ No newline at end of file +- [python v1.23.4] entity + +## 2023-09-13 01:13:53 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.82.5 (2.108.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.23.5] entity \ No newline at end of file diff --git a/entity/docs/models/operations/addrelationsrequest.md b/entity/docs/models/operations/addrelationsrequest.md index 639381cd2..62a5f2a79 100755 --- a/entity/docs/models/operations/addrelationsrequest.md +++ b/entity/docs/models/operations/addrelationsrequest.md @@ -6,6 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `request_body` | list[[shared.RelationItem](../../models/shared/relationitem.md)] | :heavy_minus_sign: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | | `id` | *str* | :heavy_check_mark: | Entity id | | | `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleterelationrequest.md b/entity/docs/models/operations/deleterelationrequest.md index 87257128d..e20e7c9a2 100755 --- a/entity/docs/models/operations/deleterelationrequest.md +++ b/entity/docs/models/operations/deleterelationrequest.md @@ -5,6 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | | `attribute` | *str* | :heavy_check_mark: | The attribute that express meaning | | | `entity_id` | *str* | :heavy_check_mark: | The attribute that express meaning | | diff --git a/entity/docs/models/operations/updaterelationrequest.md b/entity/docs/models/operations/updaterelationrequest.md index 9660a22bb..f7302c10e 100755 --- a/entity/docs/models/operations/updaterelationrequest.md +++ b/entity/docs/models/operations/updaterelationrequest.md @@ -6,6 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `request_body` | [Optional[UpdateRelationRequestBody]](../../models/operations/updaterelationrequestbody.md) | :heavy_minus_sign: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | | `attribute` | *str* | :heavy_check_mark: | The attribute that express meaning | | | `entity_id` | *str* | :heavy_check_mark: | The attribute that express meaning | | diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index 24ab6d640..f859d3dd1 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -39,6 +39,7 @@ req = operations.AddRelationsRequest( reverse=False, ), ], + activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, id='1cddc692-601f-4b57-ab0d-5f0d30c5fbb2', slug='contact', @@ -79,6 +80,7 @@ s = epilot.Epilot( ) req = operations.DeleteRelationRequest( + activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, attribute='quis', entity_id='totam', @@ -224,6 +226,7 @@ req = operations.UpdateRelationRequest( 'repellendus', ], ), + activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, attribute='totam', entity_id='similique', diff --git a/entity/gen.yaml b/entity/gen.yaml index 82d44fd36..ebb0f4b48 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,6 +1,6 @@ configVersion: 1.0.0 management: - docChecksum: d9e9a66c98b8d69e3c80131964ce5f1f + docChecksum: b78749d0cc95dce884cbc769420e0522 docVersion: 1.0.0 speakeasyVersion: 1.82.5 generationVersion: 2.108.3 @@ -15,7 +15,7 @@ features: globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.23.4 + version: 1.23.5 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 198a13de0..170761340 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.23.4", + version="1.23.5", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/operations/addrelations.py b/entity/src/epilot/models/operations/addrelations.py index 974678c18..66458ac21 100755 --- a/entity/src/epilot/models/operations/addrelations.py +++ b/entity/src/epilot/models/operations/addrelations.py @@ -14,6 +14,8 @@ class AddRelationsRequest: r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Type""" + activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) + r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" request_body: Optional[list[shared_relationitem.RelationItem]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) diff --git a/entity/src/epilot/models/operations/deleterelation.py b/entity/src/epilot/models/operations/deleterelation.py index fce2e72e8..45d30e7fa 100755 --- a/entity/src/epilot/models/operations/deleterelation.py +++ b/entity/src/epilot/models/operations/deleterelation.py @@ -17,6 +17,8 @@ class DeleteRelationRequest: r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Type""" + activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) + r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" diff --git a/entity/src/epilot/models/operations/updaterelation.py b/entity/src/epilot/models/operations/updaterelation.py index 7d4cae986..40576b729 100755 --- a/entity/src/epilot/models/operations/updaterelation.py +++ b/entity/src/epilot/models/operations/updaterelation.py @@ -29,6 +29,8 @@ class UpdateRelationRequest: r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Type""" + activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) + r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" request_body: Optional[UpdateRelationRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index e03c5cdb7..912f6144e 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,7 +19,7 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.23.4' + sdk_version: str = '1.23.5' gen_version: str = '2.108.3' retry_config: RetryConfig = None From 6f3fee6c752b835d7bab79cf15fd8d0b2a28981f Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 16 Sep 2023 01:11:44 +0000 Subject: [PATCH 37/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.86.0 --- entity/README.md | 16 ++++++++-------- entity/RELEASES.md | 10 +++++++++- entity/docs/sdks/activity/README.md | 2 +- entity/docs/sdks/entities/README.md | 2 +- entity/docs/sdks/entityimport/README.md | 2 +- entity/docs/sdks/export/README.md | 2 +- entity/docs/sdks/relations/README.md | 2 +- entity/docs/sdks/savedviews/README.md | 2 +- entity/docs/sdks/schemas/README.md | 2 +- entity/docs/sdks/taxonomy/README.md | 2 +- entity/gen.yaml | 8 ++++---- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 13 files changed, 32 insertions(+), 24 deletions(-) diff --git a/entity/README.md b/entity/README.md index 8ffab887f..03b982670 100755 --- a/entity/README.md +++ b/entity/README.md @@ -40,14 +40,14 @@ if res.activity_item is not None: ## Available Resources and Operations -### [activity](docs/sdks/activity/README.md) +### [Activity](docs/sdks/activity/README.md) * [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 -### [entities](docs/sdks/entities/README.md) +### [Entities](docs/sdks/entities/README.md) * [autocomplete](docs/sdks/entities/README.md#autocomplete) - autocomplete * [create_entity](docs/sdks/entities/README.md#create_entity) - createEntity @@ -58,15 +58,15 @@ if res.activity_item is not None: * [update_entity](docs/sdks/entities/README.md#update_entity) - updateEntity * [upsert_entity](docs/sdks/entities/README.md#upsert_entity) - upsertEntity -### [entity_import](docs/sdks/entityimport/README.md) +### [EntityImport](docs/sdks/entityimport/README.md) * [import_entities](docs/sdks/entityimport/README.md#import_entities) - Import Entities -### [export](docs/sdks/export/README.md) +### [Export](docs/sdks/export/README.md) * [export_entities](docs/sdks/export/README.md#export_entities) - exportEntities -### [relations](docs/sdks/relations/README.md) +### [Relations](docs/sdks/relations/README.md) * [add_relations](docs/sdks/relations/README.md#add_relations) - addRelations * [delete_relation](docs/sdks/relations/README.md#delete_relation) - deleteRelation @@ -74,7 +74,7 @@ if res.activity_item is not None: * [get_relations_v2](docs/sdks/relations/README.md#get_relations_v2) - getRelationsV2 * [update_relation](docs/sdks/relations/README.md#update_relation) - updateRelation -### [saved_views](docs/sdks/savedviews/README.md) +### [SavedViews](docs/sdks/savedviews/README.md) * [create_saved_view](docs/sdks/savedviews/README.md#create_saved_view) - createSavedView * [delete_saved_view](docs/sdks/savedviews/README.md#delete_saved_view) - deleteSavedView @@ -83,7 +83,7 @@ if res.activity_item is not None: * [list_saved_views](docs/sdks/savedviews/README.md#list_saved_views) - listSavedViews * [update_saved_view](docs/sdks/savedviews/README.md#update_saved_view) - updateSavedView -### [schemas](docs/sdks/schemas/README.md) +### [Schemas](docs/sdks/schemas/README.md) * [delete_schema](docs/sdks/schemas/README.md#delete_schema) - deleteSchema * [get_schema](docs/sdks/schemas/README.md#get_schema) - getSchema @@ -93,7 +93,7 @@ if res.activity_item is not None: * [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 -### [taxonomy](docs/sdks/taxonomy/README.md) +### [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 diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 56ea45dc3..09d6dfc69 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -268,4 +268,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.82.5 (2.108.3) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.23.5] entity \ No newline at end of file +- [python v1.23.5] entity + +## 2023-09-16 01:11:19 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.86.0 (2.115.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.23.6] entity \ No newline at end of file diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md index c2f412d39..34e686fec 100755 --- a/entity/docs/sdks/activity/README.md +++ b/entity/docs/sdks/activity/README.md @@ -1,4 +1,4 @@ -# activity +# Activity ## Overview diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 97ed4db8b..475a58ca0 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -1,4 +1,4 @@ -# entities +# Entities ## Overview diff --git a/entity/docs/sdks/entityimport/README.md b/entity/docs/sdks/entityimport/README.md index c5bd7d36d..c989d8ec8 100755 --- a/entity/docs/sdks/entityimport/README.md +++ b/entity/docs/sdks/entityimport/README.md @@ -1,4 +1,4 @@ -# entity_import +# EntityImport ### Available Operations diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md index 09c89b007..5b74e18aa 100755 --- a/entity/docs/sdks/export/README.md +++ b/entity/docs/sdks/export/README.md @@ -1,4 +1,4 @@ -# export +# Export ## Overview diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index f859d3dd1..01c637063 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -1,4 +1,4 @@ -# relations +# Relations ## Overview diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index a1ab0a97f..0038934e4 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -1,4 +1,4 @@ -# saved_views +# SavedViews ## Overview diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index 05271ac08..29f9978c8 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -1,4 +1,4 @@ -# schemas +# Schemas ## Overview diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index 4d17f5253..d662adc0d 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -1,4 +1,4 @@ -# taxonomy +# Taxonomy ## Overview diff --git a/entity/gen.yaml b/entity/gen.yaml index ebb0f4b48..f3c07dda3 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: b78749d0cc95dce884cbc769420e0522 docVersion: 1.0.0 - speakeasyVersion: 1.82.5 - generationVersion: 2.108.3 + speakeasyVersion: 1.86.0 + generationVersion: 2.115.2 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.85.4 + core: 2.85.5 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.23.5 + version: 1.23.6 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 170761340..0163614c8 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.23.5", + version="1.23.6", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 912f6144e..e6c35cd7f 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,8 +19,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.23.5' - gen_version: str = '2.108.3' + sdk_version: str = '1.23.6' + gen_version: str = '2.115.2' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: From 8e601fc7f3836627cf81654fc59b58a79854a637 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 20 Sep 2023 01:13:45 +0000 Subject: [PATCH 38/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.88.0 --- entity/RELEASES.md | 10 +++++++++- entity/gen.yaml | 8 ++++---- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 4 ++-- 4 files changed, 16 insertions(+), 8 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 09d6dfc69..00bbc3547 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -276,4 +276,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.86.0 (2.115.2) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.23.6] entity \ No newline at end of file +- [python v1.23.6] entity + +## 2023-09-20 01:13:19 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.88.0 (2.118.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.23.7] entity \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index f3c07dda3..4f00ae9cb 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: b78749d0cc95dce884cbc769420e0522 docVersion: 1.0.0 - speakeasyVersion: 1.86.0 - generationVersion: 2.115.2 + speakeasyVersion: 1.88.0 + generationVersion: 2.118.1 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.85.5 + core: 2.85.6 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.23.6 + version: 1.23.7 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 0163614c8..f7f2ecb0f 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.23.6", + version="1.23.7", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index e6c35cd7f..0cb171819 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,8 +19,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.23.6' - gen_version: str = '2.115.2' + sdk_version: str = '1.23.7' + gen_version: str = '2.118.1' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: From 69d96a75331544cc0706a6c88ce20806950aa41f Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 22 Sep 2023 01:13:51 +0000 Subject: [PATCH 39/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.89.0 --- entity/README.md | 30 ++- entity/RELEASES.md | 10 +- .../models/shared/addressrelationattribute.md | 1 + .../docs/models/shared/automationattribute.md | 1 + entity/docs/models/shared/booleanattribute.md | 1 + .../docs/models/shared/computedattribute.md | 1 + entity/docs/models/shared/consentattribute.md | 1 + entity/docs/models/shared/countryattribute.md | 1 + .../docs/models/shared/currencyattribute.md | 3 +- ...rency1.md => currencyattributecurrency.md} | 2 +- entity/docs/models/shared/dateattribute.md | 1 + entity/docs/models/shared/fileattribute.md | 1 + entity/docs/models/shared/getrelationsresp.md | 11 -- .../docs/models/shared/internalattribute.md | 1 + .../models/shared/internaluserattribute.md | 1 + .../models/shared/invitationemailattribute.md | 1 + entity/docs/models/shared/linkattribute.md | 1 + .../models/shared/multiselectattribute.md | 1 + entity/docs/models/shared/numberattribute.md | 1 + .../models/shared/orderedlistattribute.md | 1 + .../shared/partnerorganisationattribute.md | 1 + .../models/shared/partnerstatusattribute.md | 1 + .../shared/paymentmethodrelationattribute.md | 1 + entity/docs/models/shared/purposeattribute.md | 1 + .../docs/models/shared/relationattribute.md | 1 + .../docs/models/shared/repeatableattribute.md | 1 + entity/docs/models/shared/selectattribute.md | 1 + .../docs/models/shared/sequenceattribute.md | 1 + entity/docs/models/shared/statusattribute.md | 1 + entity/docs/models/shared/tagsattribute.md | 1 + entity/docs/models/shared/textattribute.md | 1 + .../models/shared/userrelationattribute.md | 1 + entity/docs/sdks/activity/README.md | 20 +- entity/docs/sdks/entities/README.md | 26 +-- entity/docs/sdks/export/README.md | 8 +- entity/docs/sdks/relations/README.md | 34 ++-- entity/docs/sdks/savedviews/README.md | 16 +- entity/docs/sdks/schemas/README.md | 171 +++++++++--------- entity/docs/sdks/taxonomy/README.md | 30 +-- entity/files.gen | 22 +-- entity/gen.yaml | 8 +- entity/setup.py | 2 +- entity/src/epilot/models/shared/__init__.py | 3 +- .../models/shared/addressrelationattribute.py | 2 + .../models/shared/automationattribute.py | 2 + .../epilot/models/shared/booleanattribute.py | 2 + .../epilot/models/shared/computedattribute.py | 2 + .../epilot/models/shared/consentattribute.py | 2 + .../epilot/models/shared/countryattribute.py | 2 + .../epilot/models/shared/currencyattribute.py | 6 +- .../src/epilot/models/shared/dateattribute.py | 2 + .../src/epilot/models/shared/fileattribute.py | 2 + .../epilot/models/shared/getrelationsresp.py | 20 -- .../epilot/models/shared/internalattribute.py | 2 + .../models/shared/internaluserattribute.py | 2 + .../models/shared/invitationemailattribute.py | 2 + .../src/epilot/models/shared/linkattribute.py | 2 + .../models/shared/multiselectattribute.py | 2 + .../epilot/models/shared/numberattribute.py | 2 + .../models/shared/orderedlistattribute.py | 2 + .../shared/partnerorganisationattribute.py | 2 + .../models/shared/partnerstatusattribute.py | 2 + .../shared/paymentmethodrelationattribute.py | 2 + .../epilot/models/shared/purposeattribute.py | 2 + .../epilot/models/shared/relationattribute.py | 2 + .../models/shared/repeatableattribute.py | 2 + .../epilot/models/shared/selectattribute.py | 2 + .../epilot/models/shared/sequenceattribute.py | 2 + .../epilot/models/shared/statusattribute.py | 2 + .../src/epilot/models/shared/tagsattribute.py | 2 + .../src/epilot/models/shared/textattribute.py | 2 + .../models/shared/userrelationattribute.py | 2 + entity/src/epilot/sdkconfiguration.py | 4 +- 73 files changed, 294 insertions(+), 213 deletions(-) rename entity/docs/models/shared/{currencyattributecurrency1.md => currencyattributecurrency.md} (95%) delete mode 100755 entity/docs/models/shared/getrelationsresp.md delete mode 100755 entity/src/epilot/models/shared/getrelationsresp.py diff --git a/entity/README.md b/entity/README.md index 03b982670..b0cd92993 100755 --- a/entity/README.md +++ b/entity/README.md @@ -10,8 +10,6 @@ pip install git+https://github.com/epilot-dev/sdk-python.git#subdirectory=entity ## SDK Example Usage - - ```python import epilot from epilot.models import operations, shared @@ -24,7 +22,7 @@ s = epilot.Epilot( req = operations.AttachActivityRequest( entities=[ - '89bd9d8d-69a6-474e-8f46-7cc8796ed151', + 'a05dfc2d-df7c-4c78-8a1b-a928fc816742', ], id='01F130Q52Q6MWSNS8N2AVXV4JN', ) @@ -102,4 +100,30 @@ if res.activity_item is not None: * [update_classifications_for_taxonomy](docs/sdks/taxonomy/README.md#update_classifications_for_taxonomy) - updateClassificationsForTaxonomy + + + + + + + + + + + +# 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: + + + + + + + + ### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 00bbc3547..18077a815 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -284,4 +284,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.88.0 (2.118.1) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.23.7] entity \ No newline at end of file +- [python v1.23.7] entity + +## 2023-09-22 01:13:25 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.89.0 (2.125.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.23.8] entity \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattribute.md b/entity/docs/models/shared/addressrelationattribute.md index c08767185..a7b8382bd 100755 --- a/entity/docs/models/shared/addressrelationattribute.md +++ b/entity/docs/models/shared/addressrelationattribute.md @@ -31,5 +31,6 @@ Reference to an address attribute of another entity | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[AddressRelationAttributeType]](../../models/shared/addressrelationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/automationattribute.md b/entity/docs/models/shared/automationattribute.md index e97b4b423..f0806752c 100755 --- a/entity/docs/models/shared/automationattribute.md +++ b/entity/docs/models/shared/automationattribute.md @@ -30,5 +30,6 @@ Automation entity | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[AutomationAttributeType]](../../models/shared/automationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/booleanattribute.md b/entity/docs/models/shared/booleanattribute.md index 751ef8366..83a502ad8 100755 --- a/entity/docs/models/shared/booleanattribute.md +++ b/entity/docs/models/shared/booleanattribute.md @@ -30,5 +30,6 @@ Yes / No Toggle | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[BooleanAttributeType]](../../models/shared/booleanattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattribute.md b/entity/docs/models/shared/computedattribute.md index 2a18cb50f..ea4891fac 100755 --- a/entity/docs/models/shared/computedattribute.md +++ b/entity/docs/models/shared/computedattribute.md @@ -30,5 +30,6 @@ An attribute that is computed from the entity data. For more details on how to u | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[ComputedAttributeType]](../../models/shared/computedattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/consentattribute.md b/entity/docs/models/shared/consentattribute.md index b625fe4c5..375da754a 100755 --- a/entity/docs/models/shared/consentattribute.md +++ b/entity/docs/models/shared/consentattribute.md @@ -31,6 +31,7 @@ Consent Management | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `topic` | *str* | :heavy_check_mark: | N/A | | | `type` | [ConsentAttributeType](../../models/shared/consentattributetype.md) | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/countryattribute.md b/entity/docs/models/shared/countryattribute.md index 66f6ecda5..d734f6d41 100755 --- a/entity/docs/models/shared/countryattribute.md +++ b/entity/docs/models/shared/countryattribute.md @@ -30,5 +30,6 @@ Country picker | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[CountryAttributeType]](../../models/shared/countryattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattribute.md b/entity/docs/models/shared/currencyattribute.md index 9a0b33621..0a3812d7f 100755 --- a/entity/docs/models/shared/currencyattribute.md +++ b/entity/docs/models/shared/currencyattribute.md @@ -9,7 +9,7 @@ Currency input | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[CurrencyAttributeConstraints]](../../models/shared/currencyattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | -| `currency` | list[*Any*] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | +| `currency` | list[[CurrencyAttributeCurrency](../../models/shared/currencyattributecurrency.md)] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | | `currency_selector_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,6 @@ Currency input | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [CurrencyAttributeType](../../models/shared/currencyattributetype.md) | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattributecurrency1.md b/entity/docs/models/shared/currencyattributecurrency.md similarity index 95% rename from entity/docs/models/shared/currencyattributecurrency1.md rename to entity/docs/models/shared/currencyattributecurrency.md index 8a470028f..66d213167 100755 --- a/entity/docs/models/shared/currencyattributecurrency1.md +++ b/entity/docs/models/shared/currencyattributecurrency.md @@ -1,4 +1,4 @@ -# CurrencyAttributeCurrency1 +# CurrencyAttributeCurrency A currency configuration diff --git a/entity/docs/models/shared/dateattribute.md b/entity/docs/models/shared/dateattribute.md index bccf15a3f..43649e651 100755 --- a/entity/docs/models/shared/dateattribute.md +++ b/entity/docs/models/shared/dateattribute.md @@ -30,5 +30,6 @@ Date or Datetime picker | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[DateAttributeType]](../../models/shared/dateattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/fileattribute.md b/entity/docs/models/shared/fileattribute.md index 2be65e745..adb9c3b02 100755 --- a/entity/docs/models/shared/fileattribute.md +++ b/entity/docs/models/shared/fileattribute.md @@ -35,5 +35,6 @@ File or Image Attachment | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [FileAttributeType](../../models/shared/fileattributetype.md) | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/getrelationsresp.md b/entity/docs/models/shared/getrelationsresp.md deleted file mode 100755 index bd700b4b3..000000000 --- a/entity/docs/models/shared/getrelationsresp.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetRelationsResp - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `tags` | list[*str*] | :heavy_minus_sign: | N/A | -| `attribute` | *str* | :heavy_check_mark: | N/A | -| `entity_id` | *str* | :heavy_check_mark: | N/A | -| `reverse` | *Optional[bool]* | :heavy_minus_sign: | Whether this is a reverse relation | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattribute.md b/entity/docs/models/shared/internalattribute.md index e8bf81c0b..88f5067bd 100755 --- a/entity/docs/models/shared/internalattribute.md +++ b/entity/docs/models/shared/internalattribute.md @@ -30,5 +30,6 @@ No UI representation | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[InternalAttributeType]](../../models/shared/internalattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internaluserattribute.md b/entity/docs/models/shared/internaluserattribute.md index c72abf5ba..03a2edc50 100755 --- a/entity/docs/models/shared/internaluserattribute.md +++ b/entity/docs/models/shared/internaluserattribute.md @@ -30,5 +30,6 @@ Epilot internal user info | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[InternalUserAttributeType]](../../models/shared/internaluserattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/invitationemailattribute.md b/entity/docs/models/shared/invitationemailattribute.md index 7aee429b4..3537e8fa1 100755 --- a/entity/docs/models/shared/invitationemailattribute.md +++ b/entity/docs/models/shared/invitationemailattribute.md @@ -30,5 +30,6 @@ Email address for send invitation | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[InvitationEmailAttributeType]](../../models/shared/invitationemailattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/linkattribute.md b/entity/docs/models/shared/linkattribute.md index 11efa0568..7a898a93b 100755 --- a/entity/docs/models/shared/linkattribute.md +++ b/entity/docs/models/shared/linkattribute.md @@ -30,5 +30,6 @@ Link with title and href | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[LinkAttributeType]](../../models/shared/linkattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattribute.md b/entity/docs/models/shared/multiselectattribute.md index 85537955c..7622d371e 100755 --- a/entity/docs/models/shared/multiselectattribute.md +++ b/entity/docs/models/shared/multiselectattribute.md @@ -34,5 +34,6 @@ Multi Choice Selection | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[MultiSelectAttributeType]](../../models/shared/multiselectattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/numberattribute.md b/entity/docs/models/shared/numberattribute.md index 799ee73e0..8c3c883bb 100755 --- a/entity/docs/models/shared/numberattribute.md +++ b/entity/docs/models/shared/numberattribute.md @@ -31,5 +31,6 @@ Numeric input | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[NumberAttributeType]](../../models/shared/numberattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/orderedlistattribute.md b/entity/docs/models/shared/orderedlistattribute.md index f046bff3d..7e9bc77d4 100755 --- a/entity/docs/models/shared/orderedlistattribute.md +++ b/entity/docs/models/shared/orderedlistattribute.md @@ -30,5 +30,6 @@ Type of attribute to render N number of ordered fields | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[OrderedListAttributeType]](../../models/shared/orderedlistattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerorganisationattribute.md b/entity/docs/models/shared/partnerorganisationattribute.md index afed1e185..e792e4d42 100755 --- a/entity/docs/models/shared/partnerorganisationattribute.md +++ b/entity/docs/models/shared/partnerorganisationattribute.md @@ -30,5 +30,6 @@ Shared Partner Organisations | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[PartnerOrganisationAttributeType]](../../models/shared/partnerorganisationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerstatusattribute.md b/entity/docs/models/shared/partnerstatusattribute.md index 086850fae..a56225c9a 100755 --- a/entity/docs/models/shared/partnerstatusattribute.md +++ b/entity/docs/models/shared/partnerstatusattribute.md @@ -30,5 +30,6 @@ Partner Status | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[PartnerStatusAttributeType]](../../models/shared/partnerstatusattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/paymentmethodrelationattribute.md b/entity/docs/models/shared/paymentmethodrelationattribute.md index 87b23230b..9586f898f 100755 --- a/entity/docs/models/shared/paymentmethodrelationattribute.md +++ b/entity/docs/models/shared/paymentmethodrelationattribute.md @@ -31,5 +31,6 @@ Reference to a payment method attribute of another entity | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[PaymentMethodRelationAttributeType]](../../models/shared/paymentmethodrelationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/purposeattribute.md b/entity/docs/models/shared/purposeattribute.md index b07583ddb..6816d073d 100755 --- a/entity/docs/models/shared/purposeattribute.md +++ b/entity/docs/models/shared/purposeattribute.md @@ -33,6 +33,7 @@ Entity Taxonomy | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[PurposeAttributeType]](../../models/shared/purposeattributetype.md) | :heavy_minus_sign: | N/A | | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattribute.md b/entity/docs/models/shared/relationattribute.md index 12919256f..3b285a5fd 100755 --- a/entity/docs/models/shared/relationattribute.md +++ b/entity/docs/models/shared/relationattribute.md @@ -43,6 +43,7 @@ Entity Relationship | `search_placeholder` | *Optional[str]* | :heavy_minus_sign: | Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is. | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `summary_fields` | list[*Any*] | :heavy_minus_sign: | N/A | | | `type` | [Optional[RelationAttributeType]](../../models/shared/relationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/repeatableattribute.md b/entity/docs/models/shared/repeatableattribute.md index f9d592c2c..ba13a0dc0 100755 --- a/entity/docs/models/shared/repeatableattribute.md +++ b/entity/docs/models/shared/repeatableattribute.md @@ -34,5 +34,6 @@ Repeatable (add N number of fields) | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[RepeatableAttributeType]](../../models/shared/repeatableattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattribute.md b/entity/docs/models/shared/selectattribute.md index 215cc660e..c6f8051ec 100755 --- a/entity/docs/models/shared/selectattribute.md +++ b/entity/docs/models/shared/selectattribute.md @@ -32,5 +32,6 @@ Dropdown select | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[SelectAttributeType]](../../models/shared/selectattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/sequenceattribute.md b/entity/docs/models/shared/sequenceattribute.md index 8d06662ee..9eb78732b 100755 --- a/entity/docs/models/shared/sequenceattribute.md +++ b/entity/docs/models/shared/sequenceattribute.md @@ -31,6 +31,7 @@ Sequence of unique identifiers | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `start_number` | *Optional[int]* | :heavy_minus_sign: | N/A | | | `type` | [Optional[SequenceAttributeType]](../../models/shared/sequenceattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattribute.md b/entity/docs/models/shared/statusattribute.md index c9ca8d84d..f73ab4da9 100755 --- a/entity/docs/models/shared/statusattribute.md +++ b/entity/docs/models/shared/statusattribute.md @@ -31,5 +31,6 @@ Status select | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[StatusAttributeType]](../../models/shared/statusattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/tagsattribute.md b/entity/docs/models/shared/tagsattribute.md index d9429d68f..c8332cf8a 100755 --- a/entity/docs/models/shared/tagsattribute.md +++ b/entity/docs/models/shared/tagsattribute.md @@ -31,6 +31,7 @@ Tags | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `suggestions` | list[*str*] | :heavy_minus_sign: | N/A | | | `type` | [Optional[TagsAttributeType]](../../models/shared/tagsattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/textattribute.md b/entity/docs/models/shared/textattribute.md index 391f340eb..32ce14b7e 100755 --- a/entity/docs/models/shared/textattribute.md +++ b/entity/docs/models/shared/textattribute.md @@ -31,5 +31,6 @@ Textarea or text input | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[TextAttributeType]](../../models/shared/textattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/userrelationattribute.md b/entity/docs/models/shared/userrelationattribute.md index 0ff8d0527..b21332cde 100755 --- a/entity/docs/models/shared/userrelationattribute.md +++ b/entity/docs/models/shared/userrelationattribute.md @@ -31,5 +31,6 @@ User Relationship | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | +| `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `type` | [Optional[UserRelationAttributeType]](../../models/shared/userrelationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md index 34e686fec..1db3789a1 100755 --- a/entity/docs/sdks/activity/README.md +++ b/entity/docs/sdks/activity/README.md @@ -29,7 +29,7 @@ s = epilot.Epilot( req = operations.AttachActivityRequest( entities=[ - 'a05dfc2d-df7c-4c78-8a1b-a928fc816742', + 'cb739205-9293-496f-aa75-96eb10faaa23', ], id='01F130Q52Q6MWSNS8N2AVXV4JN', ) @@ -76,13 +76,13 @@ req = operations.CreateActivityRequest( activity=shared.Activity( message='{{caller}} did something with {{entity payload.entity.id}}.', payload={ - "impedit": 'cum', + "corporis": 'explicabo', }, title='My custom activity', type='MyCustomActivity', ), entities=[ - '73920592-9396-4fea-b596-eb10faaa2352', + 'c5955907-aff1-4a3a-afa9-467739251aa5', ], ) @@ -122,8 +122,8 @@ s = epilot.Epilot( req = operations.GetActivityRequest( id='01F130Q52Q6MWSNS8N2AVXV4JN', - operations_from=750686, - operations_size=315428, + operations_from=138183, + operations_size=778346, ) res = s.activity.get_activity(req) @@ -163,12 +163,12 @@ s = epilot.Epilot( ) req = operations.GetEntityActivityFeedRequest( - after=dateutil.parser.isoparse('2022-04-10T11:47:13.463Z'), - before=dateutil.parser.isoparse('2022-06-06T21:04:34.044Z'), - from_=38425, - id='7aff1a3a-2fa9-4467-b392-51aa52c3f5ad', + after=dateutil.parser.isoparse('2022-01-19T09:45:27.272Z'), + before=dateutil.parser.isoparse('2022-05-04T04:15:52.352Z'), + from_=820994, + id='019da1ff-e78f-4097-b007-4f15471b5e6e', include_relations=False, - size=13571, + size=64147, slug='contact', type='SyncActivity', ) diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 475a58ca0..ac89cb5f0 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -34,8 +34,8 @@ s = epilot.Epilot( req = operations.AutocompleteRequest( attribute='_tags', - input='quasi', - size=622846, + input='ipsum', + size=692472, slug='contact', ) @@ -100,7 +100,7 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( request_body={ - "temporibus": 'laborum', + "molestias": 'excepturi', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, @@ -148,7 +148,7 @@ s = epilot.Epilot( req = operations.DeleteEntityRequest( activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - id='1ffe78f0-97b0-4074-b154-71b5e6e13b99', + id='d488e1e9-1e45-40ad-aabd-44269802d502', slug='contact', ) @@ -251,7 +251,7 @@ s = epilot.Epilot( req = operations.GetEntityRequest( hydrate=False, - id='d488e1e9-1e45-40ad-aabd-44269802d502', + id='a94bb4f6-3c96-49e9-a3ef-a77dfb14cd66', slug='contact', ) @@ -318,12 +318,12 @@ s = epilot.Epilot( req = operations.PatchEntityRequest( request_body={ - "dolorum": 'excepturi', + "laborum": 'accusamus', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, dry_run=False, - id='4bb4f63c-969e-49a3-afa7-7dfb14cd66ae', + id='395efb9b-a88f-43a6-a997-074ba4469b6e', slug='contact', ) @@ -429,13 +429,13 @@ s = epilot.Epilot( req = shared.EntitySearchParams( aggs=shared.EntitySearchParamsAggs(), fields_=[ - 'non', + 'aspernatur', ], - from_=581273, + from_=102863, hydrate=False, include_scores=False, q='_schema:contact AND status:active', - size=313218, + size=298282, sort='_created_at:desc', ) @@ -500,11 +500,11 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( request_body={ - "accusamus": 'delectus', + "et": 'excepturi', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, - id='b9ba88f3-a669-4970-b4ba-4469b6e21419', + id='59890afa-563e-4251-afe4-c8b711e5b7fd', slug='contact', ) @@ -554,7 +554,7 @@ s = epilot.Epilot( req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( entity={ - "ullam": 'provident', + "sed": 'saepe', }, unique_key=[ 'email.0.email', diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md index 5b74e18aa..bae6395ff 100755 --- a/entity/docs/sdks/export/README.md +++ b/entity/docs/sdks/export/README.md @@ -28,18 +28,18 @@ req = operations.ExportEntitiesRequest( entity_search_params=shared.EntitySearchParams( aggs=shared.EntitySearchParamsAggs(), fields_=[ - 'quos', + 'pariatur', ], - from_=574325, + from_=37559, hydrate=False, include_scores=False, q='_schema:contact AND status:active', - size=33625, + size=162493, sort='_created_at:desc', ), is_template=False, job_id='abc123', - language='mollitia', + language='praesentium', ) res = s.export.export_entities(req) diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index 01c637063..2dbe2b4e0 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -32,16 +32,16 @@ req = operations.AddRelationsRequest( request_body=[ shared.RelationItem( tags=[ - 'reiciendis', + 'natus', ], - attribute='mollitia', - entity_id='563e2516-fe4c-48b7-91e5-b7fd2ed02892', + attribute='magni', + entity_id='1cddc692-601f-4b57-ab0d-5f0d30c5fbb2', reverse=False, ), ], activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, - id='1cddc692-601f-4b57-ab0d-5f0d30c5fbb2', + id='58705320-2c73-4d5f-a9b9-0c28909b3fe4', slug='contact', ) @@ -82,9 +82,9 @@ s = epilot.Epilot( req = operations.DeleteRelationRequest( activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, - attribute='quis', - entity_id='totam', - id='7053202c-73d5-4fe9-b90c-28909b3fe49a', + attribute='iste', + entity_id='dolorum', + id='8d9cbf48-6333-423f-9b77-f3a4100674eb', slug='contact', ) @@ -129,7 +129,7 @@ s = epilot.Epilot( req = operations.GetRelationsRequest( hydrate=False, - id='8d9cbf48-6333-423f-9b77-f3a4100674eb', + id='f69280d1-ba77-4a89-abf7-37ae4203ce5e', include_reverse=False, slug='contact', ) @@ -175,14 +175,14 @@ s = epilot.Epilot( req = operations.GetRelationsV2Request( fields_=[ - 'voluptatibus', + 'suscipit', ], - from_=377752, + from_=645785, hydrate=False, - id='9280d1ba-77a8-49eb-b737-ae4203ce5e6a', + id='95d8a0d4-46ce-42af-ba73-cf3be453f870', include_reverse=False, - query='provident', - size=324683, + query='expedita', + size=207470, slug='contact', ) @@ -223,14 +223,14 @@ s = epilot.Epilot( req = operations.UpdateRelationRequest( request_body=operations.UpdateRelationRequestBody( tags=[ - 'repellendus', + 'sed', ], ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, - attribute='totam', - entity_id='similique', - id='0d446ce2-af7a-473c-b3be-453f870b326b', + attribute='vel', + entity_id='libero', + id='5a73429c-db1a-4842-abb6-79d2322715bf', slug='contact', ) diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index 0038934e4..25bd64422 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -43,7 +43,7 @@ req = shared.SavedView( 'contact', ], ui_config={ - "deserunt": 'quam', + "cumque": 'soluta', }, ) @@ -82,7 +82,7 @@ s = epilot.Epilot( ) req = operations.DeleteSavedViewRequest( - id='3429cdb1-a842-42bb-a79d-2322715bf0cb', + id='b1e31b8b-90f3-4443-a110-8e0adcf4b921', ) res = s.saved_views.delete_saved_view(req) @@ -120,7 +120,7 @@ s = epilot.Epilot( ) req = operations.GetSavedViewRequest( - id='b1e31b8b-90f3-4443-a110-8e0adcf4b921', + id='879fce95-3f73-4ef7-bbc7-abd74dd39c0f', ) res = s.saved_views.get_saved_view(req) @@ -217,9 +217,9 @@ s = epilot.Epilot( req = operations.UpdateSavedViewRequest( saved_view=shared.SavedView( - created_by={ - "odio": 'occaecati', - }, + created_by=shared.SavedViewCreatedBy1( + user_id='10598', + ), is_favorited_by=[ '11701', ], @@ -230,10 +230,10 @@ req = operations.UpdateSavedViewRequest( 'contact', ], ui_config={ - "voluptatibus": 'quisquam', + "nulla": 'fugit', }, ), - id='e953f73e-f7fb-4c7a-bd74-dd39c0f5d2cf', + id='cff7c70a-4562-46d4-b681-3f16d9f5fce6', ) res = s.saved_views.update_saved_view(req) diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index 29f9978c8..8e5b72dbd 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -69,7 +69,7 @@ s = epilot.Epilot( ) req = operations.GetSchemaRequest( - id='f7c70a45-626d-4436-813f-16d9f5fce6c5', + id='c556146c-3e25-40fb-808c-42e141aac366', slug='contact', ) @@ -108,11 +108,11 @@ s = epilot.Epilot( ) req = operations.GetSchemaVersionsRequest( - drafts_from=3331.45, - drafts_size=3994.99, + drafts_from=7521.35, + drafts_size=5573.69, slug='contact', - versions_from=811.01, - versions_size=3018.31, + versions_from=8296.03, + versions_size=8605.52, ) res = s.schemas.get_schema_versions(req) @@ -217,8 +217,8 @@ s = epilot.Epilot( ) req = operations.ListTaxonomyClassificationsForSchemaRequest( - query='ea', - size=7752.2, + query='voluptas', + size=7270.44, slug='contact', taxonomy_slug='purpose', ) @@ -261,96 +261,83 @@ s = epilot.Epilot( req = operations.PutSchemaRequest( entity_schema=shared.EntitySchema( attributes=[ - shared.MultiSelectAttribute( + shared.DateAttribute( purpose=[ - 'e250fb00-8c42-4e14-9aac-366c8dd6b144', + '44290747-4778-4a7b-9466-d28c10ab3cdc', ], - allow_any=False, - allow_extra_options=False, - constraints=shared.MultiSelectAttributeConstraints(), - default_value='explicabo', + constraints=shared.DateAttributeConstraints(), + default_value='fuga', deprecated=False, - disable_case_sensitive=False, entity_builder_disable_edit=False, feature_flag='FF_MY_FEATURE_FLAG', - group='provident', + group='eius', hidden=False, hide_label=False, - icon='ipsa', - info_helpers=shared.MultiSelectAttributeInfoHelpers( - hint_custom_component='molestiae', - hint_text='magnam', - hint_text_key='odio', + icon='eos', + info_helpers=shared.DateAttributeInfoHelpers( + hint_custom_component='voluptas', + hint_text='ab', + hint_text_key='cupiditate', hint_tooltip_placement='top', ), - label='eius', + label='consequatur', layout='full_width', - name='Tamara Leffler', - options=[ - shared.MultiSelectAttributeOptions2( - title='Dr.', - value='ut', - ), - ], + name='Henrietta Hilpert', order=0, - placeholder='eum', - preview_value_formatter='suscipit', + placeholder='quo', + preview_value_formatter='esse', protected=False, readonly=False, - render_condition='assumenda', + render_condition='recusandae', required=False, setting_flag='MY_SETTING', show_in_table=False, - type=shared.MultiSelectAttributeType.MULTISELECT, - value_formatter='praesentium', + sortable=False, + type=shared.DateAttributeType.DATE, + value_formatter='distinctio', ), ], - blueprint='c10ab3cd-ca42-4519-84e5-23c7e0bc7178', + blueprint='c7178e47-96f2-4a70-8688-282aa482562f', capabilities=[ shared.EntityCapability( purpose=[ - 'e4796f2a-70c6-4882-82aa-482562f222e9', + '222e9817-ee17-4cbe-a1e6-b7b95bc0ab3c', ], attributes=[ - shared.TagsAttribute( + shared.BooleanAttribute( purpose=[ - '17ee17cb-e61e-46b7-b95b-c0ab3c20c4f3', + '0c4f3789-fd87-41f9-9dd2-efd121aa6f1e', ], - constraints=shared.TagsAttributeConstraints(), - default_value='esse', + constraints=shared.BooleanAttributeConstraints(), + default_value='vel', deprecated=False, entity_builder_disable_edit=False, feature_flag='FF_MY_FEATURE_FLAG', - group='blanditiis', + group='in', hidden=False, hide_label=False, - icon='provident', - info_helpers=shared.TagsAttributeInfoHelpers( - hint_custom_component='a', - hint_text='nulla', - hint_text_key='quas', + icon='eius', + info_helpers=shared.BooleanAttributeInfoHelpers( + hint_custom_component='libero', + hint_text='illum', + hint_text_key='soluta', hint_tooltip_placement='top', ), - label='esse', + label='accusantium', layout='full_width', - name='Lorene Mueller', - options=[ - 'possimus', - ], + name='Miranda Carter', order=0, - placeholder='quia', - preview_value_formatter='eveniet', + placeholder='ullam', + preview_value_formatter='nisi', protected=False, readonly=False, - render_condition='asperiores', + render_condition='aut', required=False, setting_flag='MY_SETTING', show_in_table=False, - suggestions=[ - 'facere', - ], - type=shared.TagsAttributeType.TAGS, - value_formatter='veritatis', + sortable=False, + type=shared.BooleanAttributeType.BOOLEAN, + value_formatter='voluptatum', ), ], feature_flag='FF_MY_FEATURE_FLAG', @@ -360,49 +347,49 @@ req = operations.PutSchemaRequest( title='Messaging', ui_hooks=[ { - "consequuntur": 'quasi', + "qui": 'quibusdam', }, ], ), ], dialog_config={ - "similique": 'culpa', + "ex": 'deleniti', }, draft=False, enable_setting=[ '360_features', ], explicit_search_mappings={ - "aliquid": shared.SearchMappings( + "itaque": shared.SearchMappings( fields_={ - "tenetur": 'quae', + "dolorum": 'architecto', }, index=False, - type=shared.SearchMappingsType.NESTED, + type=shared.SearchMappingsType.FLOAT, ), }, feature_flag='FF_MY_FEATURE_FLAG', group_settings=[ shared.EntitySchemaGroupSettings( purpose=[ - '674bdb04-f157-4560-82d6-8ea19f1d1705', + 'f1d17051-339d-4080-86a1-840394c26071', ], expanded=False, feature_flag='FF_MY_FEATURE_FLAG', - id='1339d080-86a1-4840-b94c-26071f93f5f0', + id='f93f5f06-42da-4c7a-b515-cc413aa63aae', info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( - default='ea', - key='quaerat', + default='totam', + key='fugiat', ), - label='consequuntur', - order=831520, + label='vel', + order=497678, render_condition='_is_composite_price = "false"', setting_flag='MY_SETTING', ), ], icon='person', layout_settings={ - "officia": 'maxime', + "quos": 'vel', }, name='Contact', plural='Contacts', @@ -410,9 +397,15 @@ req = operations.PutSchemaRequest( slug='contact', title_template='{{first_name}} {{last_name}}', ui_config=shared.EntitySchemaUIConfig( - create_view=shared.RedirectEntityView( - route='/app/pricing-hub/product/:entityId', - view_type=shared.RedirectEntityViewViewType.REDIRECT, + create_view=shared.EntityDefaultCreate( + search_params={ + "possimus": 'facilis', + }, + table_menu_options=shared.EntityDefaultCreateTableMenuOptions( + icon='cum', + label='commodi', + ), + view_type=shared.EntityDefaultCreateViewType.DEFAULT, ), edit_view=shared.RedirectEntityView( route='/app/pricing-hub/product/:entityId', @@ -420,25 +413,31 @@ req = operations.PutSchemaRequest( ), list_item=shared.EntitySchemaUIConfigListItem( summary_attributes=[ - 'email', + shared.SummaryAttribute( + feature_flag='reiciendis', + label='assumenda', + render_condition='nemo', + setting_flag='recusandae', + show_as_tag=False, + tag_color='aliquid', + value='aperiam', + ), ], ), sharing=shared.EntitySchemaUIConfigSharing( show_sharing_button=True, ), - single_view=shared.RedirectEntityView( - route='/app/pricing-hub/product/:entityId', - view_type=shared.RedirectEntityViewViewType.REDIRECT, + single_view=shared.EntityViewDisabled( + view_type=shared.EntityViewDisabledViewType.DISABLED, ), table_view=shared.EntityDefaultTable( - classic_view='quaerat', + classic_view='in', dropdown_items=[ - shared.EntityDefaultTableDropdownItems2( + shared.EntityDefaultTableDropdownItems1( + entity='contact', feature_flag='FF_MY_FEATURE_FLAG', legacy=False, - title='Opportunities', - type=shared.EntityDefaultTableDropdownItems2Type.LINK, - uri='quod', + type=shared.EntityDefaultTableDropdownItems1Type.ENTITY, ), ], enable_thumbnails=False, @@ -446,20 +445,20 @@ req = operations.PutSchemaRequest( shared.EntityDefaultTableNavbarActions( options=[ shared.EntityDefaultTableNavbarActionsOptions( - label='labore', + label='earum', params=shared.EntityDefaultTableNavbarActionsOptionsParams(), ), ], - type='ab', + type='facere', ), ], row_actions=[ - 'adipisci', + 'numquam', ], view_type=shared.EntityDefaultTableViewType.DEFAULT, ), ), - version=683573, + version=985492, ), draft=False, slug='contact', diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index d662adc0d..3b25d1ec6 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -98,10 +98,10 @@ s = epilot.Epilot( req = operations.TaxonomiesClassificationsSearchRequest( request_body=operations.TaxonomiesClassificationsSearchRequestBody( classification_ids=[ - 'a63aae8d-6786-44db-b675-fd5e60b375ed', + '6fbee41f-3331-47fe-b5b6-0eb1ea426555', ], ), - taxonomy_slug='numquam', + taxonomy_slug='nobis', ) res = s.taxonomy.taxonomies_classifications_search(req) @@ -139,9 +139,9 @@ s = epilot.Epilot( ) req = operations.TaxonomyAutocompleteRequest( - query='doloribus', - size=3817.6, - taxonomy_slug='reiciendis', + query='dolorum', + size=2378.07, + taxonomy_slug='minus', ) res = s.taxonomy.taxonomy_autocomplete(req) @@ -183,31 +183,31 @@ req = operations.UpdateClassificationsForTaxonomyRequest( classifications_update=shared.ClassificationsUpdate( create=[ shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2021-03-11T09:18:18.070Z'), - id='e41f3331-7fe3-45b6-8eb1-ea426555ba3c', + created_at=dateutil.parser.isoparse('2022-07-01T01:32:29.196Z'), + id='744ed53b-88f3-4a8d-8f5c-0b2f2fb7b194', name='Wallbox PV', parents=[ - '28744ed5-3b88-4f3a-8d8f-5c0b2f2fb7b1', + 'a276b269-16fe-41f0-8f42-94e3698f447f', ], - updated_at=dateutil.parser.isoparse('2022-06-01T06:14:54.164Z'), + updated_at=dateutil.parser.isoparse('2022-12-22T16:38:34.482Z'), ), ], delete=[ - 'a276b269-16fe-41f0-8f42-94e3698f447f', + '3e8b445e-80ca-455e-bd20-e457e1858b6a', ], update=[ shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-12-22T16:38:34.482Z'), - id='3e8b445e-80ca-455e-bd20-e457e1858b6a', + created_at=dateutil.parser.isoparse('2021-10-03T15:49:29.329Z'), + id='fbe3a5aa-8e48-424d-8ab4-075088e51862', name='Wallbox PV', parents=[ - '89fbe3a5-aa8e-4482-8d0a-b4075088e518', + '065e904f-3b11-494b-8abf-603a79f9dfe0', ], - updated_at=dateutil.parser.isoparse('2022-11-05T22:13:21.002Z'), + updated_at=dateutil.parser.isoparse('2021-08-10T13:37:39.961Z'), ), ], ), - taxonomy_slug='sit', + taxonomy_slug='reprehenderit', ) res = s.taxonomy.update_classifications_for_taxonomy(req) diff --git a/entity/files.gen b/entity/files.gen index a4f404b6a..5766e7cc7 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -61,7 +61,6 @@ src/epilot/models/shared/entitysearchresults.py src/epilot/models/shared/entitysearchparams.py src/epilot/models/shared/entityimportparams.py src/epilot/models/shared/relationitem.py -src/epilot/models/shared/getrelationsresp.py src/epilot/models/shared/getrelationsrespwithpagination.py src/epilot/models/shared/savedviewitem.py src/epilot/models/shared/savedview.py @@ -110,15 +109,6 @@ src/epilot/models/shared/classificationsupdate.py src/epilot/models/shared/security.py src/epilot/models/shared/__init__.py src/epilot/models/errors/__init__.py -docs/sdks/epilot/README.md -docs/sdks/activity/README.md -docs/sdks/entities/README.md -docs/sdks/entityimport/README.md -docs/sdks/export/README.md -docs/sdks/relations/README.md -docs/sdks/savedviews/README.md -docs/sdks/schemas/README.md -docs/sdks/taxonomy/README.md USAGE.md docs/models/operations/attachactivityrequest.md docs/models/operations/attachactivityresponse.md @@ -219,7 +209,6 @@ docs/models/shared/entitysearchparams.md docs/models/shared/entityimportparamss3reference.md docs/models/shared/entityimportparams.md docs/models/shared/relationitem.md -docs/models/shared/getrelationsresp.md docs/models/shared/getrelationsrespwithpagination.md docs/models/shared/savedviewitemcreatedby1.md docs/models/shared/savedviewitem.md @@ -318,7 +307,7 @@ docs/models/shared/paymentmethodrelationattributeinfohelpers.md docs/models/shared/paymentmethodrelationattributetype.md docs/models/shared/paymentmethodrelationattribute.md docs/models/shared/currencyattributeconstraints.md -docs/models/shared/currencyattributecurrency1.md +docs/models/shared/currencyattributecurrency.md docs/models/shared/currencyattributeinfohelpers.md docs/models/shared/currencyattributetype.md docs/models/shared/currencyattribute.md @@ -390,4 +379,13 @@ docs/models/shared/entityschema.md docs/models/shared/taxonomy.md docs/models/shared/classificationsupdate.md docs/models/shared/security.md +docs/sdks/epilot/README.md +docs/sdks/activity/README.md +docs/sdks/entities/README.md +docs/sdks/entityimport/README.md +docs/sdks/export/README.md +docs/sdks/relations/README.md +docs/sdks/savedviews/README.md +docs/sdks/schemas/README.md +docs/sdks/taxonomy/README.md .gitattributes \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 4f00ae9cb..1e0729cd2 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,9 +1,9 @@ configVersion: 1.0.0 management: - docChecksum: b78749d0cc95dce884cbc769420e0522 + docChecksum: 285059cd6a6b4ebb4b50059166100555 docVersion: 1.0.0 - speakeasyVersion: 1.88.0 - generationVersion: 2.118.1 + speakeasyVersion: 1.89.0 + generationVersion: 2.125.1 generation: sdkClassName: epilot sdkFlattening: true @@ -15,7 +15,7 @@ features: globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.23.7 + version: 1.23.8 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index f7f2ecb0f..e82a3350d 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.23.7", + version="1.23.8", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index 1cba58da5..505886ccb 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -23,7 +23,6 @@ from .entitysearchresults import * from .entityviewdisabled import * from .fileattribute import * -from .getrelationsresp import * from .getrelationsrespwithpagination import * from .internalattribute import * from .internaluserattribute import * @@ -55,4 +54,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigSharing","EntitySchemaUIConfig","EntitySchemaUIConfigListItem","EntitySchemaUIConfigSharing","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsResp","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] +__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigSharing","EntitySchemaUIConfig","EntitySchemaUIConfigListItem","EntitySchemaUIConfigSharing","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] diff --git a/entity/src/epilot/models/shared/addressrelationattribute.py b/entity/src/epilot/models/shared/addressrelationattribute.py index 4dde2203a..17d57de4e 100755 --- a/entity/src/epilot/models/shared/addressrelationattribute.py +++ b/entity/src/epilot/models/shared/addressrelationattribute.py @@ -96,6 +96,8 @@ class AddressRelationAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[AddressRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/automationattribute.py b/entity/src/epilot/models/shared/automationattribute.py index 78adb6483..5472119aa 100755 --- a/entity/src/epilot/models/shared/automationattribute.py +++ b/entity/src/epilot/models/shared/automationattribute.py @@ -95,6 +95,8 @@ class AutomationAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[AutomationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/booleanattribute.py b/entity/src/epilot/models/shared/booleanattribute.py index 5505ac152..a65d940c8 100755 --- a/entity/src/epilot/models/shared/booleanattribute.py +++ b/entity/src/epilot/models/shared/booleanattribute.py @@ -95,6 +95,8 @@ class BooleanAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[BooleanAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/computedattribute.py b/entity/src/epilot/models/shared/computedattribute.py index 8f14a76d8..9a27b6dd0 100755 --- a/entity/src/epilot/models/shared/computedattribute.py +++ b/entity/src/epilot/models/shared/computedattribute.py @@ -95,6 +95,8 @@ class ComputedAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[ComputedAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/consentattribute.py b/entity/src/epilot/models/shared/consentattribute.py index 2d328b22b..7e4ab58dc 100755 --- a/entity/src/epilot/models/shared/consentattribute.py +++ b/entity/src/epilot/models/shared/consentattribute.py @@ -98,6 +98,8 @@ class ConsentAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/countryattribute.py b/entity/src/epilot/models/shared/countryattribute.py index dd1c7755e..95d493287 100755 --- a/entity/src/epilot/models/shared/countryattribute.py +++ b/entity/src/epilot/models/shared/countryattribute.py @@ -95,6 +95,8 @@ class CountryAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[CountryAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/currencyattribute.py b/entity/src/epilot/models/shared/currencyattribute.py index 2611f6c39..8715bbd24 100755 --- a/entity/src/epilot/models/shared/currencyattribute.py +++ b/entity/src/epilot/models/shared/currencyattribute.py @@ -21,7 +21,7 @@ class CurrencyAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class CurrencyAttributeCurrency1: +class CurrencyAttributeCurrency: r"""A currency configuration""" code: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('code') }}) description: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) @@ -65,7 +65,7 @@ class CurrencyAttributeType(str, Enum): @dataclasses.dataclass class CurrencyAttribute: r"""Currency input""" - currency: list[Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) + currency: list[CurrencyAttributeCurrency] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) r"""An array of currency configurations with a country code (ISO-4217)""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) @@ -112,6 +112,8 @@ class CurrencyAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/dateattribute.py b/entity/src/epilot/models/shared/dateattribute.py index 58795b7dc..b556f3323 100755 --- a/entity/src/epilot/models/shared/dateattribute.py +++ b/entity/src/epilot/models/shared/dateattribute.py @@ -96,6 +96,8 @@ class DateAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[DateAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/fileattribute.py b/entity/src/epilot/models/shared/fileattribute.py index e45c675f2..f0024630c 100755 --- a/entity/src/epilot/models/shared/fileattribute.py +++ b/entity/src/epilot/models/shared/fileattribute.py @@ -111,6 +111,8 @@ class FileAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/getrelationsresp.py b/entity/src/epilot/models/shared/getrelationsresp.py deleted file mode 100755 index 0e249b23f..000000000 --- a/entity/src/epilot/models/shared/getrelationsresp.py +++ /dev/null @@ -1,20 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from dataclasses_json import Undefined, dataclass_json -from epilot import utils -from typing import Optional - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class GetRelationsResp: - attribute: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attribute') }}) - entity_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_id') }}) - tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) - reverse: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reverse'), 'exclude': lambda f: f is None }}) - r"""Whether this is a reverse relation""" - - diff --git a/entity/src/epilot/models/shared/internalattribute.py b/entity/src/epilot/models/shared/internalattribute.py index 235f53d31..4cba4342d 100755 --- a/entity/src/epilot/models/shared/internalattribute.py +++ b/entity/src/epilot/models/shared/internalattribute.py @@ -95,6 +95,8 @@ class InternalAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[InternalAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/internaluserattribute.py b/entity/src/epilot/models/shared/internaluserattribute.py index d2816d830..a313add95 100755 --- a/entity/src/epilot/models/shared/internaluserattribute.py +++ b/entity/src/epilot/models/shared/internaluserattribute.py @@ -95,6 +95,8 @@ class InternalUserAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[InternalUserAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/invitationemailattribute.py b/entity/src/epilot/models/shared/invitationemailattribute.py index 43beb5681..8610c531b 100755 --- a/entity/src/epilot/models/shared/invitationemailattribute.py +++ b/entity/src/epilot/models/shared/invitationemailattribute.py @@ -95,6 +95,8 @@ class InvitationEmailAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[InvitationEmailAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/linkattribute.py b/entity/src/epilot/models/shared/linkattribute.py index adc963ee7..e5ab78e4d 100755 --- a/entity/src/epilot/models/shared/linkattribute.py +++ b/entity/src/epilot/models/shared/linkattribute.py @@ -95,6 +95,8 @@ class LinkAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[LinkAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/multiselectattribute.py b/entity/src/epilot/models/shared/multiselectattribute.py index 59e23bdcc..00a63ee9f 100755 --- a/entity/src/epilot/models/shared/multiselectattribute.py +++ b/entity/src/epilot/models/shared/multiselectattribute.py @@ -113,6 +113,8 @@ class MultiSelectAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[MultiSelectAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/numberattribute.py b/entity/src/epilot/models/shared/numberattribute.py index cbfef2dee..005066207 100755 --- a/entity/src/epilot/models/shared/numberattribute.py +++ b/entity/src/epilot/models/shared/numberattribute.py @@ -96,6 +96,8 @@ class NumberAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[NumberAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/orderedlistattribute.py b/entity/src/epilot/models/shared/orderedlistattribute.py index 76a7e56f4..b2b5f2e08 100755 --- a/entity/src/epilot/models/shared/orderedlistattribute.py +++ b/entity/src/epilot/models/shared/orderedlistattribute.py @@ -95,6 +95,8 @@ class OrderedListAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[OrderedListAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/partnerorganisationattribute.py b/entity/src/epilot/models/shared/partnerorganisationattribute.py index bc0920b78..3adbf1b74 100755 --- a/entity/src/epilot/models/shared/partnerorganisationattribute.py +++ b/entity/src/epilot/models/shared/partnerorganisationattribute.py @@ -95,6 +95,8 @@ class PartnerOrganisationAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[PartnerOrganisationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/partnerstatusattribute.py b/entity/src/epilot/models/shared/partnerstatusattribute.py index 47ffdad80..94cadbd03 100755 --- a/entity/src/epilot/models/shared/partnerstatusattribute.py +++ b/entity/src/epilot/models/shared/partnerstatusattribute.py @@ -95,6 +95,8 @@ class PartnerStatusAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[PartnerStatusAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py index f8babf618..28b894d87 100755 --- a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py +++ b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py @@ -96,6 +96,8 @@ class PaymentMethodRelationAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[PaymentMethodRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/purposeattribute.py b/entity/src/epilot/models/shared/purposeattribute.py index 1d741768d..e56df6657 100755 --- a/entity/src/epilot/models/shared/purposeattribute.py +++ b/entity/src/epilot/models/shared/purposeattribute.py @@ -100,6 +100,8 @@ class PurposeAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[PurposeAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py index c2bc03575..eb4ca7ee2 100755 --- a/entity/src/epilot/models/shared/relationattribute.py +++ b/entity/src/epilot/models/shared/relationattribute.py @@ -168,6 +168,8 @@ class RelationAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" summary_fields: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_fields'), 'exclude': lambda f: f is None }}) type: Optional[RelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/repeatableattribute.py b/entity/src/epilot/models/shared/repeatableattribute.py index ca672b5f0..eac414595 100755 --- a/entity/src/epilot/models/shared/repeatableattribute.py +++ b/entity/src/epilot/models/shared/repeatableattribute.py @@ -113,6 +113,8 @@ class RepeatableAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[RepeatableAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/selectattribute.py b/entity/src/epilot/models/shared/selectattribute.py index 10481db31..413f0aa4f 100755 --- a/entity/src/epilot/models/shared/selectattribute.py +++ b/entity/src/epilot/models/shared/selectattribute.py @@ -109,6 +109,8 @@ class SelectAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[SelectAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/sequenceattribute.py b/entity/src/epilot/models/shared/sequenceattribute.py index 30006b7ad..b78427b2e 100755 --- a/entity/src/epilot/models/shared/sequenceattribute.py +++ b/entity/src/epilot/models/shared/sequenceattribute.py @@ -97,6 +97,8 @@ class SequenceAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" start_number: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_number'), 'exclude': lambda f: f is None }}) type: Optional[SequenceAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py index 52e804b31..000270c3a 100755 --- a/entity/src/epilot/models/shared/statusattribute.py +++ b/entity/src/epilot/models/shared/statusattribute.py @@ -108,6 +108,8 @@ class StatusAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[StatusAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/tagsattribute.py b/entity/src/epilot/models/shared/tagsattribute.py index 7180aaa78..20531c680 100755 --- a/entity/src/epilot/models/shared/tagsattribute.py +++ b/entity/src/epilot/models/shared/tagsattribute.py @@ -96,6 +96,8 @@ class TagsAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" suggestions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggestions'), 'exclude': lambda f: f is None }}) type: Optional[TagsAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/textattribute.py b/entity/src/epilot/models/shared/textattribute.py index b39f082c6..aa5a41c21 100755 --- a/entity/src/epilot/models/shared/textattribute.py +++ b/entity/src/epilot/models/shared/textattribute.py @@ -96,6 +96,8 @@ class TextAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[TextAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/userrelationattribute.py b/entity/src/epilot/models/shared/userrelationattribute.py index bd17da0e7..38bedc882 100755 --- a/entity/src/epilot/models/shared/userrelationattribute.py +++ b/entity/src/epilot/models/shared/userrelationattribute.py @@ -96,6 +96,8 @@ class UserRelationAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" + sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[UserRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 0cb171819..5c71d068e 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,8 +19,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.23.7' - gen_version: str = '2.118.1' + sdk_version: str = '1.23.8' + gen_version: str = '2.125.1' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: From de3ef7c9eb83bcac1c9ea849c54cdcbfbf6b3168 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 26 Sep 2023 01:14:26 +0000 Subject: [PATCH 40/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.0 --- entity/README.md | 4 ---- entity/RELEASES.md | 10 +++++++++- entity/docs/models/operations/addrelationsresponse.md | 6 +++--- .../docs/models/operations/attachactivityresponse.md | 6 +++--- entity/docs/models/operations/autocompleteresponse.md | 6 +++--- .../docs/models/operations/createactivityresponse.md | 6 +++--- entity/docs/models/operations/createentityresponse.md | 6 +++--- .../docs/models/operations/createsavedviewresponse.md | 6 +++--- entity/docs/models/operations/deleteentityresponse.md | 6 +++--- .../docs/models/operations/deleterelationresponse.md | 6 +++--- .../docs/models/operations/deletesavedviewresponse.md | 6 +++--- entity/docs/models/operations/deleteschemaresponse.md | 6 +++--- .../docs/models/operations/exportentitiesresponse.md | 6 +++--- entity/docs/models/operations/getactivityresponse.md | 6 +++--- .../models/operations/getentityactivityfeedresponse.md | 6 +++--- entity/docs/models/operations/getentityresponse.md | 6 +++--- entity/docs/models/operations/getrelationsresponse.md | 6 +++--- .../docs/models/operations/getrelationsv2response.md | 6 +++--- entity/docs/models/operations/getsavedviewresponse.md | 6 +++--- entity/docs/models/operations/getschemaresponse.md | 6 +++--- .../models/operations/getschemaversionsresponse.md | 6 +++--- entity/docs/models/operations/gettaxonomyresponse.md | 6 +++--- .../docs/models/operations/importentitiesresponse.md | 6 +++--- .../operations/listfavoriteviewsforuserresponse.md | 6 +++--- .../docs/models/operations/listsavedviewsresponse.md | 6 +++--- .../models/operations/listschemablueprintsresponse.md | 6 +++--- entity/docs/models/operations/listschemasresponse.md | 6 +++--- .../docs/models/operations/listtaxonomiesresponse.md | 6 +++--- .../listtaxonomyclassificationsforschemaresponse.md | 6 +++--- entity/docs/models/operations/patchentityresponse.md | 6 +++--- entity/docs/models/operations/putschemaresponse.md | 6 +++--- .../docs/models/operations/searchentitiesresponse.md | 6 +++--- .../taxonomiesclassificationssearchresponse.md | 6 +++--- .../models/operations/taxonomyautocompleteresponse.md | 6 +++--- .../updateclassificationsfortaxonomyresponse.md | 6 +++--- entity/docs/models/operations/updateentityresponse.md | 6 +++--- .../docs/models/operations/updaterelationresponse.md | 6 +++--- .../docs/models/operations/updatesavedviewresponse.md | 6 +++--- entity/docs/models/operations/upsertentityresponse.md | 6 +++--- entity/gen.yaml | 8 ++++---- entity/setup.py | 2 +- entity/src/epilot/models/operations/addrelations.py | 3 +++ entity/src/epilot/models/operations/attachactivity.py | 3 +++ entity/src/epilot/models/operations/autocomplete.py | 3 +++ entity/src/epilot/models/operations/createactivity.py | 3 +++ entity/src/epilot/models/operations/createentity.py | 3 +++ entity/src/epilot/models/operations/createsavedview.py | 3 +++ entity/src/epilot/models/operations/deleteentity.py | 3 +++ entity/src/epilot/models/operations/deleterelation.py | 3 +++ entity/src/epilot/models/operations/deletesavedview.py | 3 +++ entity/src/epilot/models/operations/deleteschema.py | 3 +++ entity/src/epilot/models/operations/exportentities.py | 3 +++ entity/src/epilot/models/operations/getactivity.py | 3 +++ entity/src/epilot/models/operations/getentity.py | 3 +++ .../epilot/models/operations/getentityactivityfeed.py | 3 +++ entity/src/epilot/models/operations/getrelations.py | 3 +++ entity/src/epilot/models/operations/getrelationsv2.py | 3 +++ entity/src/epilot/models/operations/getsavedview.py | 3 +++ entity/src/epilot/models/operations/getschema.py | 3 +++ .../src/epilot/models/operations/getschemaversions.py | 3 +++ entity/src/epilot/models/operations/gettaxonomy.py | 3 +++ entity/src/epilot/models/operations/importentities.py | 3 +++ .../models/operations/listfavoriteviewsforuser.py | 3 +++ entity/src/epilot/models/operations/listsavedviews.py | 3 +++ .../epilot/models/operations/listschemablueprints.py | 3 +++ entity/src/epilot/models/operations/listschemas.py | 3 +++ entity/src/epilot/models/operations/listtaxonomies.py | 3 +++ .../operations/listtaxonomyclassificationsforschema.py | 3 +++ entity/src/epilot/models/operations/patchentity.py | 3 +++ entity/src/epilot/models/operations/putschema.py | 3 +++ entity/src/epilot/models/operations/searchentities.py | 3 +++ .../operations/taxonomiesclassificationssearch.py | 3 +++ .../epilot/models/operations/taxonomyautocomplete.py | 3 +++ .../operations/updateclassificationsfortaxonomy.py | 3 +++ entity/src/epilot/models/operations/updateentity.py | 3 +++ entity/src/epilot/models/operations/updaterelation.py | 3 +++ entity/src/epilot/models/operations/updatesavedview.py | 3 +++ entity/src/epilot/models/operations/upsertentity.py | 3 +++ entity/src/epilot/sdkconfiguration.py | 4 ++-- 79 files changed, 238 insertions(+), 123 deletions(-) diff --git a/entity/README.md b/entity/README.md index b0cd92993..1ab6167d3 100755 --- a/entity/README.md +++ b/entity/README.md @@ -104,8 +104,6 @@ if res.activity_item is not None: - - @@ -118,8 +116,6 @@ returned response object will have a `Next` method that can be called to pull do return value of `Next` is `None`, then there are no more pages to be fetched. Here's an example of one such pagination call: - - diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 18077a815..d32c2396e 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -292,4 +292,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.89.0 (2.125.1) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.23.8] entity \ No newline at end of file +- [python v1.23.8] entity + +## 2023-09-26 01:13:58 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.91.0 (2.129.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.24.0] entity \ No newline at end of file diff --git a/entity/docs/models/operations/addrelationsresponse.md b/entity/docs/models/operations/addrelationsresponse.md index f8413504b..6001b8933 100755 --- a/entity/docs/models/operations/addrelationsresponse.md +++ b/entity/docs/models/operations/addrelationsresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `relation_item` | [Optional[shared.RelationItem]](../../models/shared/relationitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/attachactivityresponse.md b/entity/docs/models/operations/attachactivityresponse.md index a77362bd2..78ed39dc2 100755 --- a/entity/docs/models/operations/attachactivityresponse.md +++ b/entity/docs/models/operations/attachactivityresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/autocompleteresponse.md b/entity/docs/models/operations/autocompleteresponse.md index be4114d93..8f820dff9 100755 --- a/entity/docs/models/operations/autocompleteresponse.md +++ b/entity/docs/models/operations/autocompleteresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `autocomplete_200_application_json_object` | [Optional[Autocomplete200ApplicationJSON]](../../models/operations/autocomplete200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/createactivityresponse.md b/entity/docs/models/operations/createactivityresponse.md index 0970e2bfb..81bd58bde 100755 --- a/entity/docs/models/operations/createactivityresponse.md +++ b/entity/docs/models/operations/createactivityresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityresponse.md b/entity/docs/models/operations/createentityresponse.md index ed297bcb1..d7c244dbc 100755 --- a/entity/docs/models/operations/createentityresponse.md +++ b/entity/docs/models/operations/createentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/createsavedviewresponse.md b/entity/docs/models/operations/createsavedviewresponse.md index 1dee22cff..c40e1dc1e 100755 --- a/entity/docs/models/operations/createsavedviewresponse.md +++ b/entity/docs/models/operations/createsavedviewresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `saved_view_item` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteentityresponse.md b/entity/docs/models/operations/deleteentityresponse.md index 0eac5c5a8..1ff556201 100755 --- a/entity/docs/models/operations/deleteentityresponse.md +++ b/entity/docs/models/operations/deleteentityresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deleterelationresponse.md b/entity/docs/models/operations/deleterelationresponse.md index 56949700d..1c6ddb31d 100755 --- a/entity/docs/models/operations/deleterelationresponse.md +++ b/entity/docs/models/operations/deleterelationresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deletesavedviewresponse.md b/entity/docs/models/operations/deletesavedviewresponse.md index d8a8b0745..1be59ea6d 100755 --- a/entity/docs/models/operations/deletesavedviewresponse.md +++ b/entity/docs/models/operations/deletesavedviewresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteschemaresponse.md b/entity/docs/models/operations/deleteschemaresponse.md index 5422bcac7..9c6e1c201 100755 --- a/entity/docs/models/operations/deleteschemaresponse.md +++ b/entity/docs/models/operations/deleteschemaresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/exportentitiesresponse.md b/entity/docs/models/operations/exportentitiesresponse.md index ada438178..f5039e620 100755 --- a/entity/docs/models/operations/exportentitiesresponse.md +++ b/entity/docs/models/operations/exportentitiesresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getactivityresponse.md b/entity/docs/models/operations/getactivityresponse.md index 179ae8ae2..98ce41384 100755 --- a/entity/docs/models/operations/getactivityresponse.md +++ b/entity/docs/models/operations/getactivityresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeedresponse.md b/entity/docs/models/operations/getentityactivityfeedresponse.md index a7b37b7a2..79a167013 100755 --- a/entity/docs/models/operations/getentityactivityfeedresponse.md +++ b/entity/docs/models/operations/getentityactivityfeedresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `get_entity_activity_feed_200_application_json_object` | [Optional[GetEntityActivityFeed200ApplicationJSON]](../../models/operations/getentityactivityfeed200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityresponse.md b/entity/docs/models/operations/getentityresponse.md index 0078ae03b..51acec577 100755 --- a/entity/docs/models/operations/getentityresponse.md +++ b/entity/docs/models/operations/getentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `get_entity_200_application_json_object` | [Optional[GetEntity200ApplicationJSON]](../../models/operations/getentity200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsresponse.md b/entity/docs/models/operations/getrelationsresponse.md index 3eedea582..4ae26513d 100755 --- a/entity/docs/models/operations/getrelationsresponse.md +++ b/entity/docs/models/operations/getrelationsresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `get_relations_resp` | list[*Any*] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv2response.md b/entity/docs/models/operations/getrelationsv2response.md index 6e68d54c5..1f3d24b91 100755 --- a/entity/docs/models/operations/getrelationsv2response.md +++ b/entity/docs/models/operations/getrelationsv2response.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `get_relations_resp_with_pagination` | [Optional[shared.GetRelationsRespWithPagination]](../../models/shared/getrelationsrespwithpagination.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getsavedviewresponse.md b/entity/docs/models/operations/getsavedviewresponse.md index e1037d189..84207c031 100755 --- a/entity/docs/models/operations/getsavedviewresponse.md +++ b/entity/docs/models/operations/getsavedviewresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `get_saved_view_200_application_json_object` | [Optional[GetSavedView200ApplicationJSON]](../../models/operations/getsavedview200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaresponse.md b/entity/docs/models/operations/getschemaresponse.md index 5a1ca705d..7c661e329 100755 --- a/entity/docs/models/operations/getschemaresponse.md +++ b/entity/docs/models/operations/getschemaresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_schema_item` | [Optional[shared.EntitySchemaItem]](../../models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversionsresponse.md b/entity/docs/models/operations/getschemaversionsresponse.md index fd6dbc2c0..16df859a3 100755 --- a/entity/docs/models/operations/getschemaversionsresponse.md +++ b/entity/docs/models/operations/getschemaversionsresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `get_schema_versions_200_application_json_object` | [Optional[GetSchemaVersions200ApplicationJSON]](../../models/operations/getschemaversions200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/gettaxonomyresponse.md b/entity/docs/models/operations/gettaxonomyresponse.md index c16a339e8..c4407cd22 100755 --- a/entity/docs/models/operations/gettaxonomyresponse.md +++ b/entity/docs/models/operations/gettaxonomyresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `taxonomy` | [Optional[shared.Taxonomy]](../../models/shared/taxonomy.md) | :heavy_minus_sign: | Taxonomy | \ No newline at end of file diff --git a/entity/docs/models/operations/importentitiesresponse.md b/entity/docs/models/operations/importentitiesresponse.md index 21ba0c3ff..39f37b821 100755 --- a/entity/docs/models/operations/importentitiesresponse.md +++ b/entity/docs/models/operations/importentitiesresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/listfavoriteviewsforuserresponse.md b/entity/docs/models/operations/listfavoriteviewsforuserresponse.md index 45b9b82a3..b857e12ff 100755 --- a/entity/docs/models/operations/listfavoriteviewsforuserresponse.md +++ b/entity/docs/models/operations/listfavoriteviewsforuserresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `list_favorite_views_for_user_200_application_json_object` | [Optional[ListFavoriteViewsForUser200ApplicationJSON]](../../models/operations/listfavoriteviewsforuser200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listsavedviewsresponse.md b/entity/docs/models/operations/listsavedviewsresponse.md index 6dfa8c87c..89fb9157e 100755 --- a/entity/docs/models/operations/listsavedviewsresponse.md +++ b/entity/docs/models/operations/listsavedviewsresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `list_saved_views_200_application_json_object` | [Optional[ListSavedViews200ApplicationJSON]](../../models/operations/listsavedviews200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemablueprintsresponse.md b/entity/docs/models/operations/listschemablueprintsresponse.md index d716ace30..779aa958f 100755 --- a/entity/docs/models/operations/listschemablueprintsresponse.md +++ b/entity/docs/models/operations/listschemablueprintsresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `list_schema_blueprints_200_application_json_object` | [Optional[ListSchemaBlueprints200ApplicationJSON]](../../models/operations/listschemablueprints200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemasresponse.md b/entity/docs/models/operations/listschemasresponse.md index ed54d27d8..000d9c8e2 100755 --- a/entity/docs/models/operations/listschemasresponse.md +++ b/entity/docs/models/operations/listschemasresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `list_schemas_200_application_json_object` | [Optional[ListSchemas200ApplicationJSON]](../../models/operations/listschemas200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomiesresponse.md b/entity/docs/models/operations/listtaxonomiesresponse.md index d4badf3e2..781676fee 100755 --- a/entity/docs/models/operations/listtaxonomiesresponse.md +++ b/entity/docs/models/operations/listtaxonomiesresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `list_taxonomies_200_application_json_object` | [Optional[ListTaxonomies200ApplicationJSON]](../../models/operations/listtaxonomies200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomies in an organisation | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md index 779a9e9d1..c31eb9a54 100755 --- a/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `list_taxonomy_classifications_for_schema_200_application_json_object` | [Optional[ListTaxonomyClassificationsForSchema200ApplicationJSON]](../../models/operations/listtaxonomyclassificationsforschema200applicationjson.md) | :heavy_minus_sign: | List of taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/patchentityresponse.md b/entity/docs/models/operations/patchentityresponse.md index 28fcfc3d0..da6a41325 100755 --- a/entity/docs/models/operations/patchentityresponse.md +++ b/entity/docs/models/operations/patchentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/putschemaresponse.md b/entity/docs/models/operations/putschemaresponse.md index 1455b9a06..1a7de73be 100755 --- a/entity/docs/models/operations/putschemaresponse.md +++ b/entity/docs/models/operations/putschemaresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_schema_item` | [Optional[shared.EntitySchemaItem]](../../models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/searchentitiesresponse.md b/entity/docs/models/operations/searchentitiesresponse.md index ec6a8ae99..99f85991b 100755 --- a/entity/docs/models/operations/searchentitiesresponse.md +++ b/entity/docs/models/operations/searchentitiesresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_search_results` | [Optional[shared.EntitySearchResults]](../../models/shared/entitysearchresults.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `search_entities_200_text_csv_string` | *Optional[str]* | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md b/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md index 1313db683..90328113f 100755 --- a/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md +++ b/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `taxonomies_classifications_search_200_application_json_object` | [Optional[TaxonomiesClassificationsSearch200ApplicationJSON]](../../models/operations/taxonomiesclassificationssearch200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocompleteresponse.md b/entity/docs/models/operations/taxonomyautocompleteresponse.md index 1ff7a3962..fb8e9b28c 100755 --- a/entity/docs/models/operations/taxonomyautocompleteresponse.md +++ b/entity/docs/models/operations/taxonomyautocompleteresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `taxonomy_autocomplete_200_application_json_object` | [Optional[TaxonomyAutocomplete200ApplicationJSON]](../../models/operations/taxonomyautocomplete200applicationjson.md) | :heavy_minus_sign: | Taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md b/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md index c6a7f2e14..7bde6558d 100755 --- a/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md +++ b/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `update_classifications_for_taxonomy_200_application_json_object` | [Optional[UpdateClassificationsForTaxonomy200ApplicationJSON]](../../models/operations/updateclassificationsfortaxonomy200applicationjson.md) | :heavy_minus_sign: | Taxonomies classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/updateentityresponse.md b/entity/docs/models/operations/updateentityresponse.md index 39082bbbf..9255fbd0b 100755 --- a/entity/docs/models/operations/updateentityresponse.md +++ b/entity/docs/models/operations/updateentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/updaterelationresponse.md b/entity/docs/models/operations/updaterelationresponse.md index 9dbe52aa1..5d2853163 100755 --- a/entity/docs/models/operations/updaterelationresponse.md +++ b/entity/docs/models/operations/updaterelationresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `relation_item` | [Optional[shared.RelationItem]](../../models/shared/relationitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/updatesavedviewresponse.md b/entity/docs/models/operations/updatesavedviewresponse.md index dd2601088..583681685 100755 --- a/entity/docs/models/operations/updatesavedviewresponse.md +++ b/entity/docs/models/operations/updatesavedviewresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `saved_view_item` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityresponse.md b/entity/docs/models/operations/upsertentityresponse.md index 79729220c..fbb29f8de 100755 --- a/entity/docs/models/operations/upsertentityresponse.md +++ b/entity/docs/models/operations/upsertentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/gen.yaml b/entity/gen.yaml index 1e0729cd2..f7ef97cb5 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: 285059cd6a6b4ebb4b50059166100555 docVersion: 1.0.0 - speakeasyVersion: 1.89.0 - generationVersion: 2.125.1 + speakeasyVersion: 1.91.0 + generationVersion: 2.129.1 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.85.6 + core: 2.86.0 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.23.8 + version: 1.24.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index e82a3350d..09d77bbc5 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.23.8", + version="1.24.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/operations/addrelations.py b/entity/src/epilot/models/operations/addrelations.py index 66458ac21..8d0787ea1 100755 --- a/entity/src/epilot/models/operations/addrelations.py +++ b/entity/src/epilot/models/operations/addrelations.py @@ -27,8 +27,11 @@ class AddRelationsRequest: @dataclasses.dataclass class AddRelationsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" relation_item: Optional[shared_relationitem.RelationItem] = dataclasses.field(default=None) r"""Success""" diff --git a/entity/src/epilot/models/operations/attachactivity.py b/entity/src/epilot/models/operations/attachactivity.py index e65cbcf72..05f429870 100755 --- a/entity/src/epilot/models/operations/attachactivity.py +++ b/entity/src/epilot/models/operations/attachactivity.py @@ -22,9 +22,12 @@ class AttachActivityRequest: @dataclasses.dataclass class AttachActivityResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" activity_item: Optional[shared_activityitem.ActivityItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/autocomplete.py b/entity/src/epilot/models/operations/autocomplete.py index bcfae8235..768997187 100755 --- a/entity/src/epilot/models/operations/autocomplete.py +++ b/entity/src/epilot/models/operations/autocomplete.py @@ -38,9 +38,12 @@ class Autocomplete200ApplicationJSON: @dataclasses.dataclass class AutocompleteResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" autocomplete_200_application_json_object: Optional[Autocomplete200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/createactivity.py b/entity/src/epilot/models/operations/createactivity.py index 5bcf5a62b..ebf0ec878 100755 --- a/entity/src/epilot/models/operations/createactivity.py +++ b/entity/src/epilot/models/operations/createactivity.py @@ -22,9 +22,12 @@ class CreateActivityRequest: @dataclasses.dataclass class CreateActivityResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" activity_item: Optional[shared_activityitem.ActivityItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/createentity.py b/entity/src/epilot/models/operations/createentity.py index d40bd5b02..2fff05f82 100755 --- a/entity/src/epilot/models/operations/createentity.py +++ b/entity/src/epilot/models/operations/createentity.py @@ -24,9 +24,12 @@ class CreateEntityRequest: @dataclasses.dataclass class CreateEntityResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/createsavedview.py b/entity/src/epilot/models/operations/createsavedview.py index de4137f24..5fb15de53 100755 --- a/entity/src/epilot/models/operations/createsavedview.py +++ b/entity/src/epilot/models/operations/createsavedview.py @@ -11,8 +11,11 @@ @dataclasses.dataclass class CreateSavedViewResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" saved_view_item: Optional[shared_savedviewitem.SavedViewItem] = dataclasses.field(default=None) r"""Success""" diff --git a/entity/src/epilot/models/operations/deleteentity.py b/entity/src/epilot/models/operations/deleteentity.py index 82834d3f8..813545047 100755 --- a/entity/src/epilot/models/operations/deleteentity.py +++ b/entity/src/epilot/models/operations/deleteentity.py @@ -22,7 +22,10 @@ class DeleteEntityRequest: @dataclasses.dataclass class DeleteEntityResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/deleterelation.py b/entity/src/epilot/models/operations/deleterelation.py index 45d30e7fa..34f2aabc5 100755 --- a/entity/src/epilot/models/operations/deleterelation.py +++ b/entity/src/epilot/models/operations/deleterelation.py @@ -29,7 +29,10 @@ class DeleteRelationRequest: @dataclasses.dataclass class DeleteRelationResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/deletesavedview.py b/entity/src/epilot/models/operations/deletesavedview.py index b367e9962..55ab025c5 100755 --- a/entity/src/epilot/models/operations/deletesavedview.py +++ b/entity/src/epilot/models/operations/deletesavedview.py @@ -19,7 +19,10 @@ class DeleteSavedViewRequest: @dataclasses.dataclass class DeleteSavedViewResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/deleteschema.py b/entity/src/epilot/models/operations/deleteschema.py index 9577de4c0..e790b1a78 100755 --- a/entity/src/epilot/models/operations/deleteschema.py +++ b/entity/src/epilot/models/operations/deleteschema.py @@ -18,7 +18,10 @@ class DeleteSchemaRequest: @dataclasses.dataclass class DeleteSchemaResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/exportentities.py b/entity/src/epilot/models/operations/exportentities.py index fd7b863b4..de1693170 100755 --- a/entity/src/epilot/models/operations/exportentities.py +++ b/entity/src/epilot/models/operations/exportentities.py @@ -25,7 +25,10 @@ class ExportEntitiesRequest: @dataclasses.dataclass class ExportEntitiesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/getactivity.py b/entity/src/epilot/models/operations/getactivity.py index 1d682cdef..1b5cdd6cb 100755 --- a/entity/src/epilot/models/operations/getactivity.py +++ b/entity/src/epilot/models/operations/getactivity.py @@ -24,9 +24,12 @@ class GetActivityRequest: @dataclasses.dataclass class GetActivityResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" activity_item: Optional[shared_activityitem.ActivityItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/getentity.py b/entity/src/epilot/models/operations/getentity.py index 87d20db59..43024d5f3 100755 --- a/entity/src/epilot/models/operations/getentity.py +++ b/entity/src/epilot/models/operations/getentity.py @@ -36,9 +36,12 @@ class GetEntity200ApplicationJSON: @dataclasses.dataclass class GetEntityResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" get_entity_200_application_json_object: Optional[GetEntity200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/getentityactivityfeed.py b/entity/src/epilot/models/operations/getentityactivityfeed.py index f92e43d67..e50ca028f 100755 --- a/entity/src/epilot/models/operations/getentityactivityfeed.py +++ b/entity/src/epilot/models/operations/getentityactivityfeed.py @@ -48,9 +48,12 @@ class GetEntityActivityFeed200ApplicationJSON: @dataclasses.dataclass class GetEntityActivityFeedResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" get_entity_activity_feed_200_application_json_object: Optional[GetEntityActivityFeed200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py index e3c42dea3..9e231e06c 100755 --- a/entity/src/epilot/models/operations/getrelations.py +++ b/entity/src/epilot/models/operations/getrelations.py @@ -25,9 +25,12 @@ class GetRelationsRequest: @dataclasses.dataclass class GetRelationsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" get_relations_resp: Optional[list[Any]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/getrelationsv2.py b/entity/src/epilot/models/operations/getrelationsv2.py index 51982bb0e..2f9c713fe 100755 --- a/entity/src/epilot/models/operations/getrelationsv2.py +++ b/entity/src/epilot/models/operations/getrelationsv2.py @@ -34,9 +34,12 @@ class GetRelationsV2Request: @dataclasses.dataclass class GetRelationsV2Response: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" get_relations_resp_with_pagination: Optional[shared_getrelationsrespwithpagination.GetRelationsRespWithPagination] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/getsavedview.py b/entity/src/epilot/models/operations/getsavedview.py index 28e29ace7..9b44344fd 100755 --- a/entity/src/epilot/models/operations/getsavedview.py +++ b/entity/src/epilot/models/operations/getsavedview.py @@ -32,9 +32,12 @@ class GetSavedView200ApplicationJSON: @dataclasses.dataclass class GetSavedViewResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" get_saved_view_200_application_json_object: Optional[GetSavedView200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/getschema.py b/entity/src/epilot/models/operations/getschema.py index f1b6689c8..3fc060d72 100755 --- a/entity/src/epilot/models/operations/getschema.py +++ b/entity/src/epilot/models/operations/getschema.py @@ -20,9 +20,12 @@ class GetSchemaRequest: @dataclasses.dataclass class GetSchemaResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" entity_schema_item: Optional[shared_entityschemaitem.EntitySchemaItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/getschemaversions.py b/entity/src/epilot/models/operations/getschemaversions.py index 156db0297..b407a3fb4 100755 --- a/entity/src/epilot/models/operations/getschemaversions.py +++ b/entity/src/epilot/models/operations/getschemaversions.py @@ -36,9 +36,12 @@ class GetSchemaVersions200ApplicationJSON: @dataclasses.dataclass class GetSchemaVersionsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" get_schema_versions_200_application_json_object: Optional[GetSchemaVersions200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/gettaxonomy.py b/entity/src/epilot/models/operations/gettaxonomy.py index 209a15e83..e0d171fd7 100755 --- a/entity/src/epilot/models/operations/gettaxonomy.py +++ b/entity/src/epilot/models/operations/gettaxonomy.py @@ -20,8 +20,11 @@ class GetTaxonomyRequest: @dataclasses.dataclass class GetTaxonomyResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" taxonomy: Optional[shared_taxonomy.Taxonomy] = dataclasses.field(default=None) r"""Taxonomy""" diff --git a/entity/src/epilot/models/operations/importentities.py b/entity/src/epilot/models/operations/importentities.py index ca38dda0a..adedfb808 100755 --- a/entity/src/epilot/models/operations/importentities.py +++ b/entity/src/epilot/models/operations/importentities.py @@ -21,7 +21,10 @@ class ImportEntitiesRequest: @dataclasses.dataclass class ImportEntitiesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/listfavoriteviewsforuser.py b/entity/src/epilot/models/operations/listfavoriteviewsforuser.py index aed861205..eabd197c5 100755 --- a/entity/src/epilot/models/operations/listfavoriteviewsforuser.py +++ b/entity/src/epilot/models/operations/listfavoriteviewsforuser.py @@ -23,9 +23,12 @@ class ListFavoriteViewsForUser200ApplicationJSON: @dataclasses.dataclass class ListFavoriteViewsForUserResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" list_favorite_views_for_user_200_application_json_object: Optional[ListFavoriteViewsForUser200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/listsavedviews.py b/entity/src/epilot/models/operations/listsavedviews.py index 2273d8b7b..070395f45 100755 --- a/entity/src/epilot/models/operations/listsavedviews.py +++ b/entity/src/epilot/models/operations/listsavedviews.py @@ -23,9 +23,12 @@ class ListSavedViews200ApplicationJSON: @dataclasses.dataclass class ListSavedViewsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" list_saved_views_200_application_json_object: Optional[ListSavedViews200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/listschemablueprints.py b/entity/src/epilot/models/operations/listschemablueprints.py index cb4edc4f8..7d0f83b00 100755 --- a/entity/src/epilot/models/operations/listschemablueprints.py +++ b/entity/src/epilot/models/operations/listschemablueprints.py @@ -23,9 +23,12 @@ class ListSchemaBlueprints200ApplicationJSON: @dataclasses.dataclass class ListSchemaBlueprintsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" list_schema_blueprints_200_application_json_object: Optional[ListSchemaBlueprints200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/listschemas.py b/entity/src/epilot/models/operations/listschemas.py index 7dd2cbd30..61fdf4566 100755 --- a/entity/src/epilot/models/operations/listschemas.py +++ b/entity/src/epilot/models/operations/listschemas.py @@ -32,9 +32,12 @@ class ListSchemas200ApplicationJSON: @dataclasses.dataclass class ListSchemasResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" list_schemas_200_application_json_object: Optional[ListSchemas200ApplicationJSON] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/listtaxonomies.py b/entity/src/epilot/models/operations/listtaxonomies.py index 7f1d30fec..58085ef51 100755 --- a/entity/src/epilot/models/operations/listtaxonomies.py +++ b/entity/src/epilot/models/operations/listtaxonomies.py @@ -23,9 +23,12 @@ class ListTaxonomies200ApplicationJSON: @dataclasses.dataclass class ListTaxonomiesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" list_taxonomies_200_application_json_object: Optional[ListTaxonomies200ApplicationJSON] = dataclasses.field(default=None) r"""Returns list of taxonomies in an organisation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py index 49ffd909e..3739a4d8e 100755 --- a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py +++ b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py @@ -34,9 +34,12 @@ class ListTaxonomyClassificationsForSchema200ApplicationJSON: @dataclasses.dataclass class ListTaxonomyClassificationsForSchemaResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" list_taxonomy_classifications_for_schema_200_application_json_object: Optional[ListTaxonomyClassificationsForSchema200ApplicationJSON] = dataclasses.field(default=None) r"""List of taxonomy classifications""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/patchentity.py b/entity/src/epilot/models/operations/patchentity.py index 55efcc620..6ae20adaa 100755 --- a/entity/src/epilot/models/operations/patchentity.py +++ b/entity/src/epilot/models/operations/patchentity.py @@ -28,9 +28,12 @@ class PatchEntityRequest: @dataclasses.dataclass class PatchEntityResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) r"""Entity was updated""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/putschema.py b/entity/src/epilot/models/operations/putschema.py index cdd19e756..f01e25b32 100755 --- a/entity/src/epilot/models/operations/putschema.py +++ b/entity/src/epilot/models/operations/putschema.py @@ -22,9 +22,12 @@ class PutSchemaRequest: @dataclasses.dataclass class PutSchemaResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" entity_schema_item: Optional[shared_entityschemaitem.EntitySchemaItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/searchentities.py b/entity/src/epilot/models/operations/searchentities.py index 9149446ec..3e192bb59 100755 --- a/entity/src/epilot/models/operations/searchentities.py +++ b/entity/src/epilot/models/operations/searchentities.py @@ -11,10 +11,13 @@ @dataclasses.dataclass class SearchEntitiesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" entity_search_results: Optional[shared_entitysearchresults.EntitySearchResults] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" search_entities_200_text_csv_string: Optional[str] = dataclasses.field(default=None) r"""Success""" diff --git a/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py b/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py index 3efb371f7..eee961df0 100755 --- a/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py +++ b/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py @@ -42,8 +42,11 @@ class TaxonomiesClassificationsSearch200ApplicationJSON: @dataclasses.dataclass class TaxonomiesClassificationsSearchResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" taxonomies_classifications_search_200_application_json_object: Optional[TaxonomiesClassificationsSearch200ApplicationJSON] = dataclasses.field(default=None) r"""Returns list of taxonomy classifications""" diff --git a/entity/src/epilot/models/operations/taxonomyautocomplete.py b/entity/src/epilot/models/operations/taxonomyautocomplete.py index 661a4c6c9..541316030 100755 --- a/entity/src/epilot/models/operations/taxonomyautocomplete.py +++ b/entity/src/epilot/models/operations/taxonomyautocomplete.py @@ -36,8 +36,11 @@ class TaxonomyAutocomplete200ApplicationJSON: @dataclasses.dataclass class TaxonomyAutocompleteResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" taxonomy_autocomplete_200_application_json_object: Optional[TaxonomyAutocomplete200ApplicationJSON] = dataclasses.field(default=None) r"""Taxonomy classifications""" diff --git a/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py b/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py index 78378d94c..a3c03a31e 100755 --- a/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py +++ b/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py @@ -42,8 +42,11 @@ class UpdateClassificationsForTaxonomy200ApplicationJSON: @dataclasses.dataclass class UpdateClassificationsForTaxonomyResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" update_classifications_for_taxonomy_200_application_json_object: Optional[UpdateClassificationsForTaxonomy200ApplicationJSON] = dataclasses.field(default=None) r"""Taxonomies classifications""" diff --git a/entity/src/epilot/models/operations/updateentity.py b/entity/src/epilot/models/operations/updateentity.py index 8e6c8a0ab..6492e595d 100755 --- a/entity/src/epilot/models/operations/updateentity.py +++ b/entity/src/epilot/models/operations/updateentity.py @@ -26,9 +26,12 @@ class UpdateEntityRequest: @dataclasses.dataclass class UpdateEntityResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/updaterelation.py b/entity/src/epilot/models/operations/updaterelation.py index 40576b729..3b1a30250 100755 --- a/entity/src/epilot/models/operations/updaterelation.py +++ b/entity/src/epilot/models/operations/updaterelation.py @@ -42,8 +42,11 @@ class UpdateRelationRequest: @dataclasses.dataclass class UpdateRelationResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" relation_item: Optional[shared_relationitem.RelationItem] = dataclasses.field(default=None) r"""Success""" diff --git a/entity/src/epilot/models/operations/updatesavedview.py b/entity/src/epilot/models/operations/updatesavedview.py index 7dc152c1d..7133ccbd0 100755 --- a/entity/src/epilot/models/operations/updatesavedview.py +++ b/entity/src/epilot/models/operations/updatesavedview.py @@ -22,8 +22,11 @@ class UpdateSavedViewRequest: @dataclasses.dataclass class UpdateSavedViewResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" saved_view_item: Optional[shared_savedviewitem.SavedViewItem] = dataclasses.field(default=None) r"""Success""" diff --git a/entity/src/epilot/models/operations/upsertentity.py b/entity/src/epilot/models/operations/upsertentity.py index 39939f2eb..e9722a2e9 100755 --- a/entity/src/epilot/models/operations/upsertentity.py +++ b/entity/src/epilot/models/operations/upsertentity.py @@ -38,9 +38,12 @@ class UpsertEntityRequest: @dataclasses.dataclass class UpsertEntityResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) r"""Entity was updated""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 5c71d068e..22f69897c 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,8 +19,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.23.8' - gen_version: str = '2.125.1' + sdk_version: str = '1.24.0' + gen_version: str = '2.129.1' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: From aceb6cefadc06f7220369d28900cb0ca69253f42 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 27 Sep 2023 01:14:39 +0000 Subject: [PATCH 41/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.2 --- entity/README.md | 16 +- entity/RELEASES.md | 10 +- .../autocomplete200applicationjson.md | 8 +- .../autocomplete200applicationjsonresults.md | 23 +++ .../models/operations/getrelationsresponse.md | 12 +- entity/docs/models/shared/attribute.md | 173 +++++++++++++++++ entity/docs/models/shared/entitycapability.md | 20 +- .../docs/models/shared/entitydefaulttable.md | 16 +- .../shared/entitydefaulttabledropdownitems.md | 17 ++ entity/docs/models/shared/entityschema.md | 40 ++-- entity/docs/models/shared/entityschemaitem.md | 50 ++--- .../models/shared/entityschemaitemuiconfig.md | 16 +- .../entityschemaitemuiconfigcreateview.md | 23 +++ .../entityschemaitemuiconfigeditview.md | 23 +++ .../entityschemaitemuiconfiglistitem.md | 6 +- ...maitemuiconfiglistitemsummaryattributes.md | 17 ++ .../entityschemaitemuiconfigsingleview.md | 23 +++ .../entityschemaitemuiconfigtableview.md | 23 +++ .../models/shared/entityschemauiconfig.md | 16 +- .../shared/entityschemauiconfigcreateview.md | 23 +++ .../shared/entityschemauiconfigeditview.md | 23 +++ .../shared/entityschemauiconfiglistitem.md | 6 +- ...schemauiconfiglistitemsummaryattributes.md | 17 ++ .../shared/entityschemauiconfigsingleview.md | 23 +++ .../shared/entityschemauiconfigtableview.md | 23 +++ entity/docs/models/shared/getrelationsresp.md | 17 ++ .../shared/getrelationsrespwithpagination.md | 8 +- .../models/shared/multiselectattribute.md | 2 +- .../shared/multiselectattributeoptions.md | 17 ++ .../docs/models/shared/relationattribute.md | 2 +- .../shared/relationattributesummaryfields.md | 17 ++ entity/docs/models/shared/savedview.md | 18 +- .../docs/models/shared/savedviewcreatedby.md | 17 ++ entity/docs/models/shared/savedviewitem.md | 24 +-- .../models/shared/savedviewitemcreatedby.md | 17 ++ entity/docs/models/shared/selectattribute.md | 2 +- .../models/shared/selectattributeoptions.md | 17 ++ entity/docs/models/shared/statusattribute.md | 2 +- .../models/shared/statusattributeoptions.md | 17 ++ entity/docs/sdks/activity/README.md | 1 + entity/docs/sdks/entities/README.md | 1 + entity/docs/sdks/entityimport/README.md | 1 + entity/docs/sdks/epilot/README.md | 1 + entity/docs/sdks/export/README.md | 1 + entity/docs/sdks/relations/README.md | 1 + entity/docs/sdks/savedviews/README.md | 19 +- entity/docs/sdks/schemas/README.md | 175 +++--------------- entity/docs/sdks/taxonomy/README.md | 31 ++-- entity/files.gen | 20 ++ entity/gen.yaml | 8 +- entity/setup.py | 4 +- .../src/epilot/models/operations/__init__.py | 2 +- .../epilot/models/operations/autocomplete.py | 10 +- .../epilot/models/operations/getrelations.py | 5 +- entity/src/epilot/models/shared/__init__.py | 2 +- .../epilot/models/shared/entitycapability.py | 32 +++- .../models/shared/entitydefaulttable.py | 10 +- .../src/epilot/models/shared/entityschema.py | 78 +++++++- .../epilot/models/shared/entityschemaitem.py | 78 +++++++- .../shared/getrelationsrespwithpagination.py | 5 +- .../models/shared/multiselectattribute.py | 10 +- .../epilot/models/shared/relationattribute.py | 11 +- entity/src/epilot/models/shared/savedview.py | 10 +- .../src/epilot/models/shared/savedviewitem.py | 10 +- .../epilot/models/shared/selectattribute.py | 10 +- .../epilot/models/shared/statusattribute.py | 10 +- entity/src/epilot/relations.py | 4 +- entity/src/epilot/sdkconfiguration.py | 4 +- entity/src/epilot/utils/utils.py | 8 + 69 files changed, 1034 insertions(+), 352 deletions(-) create mode 100755 entity/docs/models/operations/autocomplete200applicationjsonresults.md create mode 100755 entity/docs/models/shared/attribute.md create mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems.md create mode 100755 entity/docs/models/shared/entityschemaitemuiconfigcreateview.md create mode 100755 entity/docs/models/shared/entityschemaitemuiconfigeditview.md create mode 100755 entity/docs/models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md create mode 100755 entity/docs/models/shared/entityschemaitemuiconfigsingleview.md create mode 100755 entity/docs/models/shared/entityschemaitemuiconfigtableview.md create mode 100755 entity/docs/models/shared/entityschemauiconfigcreateview.md create mode 100755 entity/docs/models/shared/entityschemauiconfigeditview.md create mode 100755 entity/docs/models/shared/entityschemauiconfiglistitemsummaryattributes.md create mode 100755 entity/docs/models/shared/entityschemauiconfigsingleview.md create mode 100755 entity/docs/models/shared/entityschemauiconfigtableview.md create mode 100755 entity/docs/models/shared/getrelationsresp.md create mode 100755 entity/docs/models/shared/multiselectattributeoptions.md create mode 100755 entity/docs/models/shared/relationattributesummaryfields.md create mode 100755 entity/docs/models/shared/savedviewcreatedby.md create mode 100755 entity/docs/models/shared/savedviewitemcreatedby.md create mode 100755 entity/docs/models/shared/selectattributeoptions.md create mode 100755 entity/docs/models/shared/statusattributeoptions.md diff --git a/entity/README.md b/entity/README.md index 1ab6167d3..fe283ccb3 100755 --- a/entity/README.md +++ b/entity/README.md @@ -38,14 +38,14 @@ if res.activity_item is not None: ## Available Resources and Operations -### [Activity](docs/sdks/activity/README.md) +### [activity](docs/sdks/activity/README.md) * [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 -### [Entities](docs/sdks/entities/README.md) +### [entities](docs/sdks/entities/README.md) * [autocomplete](docs/sdks/entities/README.md#autocomplete) - autocomplete * [create_entity](docs/sdks/entities/README.md#create_entity) - createEntity @@ -56,15 +56,15 @@ if res.activity_item is not None: * [update_entity](docs/sdks/entities/README.md#update_entity) - updateEntity * [upsert_entity](docs/sdks/entities/README.md#upsert_entity) - upsertEntity -### [EntityImport](docs/sdks/entityimport/README.md) +### [entity_import](docs/sdks/entityimport/README.md) * [import_entities](docs/sdks/entityimport/README.md#import_entities) - Import Entities -### [Export](docs/sdks/export/README.md) +### [export](docs/sdks/export/README.md) * [export_entities](docs/sdks/export/README.md#export_entities) - exportEntities -### [Relations](docs/sdks/relations/README.md) +### [relations](docs/sdks/relations/README.md) * [add_relations](docs/sdks/relations/README.md#add_relations) - addRelations * [delete_relation](docs/sdks/relations/README.md#delete_relation) - deleteRelation @@ -72,7 +72,7 @@ if res.activity_item is not None: * [get_relations_v2](docs/sdks/relations/README.md#get_relations_v2) - getRelationsV2 * [update_relation](docs/sdks/relations/README.md#update_relation) - updateRelation -### [SavedViews](docs/sdks/savedviews/README.md) +### [saved_views](docs/sdks/savedviews/README.md) * [create_saved_view](docs/sdks/savedviews/README.md#create_saved_view) - createSavedView * [delete_saved_view](docs/sdks/savedviews/README.md#delete_saved_view) - deleteSavedView @@ -81,7 +81,7 @@ if res.activity_item is not None: * [list_saved_views](docs/sdks/savedviews/README.md#list_saved_views) - listSavedViews * [update_saved_view](docs/sdks/savedviews/README.md#update_saved_view) - updateSavedView -### [Schemas](docs/sdks/schemas/README.md) +### [schemas](docs/sdks/schemas/README.md) * [delete_schema](docs/sdks/schemas/README.md#delete_schema) - deleteSchema * [get_schema](docs/sdks/schemas/README.md#get_schema) - getSchema @@ -91,7 +91,7 @@ if res.activity_item is not None: * [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 -### [Taxonomy](docs/sdks/taxonomy/README.md) +### [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 diff --git a/entity/RELEASES.md b/entity/RELEASES.md index d32c2396e..6383a3b47 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -300,4 +300,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.91.0 (2.129.1) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.24.0] entity \ No newline at end of file +- [python v1.24.0] entity + +## 2023-09-27 01:14:11 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.91.2 (2.131.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.24.1] entity \ No newline at end of file diff --git a/entity/docs/models/operations/autocomplete200applicationjson.md b/entity/docs/models/operations/autocomplete200applicationjson.md index a2806b21c..6a664b07a 100755 --- a/entity/docs/models/operations/autocomplete200applicationjson.md +++ b/entity/docs/models/operations/autocomplete200applicationjson.md @@ -5,7 +5,7 @@ Success ## Fields -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `results` | list[*Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `results` | list[[Union[str, bool, dict[str, Any]]](../../models/operations/autocomplete200applicationjsonresults.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/operations/autocomplete200applicationjsonresults.md b/entity/docs/models/operations/autocomplete200applicationjsonresults.md new file mode 100755 index 000000000..a52f37b03 --- /dev/null +++ b/entity/docs/models/operations/autocomplete200applicationjsonresults.md @@ -0,0 +1,23 @@ +# Autocomplete200ApplicationJSONResults + + +## Supported Types + +### + +```python +autocomplete200ApplicationJSONResults: str = /* values here */ +``` + +### + +```python +autocomplete200ApplicationJSONResults: bool = /* values here */ +``` + +### + +```python +autocomplete200ApplicationJSONResults: dict[str, Any] = /* values here */ +``` + diff --git a/entity/docs/models/operations/getrelationsresponse.md b/entity/docs/models/operations/getrelationsresponse.md index 4ae26513d..148425e2d 100755 --- a/entity/docs/models/operations/getrelationsresponse.md +++ b/entity/docs/models/operations/getrelationsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `get_relations_resp` | list[*Any*] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `get_relations_resp` | list[[Union[shared.RelationItem, dict[str, Any]]](../../models/shared/getrelationsresp.md)] | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/shared/attribute.md b/entity/docs/models/shared/attribute.md new file mode 100755 index 000000000..4a9b2f250 --- /dev/null +++ b/entity/docs/models/shared/attribute.md @@ -0,0 +1,173 @@ +# Attribute + + +## Supported Types + +### TextAttribute + +```python +attribute: shared.TextAttribute = /* values here */ +``` + +### LinkAttribute + +```python +attribute: shared.LinkAttribute = /* values here */ +``` + +### DateAttribute + +```python +attribute: shared.DateAttribute = /* values here */ +``` + +### CountryAttribute + +```python +attribute: shared.CountryAttribute = /* values here */ +``` + +### BooleanAttribute + +```python +attribute: shared.BooleanAttribute = /* values here */ +``` + +### SelectAttribute + +```python +attribute: shared.SelectAttribute = /* values here */ +``` + +### MultiSelectAttribute + +```python +attribute: shared.MultiSelectAttribute = /* values here */ +``` + +### StatusAttribute + +```python +attribute: shared.StatusAttribute = /* values here */ +``` + +### SequenceAttribute + +```python +attribute: shared.SequenceAttribute = /* values here */ +``` + +### RelationAttribute + +```python +attribute: shared.RelationAttribute = /* values here */ +``` + +### UserRelationAttribute + +```python +attribute: shared.UserRelationAttribute = /* values here */ +``` + +### AddressRelationAttribute + +```python +attribute: shared.AddressRelationAttribute = /* values here */ +``` + +### PaymentMethodRelationAttribute + +```python +attribute: shared.PaymentMethodRelationAttribute = /* values here */ +``` + +### CurrencyAttribute + +```python +attribute: shared.CurrencyAttribute = /* values here */ +``` + +### RepeatableAttribute + +```python +attribute: shared.RepeatableAttribute = /* values here */ +``` + +### TagsAttribute + +```python +attribute: shared.TagsAttribute = /* values here */ +``` + +### NumberAttribute + +```python +attribute: shared.NumberAttribute = /* values here */ +``` + +### ConsentAttribute + +```python +attribute: shared.ConsentAttribute = /* values here */ +``` + +### InternalAttribute + +```python +attribute: shared.InternalAttribute = /* values here */ +``` + +### OrderedListAttribute + +```python +attribute: shared.OrderedListAttribute = /* values here */ +``` + +### FileAttribute + +```python +attribute: shared.FileAttribute = /* values here */ +``` + +### ComputedAttribute + +```python +attribute: shared.ComputedAttribute = /* values here */ +``` + +### PartnerStatusAttribute + +```python +attribute: shared.PartnerStatusAttribute = /* values here */ +``` + +### InvitationEmailAttribute + +```python +attribute: shared.InvitationEmailAttribute = /* values here */ +``` + +### AutomationAttribute + +```python +attribute: shared.AutomationAttribute = /* values here */ +``` + +### InternalUserAttribute + +```python +attribute: shared.InternalUserAttribute = /* values here */ +``` + +### PurposeAttribute + +```python +attribute: shared.PurposeAttribute = /* values here */ +``` + +### PartnerOrganisationAttribute + +```python +attribute: shared.PartnerOrganisationAttribute = /* values here */ +``` + diff --git a/entity/docs/models/shared/entitycapability.md b/entity/docs/models/shared/entitycapability.md index f26fe754c..0c39a607d 100755 --- a/entity/docs/models/shared/entitycapability.md +++ b/entity/docs/models/shared/entitycapability.md @@ -5,13 +5,13 @@ Capabilities the Entity has. Turn features on/off for entities. ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `attributes` | list[*Any*] | :heavy_minus_sign: | N/A | | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show capability for legacy tenants (ivy) | | -| `name` | *str* | :heavy_check_mark: | Unique name for the capability | customer_messaging | -| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the setting is enabled | MY_SETTING | -| `title` | *Optional[str]* | :heavy_minus_sign: | Human readable title of the capability | Messaging | -| `ui_hooks` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_minus_sign: | N/A | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show capability for legacy tenants (ivy) | | +| `name` | *str* | :heavy_check_mark: | Unique name for the capability | customer_messaging | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the setting is enabled | MY_SETTING | +| `title` | *Optional[str]* | :heavy_minus_sign: | Human readable title of the capability | Messaging | +| `ui_hooks` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttable.md b/entity/docs/models/shared/entitydefaulttable.md index 6876c1e58..4fd442fe1 100755 --- a/entity/docs/models/shared/entitydefaulttable.md +++ b/entity/docs/models/shared/entitydefaulttable.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `classic_view` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `dropdown_items` | list[*Any*] | :heavy_minus_sign: | N/A | -| `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | -| `navbar_actions` | list[[EntityDefaultTableNavbarActions](../../models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | -| `row_actions` | list[*str*] | :heavy_minus_sign: | N/A | -| `view_type` | [Optional[EntityDefaultTableViewType]](../../models/shared/entitydefaulttableviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `classic_view` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `dropdown_items` | list[[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]](../../models/shared/entitydefaulttabledropdownitems.md)] | :heavy_minus_sign: | N/A | +| `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | +| `navbar_actions` | list[[EntityDefaultTableNavbarActions](../../models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | +| `row_actions` | list[*str*] | :heavy_minus_sign: | N/A | +| `view_type` | [Optional[EntityDefaultTableViewType]](../../models/shared/entitydefaulttableviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems.md b/entity/docs/models/shared/entitydefaulttabledropdownitems.md new file mode 100755 index 000000000..094f75c0b --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems.md @@ -0,0 +1,17 @@ +# EntityDefaultTableDropdownItems + + +## Supported Types + +### EntityDefaultTableDropdownItems1 + +```python +entityDefaultTableDropdownItems: shared.EntityDefaultTableDropdownItems1 = /* values here */ +``` + +### EntityDefaultTableDropdownItems2 + +```python +entityDefaultTableDropdownItems: shared.EntityDefaultTableDropdownItems2 = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschema.md b/entity/docs/models/shared/entityschema.md index f3aeeaa52..db8ca673b 100755 --- a/entity/docs/models/shared/entityschema.md +++ b/entity/docs/models/shared/entityschema.md @@ -5,23 +5,23 @@ The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relati ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `attributes` | list[*Any*] | :heavy_check_mark: | An ordered list of attributes the entity contains | | -| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | -| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | -| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | -| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `group_settings` | list[[EntitySchemaGroupSettings](../../models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | -| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | -| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | -| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | -| `plural` | *str* | :heavy_check_mark: | N/A | Contacts | -| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | -| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | -| `ui_config` | [Optional[EntitySchemaUIConfig]](../../models/shared/entityschemauiconfig.md) | :heavy_minus_sign: | N/A | | -| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | | +| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | +| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | +| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | +| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group_settings` | list[[EntitySchemaGroupSettings](../../models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | +| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | +| `plural` | *str* | :heavy_check_mark: | N/A | Contacts | +| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | +| `ui_config` | [Optional[EntitySchemaUIConfig]](../../models/shared/entityschemauiconfig.md) | :heavy_minus_sign: | N/A | | +| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitem.md b/entity/docs/models/shared/entityschemaitem.md index cb1edcd66..4bc70a6a4 100755 --- a/entity/docs/models/shared/entityschemaitem.md +++ b/entity/docs/models/shared/entityschemaitem.md @@ -5,28 +5,28 @@ The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relati ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `attributes` | list[*Any*] | :heavy_check_mark: | An ordered list of attributes the entity contains | | -| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | -| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | -| `comment` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | -| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `group_settings` | list[[EntitySchemaItemGroupSettings](../../models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | -| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | -| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for schema | | -| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | -| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | -| `plural` | *str* | :heavy_check_mark: | N/A | Contacts | -| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | -| `source` | [Optional[EntitySchemaItemSource]](../../models/shared/entityschemaitemsource.md) | :heavy_minus_sign: | N/A | | -| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | -| `ui_config` | [Optional[EntitySchemaItemUIConfig]](../../models/shared/entityschemaitemuiconfig.md) | :heavy_minus_sign: | N/A | | -| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | | +| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | +| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | +| `comment` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | +| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group_settings` | list[[EntitySchemaItemGroupSettings](../../models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | +| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for schema | | +| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | +| `plural` | *str* | :heavy_check_mark: | N/A | Contacts | +| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `source` | [Optional[EntitySchemaItemSource]](../../models/shared/entityschemaitemsource.md) | :heavy_minus_sign: | N/A | | +| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | +| `ui_config` | [Optional[EntitySchemaItemUIConfig]](../../models/shared/entityschemaitemuiconfig.md) | :heavy_minus_sign: | N/A | | +| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfig.md b/entity/docs/models/shared/entityschemaitemuiconfig.md index 58331349a..94301cef2 100755 --- a/entity/docs/models/shared/entityschemaitemuiconfig.md +++ b/entity/docs/models/shared/entityschemaitemuiconfig.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `create_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `edit_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `list_item` | [Optional[EntitySchemaItemUIConfigListItem]](../../models/shared/entityschemaitemuiconfiglistitem.md) | :heavy_minus_sign: | N/A | -| `sharing` | [Optional[EntitySchemaItemUIConfigSharing]](../../models/shared/entityschemaitemuiconfigsharing.md) | :heavy_minus_sign: | N/A | -| `single_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `table_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `create_view` | [Optional[Union[EntityDefaultCreate, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigcreateview.md) | :heavy_minus_sign: | N/A | +| `edit_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigeditview.md) | :heavy_minus_sign: | N/A | +| `list_item` | [Optional[EntitySchemaItemUIConfigListItem]](../../models/shared/entityschemaitemuiconfiglistitem.md) | :heavy_minus_sign: | N/A | +| `sharing` | [Optional[EntitySchemaItemUIConfigSharing]](../../models/shared/entityschemaitemuiconfigsharing.md) | :heavy_minus_sign: | N/A | +| `single_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigsingleview.md) | :heavy_minus_sign: | N/A | +| `table_view` | [Optional[Union[EntityDefaultTable, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigtableview.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfigcreateview.md b/entity/docs/models/shared/entityschemaitemuiconfigcreateview.md new file mode 100755 index 000000000..734499189 --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemuiconfigcreateview.md @@ -0,0 +1,23 @@ +# EntitySchemaItemUIConfigCreateView + + +## Supported Types + +### EntityDefaultCreate + +```python +entitySchemaItemUIConfigCreateView: shared.EntityDefaultCreate = /* values here */ +``` + +### RedirectEntityView + +```python +entitySchemaItemUIConfigCreateView: shared.RedirectEntityView = /* values here */ +``` + +### EntityViewDisabled + +```python +entitySchemaItemUIConfigCreateView: shared.EntityViewDisabled = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschemaitemuiconfigeditview.md b/entity/docs/models/shared/entityschemaitemuiconfigeditview.md new file mode 100755 index 000000000..32c130696 --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemuiconfigeditview.md @@ -0,0 +1,23 @@ +# EntitySchemaItemUIConfigEditView + + +## Supported Types + +### EntityDefaultEdit + +```python +entitySchemaItemUIConfigEditView: shared.EntityDefaultEdit = /* values here */ +``` + +### RedirectEntityView + +```python +entitySchemaItemUIConfigEditView: shared.RedirectEntityView = /* values here */ +``` + +### EntityViewDisabled + +```python +entitySchemaItemUIConfigEditView: shared.EntityViewDisabled = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md index 845449901..baa96f3e0 100755 --- a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md +++ b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `summary_attributes` | list[*Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `summary_attributes` | list[[Union[SummaryAttribute, str]](../../models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md b/entity/docs/models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md new file mode 100755 index 000000000..bc6ec6f32 --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md @@ -0,0 +1,17 @@ +# EntitySchemaItemUIConfigListItemSummaryAttributes + + +## Supported Types + +### SummaryAttribute + +```python +entitySchemaItemUIConfigListItemSummaryAttributes: shared.SummaryAttribute = /* values here */ +``` + +### + +```python +entitySchemaItemUIConfigListItemSummaryAttributes: str = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschemaitemuiconfigsingleview.md b/entity/docs/models/shared/entityschemaitemuiconfigsingleview.md new file mode 100755 index 000000000..42746d287 --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemuiconfigsingleview.md @@ -0,0 +1,23 @@ +# EntitySchemaItemUIConfigSingleView + + +## Supported Types + +### EntityDefaultEdit + +```python +entitySchemaItemUIConfigSingleView: shared.EntityDefaultEdit = /* values here */ +``` + +### RedirectEntityView + +```python +entitySchemaItemUIConfigSingleView: shared.RedirectEntityView = /* values here */ +``` + +### EntityViewDisabled + +```python +entitySchemaItemUIConfigSingleView: shared.EntityViewDisabled = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschemaitemuiconfigtableview.md b/entity/docs/models/shared/entityschemaitemuiconfigtableview.md new file mode 100755 index 000000000..9e4895685 --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemuiconfigtableview.md @@ -0,0 +1,23 @@ +# EntitySchemaItemUIConfigTableView + + +## Supported Types + +### EntityDefaultTable + +```python +entitySchemaItemUIConfigTableView: shared.EntityDefaultTable = /* values here */ +``` + +### RedirectEntityView + +```python +entitySchemaItemUIConfigTableView: shared.RedirectEntityView = /* values here */ +``` + +### EntityViewDisabled + +```python +entitySchemaItemUIConfigTableView: shared.EntityViewDisabled = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschemauiconfig.md b/entity/docs/models/shared/entityschemauiconfig.md index d3b9ae8e0..246332f95 100755 --- a/entity/docs/models/shared/entityschemauiconfig.md +++ b/entity/docs/models/shared/entityschemauiconfig.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `create_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `edit_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `list_item` | [Optional[EntitySchemaUIConfigListItem]](../../models/shared/entityschemauiconfiglistitem.md) | :heavy_minus_sign: | N/A | -| `sharing` | [Optional[EntitySchemaUIConfigSharing]](../../models/shared/entityschemauiconfigsharing.md) | :heavy_minus_sign: | N/A | -| `single_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `table_view` | *Optional[Any]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `create_view` | [Optional[Union[EntityDefaultCreate, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigcreateview.md) | :heavy_minus_sign: | N/A | +| `edit_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigeditview.md) | :heavy_minus_sign: | N/A | +| `list_item` | [Optional[EntitySchemaUIConfigListItem]](../../models/shared/entityschemauiconfiglistitem.md) | :heavy_minus_sign: | N/A | +| `sharing` | [Optional[EntitySchemaUIConfigSharing]](../../models/shared/entityschemauiconfigsharing.md) | :heavy_minus_sign: | N/A | +| `single_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigsingleview.md) | :heavy_minus_sign: | N/A | +| `table_view` | [Optional[Union[EntityDefaultTable, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigtableview.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfigcreateview.md b/entity/docs/models/shared/entityschemauiconfigcreateview.md new file mode 100755 index 000000000..323b58096 --- /dev/null +++ b/entity/docs/models/shared/entityschemauiconfigcreateview.md @@ -0,0 +1,23 @@ +# EntitySchemaUIConfigCreateView + + +## Supported Types + +### EntityDefaultCreate + +```python +entitySchemaUIConfigCreateView: shared.EntityDefaultCreate = /* values here */ +``` + +### RedirectEntityView + +```python +entitySchemaUIConfigCreateView: shared.RedirectEntityView = /* values here */ +``` + +### EntityViewDisabled + +```python +entitySchemaUIConfigCreateView: shared.EntityViewDisabled = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschemauiconfigeditview.md b/entity/docs/models/shared/entityschemauiconfigeditview.md new file mode 100755 index 000000000..44af4c892 --- /dev/null +++ b/entity/docs/models/shared/entityschemauiconfigeditview.md @@ -0,0 +1,23 @@ +# EntitySchemaUIConfigEditView + + +## Supported Types + +### EntityDefaultEdit + +```python +entitySchemaUIConfigEditView: shared.EntityDefaultEdit = /* values here */ +``` + +### RedirectEntityView + +```python +entitySchemaUIConfigEditView: shared.RedirectEntityView = /* values here */ +``` + +### EntityViewDisabled + +```python +entitySchemaUIConfigEditView: shared.EntityViewDisabled = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschemauiconfiglistitem.md b/entity/docs/models/shared/entityschemauiconfiglistitem.md index b2d3ad383..d55ca9564 100755 --- a/entity/docs/models/shared/entityschemauiconfiglistitem.md +++ b/entity/docs/models/shared/entityschemauiconfiglistitem.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `summary_attributes` | list[*Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `summary_attributes` | list[[Union[SummaryAttribute, str]](../../models/shared/entityschemauiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfiglistitemsummaryattributes.md b/entity/docs/models/shared/entityschemauiconfiglistitemsummaryattributes.md new file mode 100755 index 000000000..ed0f9a509 --- /dev/null +++ b/entity/docs/models/shared/entityschemauiconfiglistitemsummaryattributes.md @@ -0,0 +1,17 @@ +# EntitySchemaUIConfigListItemSummaryAttributes + + +## Supported Types + +### SummaryAttribute + +```python +entitySchemaUIConfigListItemSummaryAttributes: shared.SummaryAttribute = /* values here */ +``` + +### + +```python +entitySchemaUIConfigListItemSummaryAttributes: str = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschemauiconfigsingleview.md b/entity/docs/models/shared/entityschemauiconfigsingleview.md new file mode 100755 index 000000000..58e0d9c60 --- /dev/null +++ b/entity/docs/models/shared/entityschemauiconfigsingleview.md @@ -0,0 +1,23 @@ +# EntitySchemaUIConfigSingleView + + +## Supported Types + +### EntityDefaultEdit + +```python +entitySchemaUIConfigSingleView: shared.EntityDefaultEdit = /* values here */ +``` + +### RedirectEntityView + +```python +entitySchemaUIConfigSingleView: shared.RedirectEntityView = /* values here */ +``` + +### EntityViewDisabled + +```python +entitySchemaUIConfigSingleView: shared.EntityViewDisabled = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschemauiconfigtableview.md b/entity/docs/models/shared/entityschemauiconfigtableview.md new file mode 100755 index 000000000..30d2ea629 --- /dev/null +++ b/entity/docs/models/shared/entityschemauiconfigtableview.md @@ -0,0 +1,23 @@ +# EntitySchemaUIConfigTableView + + +## Supported Types + +### EntityDefaultTable + +```python +entitySchemaUIConfigTableView: shared.EntityDefaultTable = /* values here */ +``` + +### RedirectEntityView + +```python +entitySchemaUIConfigTableView: shared.RedirectEntityView = /* values here */ +``` + +### EntityViewDisabled + +```python +entitySchemaUIConfigTableView: shared.EntityViewDisabled = /* values here */ +``` + diff --git a/entity/docs/models/shared/getrelationsresp.md b/entity/docs/models/shared/getrelationsresp.md new file mode 100755 index 000000000..8f246b248 --- /dev/null +++ b/entity/docs/models/shared/getrelationsresp.md @@ -0,0 +1,17 @@ +# GetRelationsResp + + +## Supported Types + +### RelationItem + +```python +getRelationsResp: shared.RelationItem = /* values here */ +``` + +### + +```python +getRelationsResp: dict[str, Any] = /* values here */ +``` + diff --git a/entity/docs/models/shared/getrelationsrespwithpagination.md b/entity/docs/models/shared/getrelationsrespwithpagination.md index e53ea39ac..37bfbbe33 100755 --- a/entity/docs/models/shared/getrelationsrespwithpagination.md +++ b/entity/docs/models/shared/getrelationsrespwithpagination.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `relations` | list[*Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `relations` | list[[Union[RelationItem, dict[str, Any]]](../../models/shared/getrelationsresp.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattribute.md b/entity/docs/models/shared/multiselectattribute.md index 7622d371e..93811b3a9 100755 --- a/entity/docs/models/shared/multiselectattribute.md +++ b/entity/docs/models/shared/multiselectattribute.md @@ -24,7 +24,7 @@ Multi Choice Selection | `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `name` | *str* | :heavy_check_mark: | N/A | | -| `options` | list[*Any*] | :heavy_minus_sign: | N/A | | +| `options` | list[[Union[str, MultiSelectAttributeOptions2]](../../models/shared/multiselectattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/multiselectattributeoptions.md b/entity/docs/models/shared/multiselectattributeoptions.md new file mode 100755 index 000000000..3e9b78497 --- /dev/null +++ b/entity/docs/models/shared/multiselectattributeoptions.md @@ -0,0 +1,17 @@ +# MultiSelectAttributeOptions + + +## Supported Types + +### + +```python +multiSelectAttributeOptions: str = /* values here */ +``` + +### MultiSelectAttributeOptions2 + +```python +multiSelectAttributeOptions: shared.MultiSelectAttributeOptions2 = /* values here */ +``` + diff --git a/entity/docs/models/shared/relationattribute.md b/entity/docs/models/shared/relationattribute.md index 3b285a5fd..da8b5fa1d 100755 --- a/entity/docs/models/shared/relationattribute.md +++ b/entity/docs/models/shared/relationattribute.md @@ -44,6 +44,6 @@ Entity Relationship | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `summary_fields` | list[*Any*] | :heavy_minus_sign: | N/A | | +| `summary_fields` | list[[Union[str, SummaryField]](../../models/shared/relationattributesummaryfields.md)] | :heavy_minus_sign: | N/A | | | `type` | [Optional[RelationAttributeType]](../../models/shared/relationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributesummaryfields.md b/entity/docs/models/shared/relationattributesummaryfields.md new file mode 100755 index 000000000..664d8056d --- /dev/null +++ b/entity/docs/models/shared/relationattributesummaryfields.md @@ -0,0 +1,17 @@ +# RelationAttributeSummaryFields + + +## Supported Types + +### + +```python +relationAttributeSummaryFields: str = /* values here */ +``` + +### SummaryField + +```python +relationAttributeSummaryFields: shared.SummaryField = /* values here */ +``` + diff --git a/entity/docs/models/shared/savedview.md b/entity/docs/models/shared/savedview.md index 7df2a2ccb..e00cb8246 100755 --- a/entity/docs/models/shared/savedview.md +++ b/entity/docs/models/shared/savedview.md @@ -5,12 +5,12 @@ A saved entity view ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `created_by` | *Any* | :heavy_check_mark: | N/A | | -| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | -| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | -| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | -| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | -| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | -| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `created_by` | [Union[SavedViewCreatedBy1, dict[str, Any]]](../../models/shared/savedviewcreatedby.md) | :heavy_check_mark: | N/A | | +| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | +| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | +| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | +| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewcreatedby.md b/entity/docs/models/shared/savedviewcreatedby.md new file mode 100755 index 000000000..d32dba75d --- /dev/null +++ b/entity/docs/models/shared/savedviewcreatedby.md @@ -0,0 +1,17 @@ +# SavedViewCreatedBy + + +## Supported Types + +### SavedViewCreatedBy1 + +```python +savedViewCreatedBy: shared.SavedViewCreatedBy1 = /* values here */ +``` + +### + +```python +savedViewCreatedBy: dict[str, Any] = /* values here */ +``` + diff --git a/entity/docs/models/shared/savedviewitem.md b/entity/docs/models/shared/savedviewitem.md index 626a49369..4adfe17cd 100755 --- a/entity/docs/models/shared/savedviewitem.md +++ b/entity/docs/models/shared/savedviewitem.md @@ -5,15 +5,15 @@ A saved entity view ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `created_by` | *Any* | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | -| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | -| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | -| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | -| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | -| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | -| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | -| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `created_by` | [Union[SavedViewItemCreatedBy1, dict[str, Any]]](../../models/shared/savedviewitemcreatedby.md) | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | +| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | +| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | +| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | +| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | +| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewitemcreatedby.md b/entity/docs/models/shared/savedviewitemcreatedby.md new file mode 100755 index 000000000..971ca8720 --- /dev/null +++ b/entity/docs/models/shared/savedviewitemcreatedby.md @@ -0,0 +1,17 @@ +# SavedViewItemCreatedBy + + +## Supported Types + +### SavedViewItemCreatedBy1 + +```python +savedViewItemCreatedBy: shared.SavedViewItemCreatedBy1 = /* values here */ +``` + +### + +```python +savedViewItemCreatedBy: dict[str, Any] = /* values here */ +``` + diff --git a/entity/docs/models/shared/selectattribute.md b/entity/docs/models/shared/selectattribute.md index c6f8051ec..443b89dd0 100755 --- a/entity/docs/models/shared/selectattribute.md +++ b/entity/docs/models/shared/selectattribute.md @@ -22,7 +22,7 @@ Dropdown select | `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `name` | *str* | :heavy_check_mark: | N/A | | -| `options` | list[*Any*] | :heavy_minus_sign: | N/A | | +| `options` | list[[Union[SelectAttributeOptions1, str]](../../models/shared/selectattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/selectattributeoptions.md b/entity/docs/models/shared/selectattributeoptions.md new file mode 100755 index 000000000..f39224aa4 --- /dev/null +++ b/entity/docs/models/shared/selectattributeoptions.md @@ -0,0 +1,17 @@ +# SelectAttributeOptions + + +## Supported Types + +### SelectAttributeOptions1 + +```python +selectAttributeOptions: shared.SelectAttributeOptions1 = /* values here */ +``` + +### + +```python +selectAttributeOptions: str = /* values here */ +``` + diff --git a/entity/docs/models/shared/statusattribute.md b/entity/docs/models/shared/statusattribute.md index f73ab4da9..0a33a27a1 100755 --- a/entity/docs/models/shared/statusattribute.md +++ b/entity/docs/models/shared/statusattribute.md @@ -21,7 +21,7 @@ Status select | `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `name` | *str* | :heavy_check_mark: | N/A | | -| `options` | list[*Any*] | :heavy_minus_sign: | N/A | | +| `options` | list[[Union[str, StatusAttributeOptions2]](../../models/shared/statusattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/statusattributeoptions.md b/entity/docs/models/shared/statusattributeoptions.md new file mode 100755 index 000000000..1cb794974 --- /dev/null +++ b/entity/docs/models/shared/statusattributeoptions.md @@ -0,0 +1,17 @@ +# StatusAttributeOptions + + +## Supported Types + +### + +```python +statusAttributeOptions: str = /* values here */ +``` + +### StatusAttributeOptions2 + +```python +statusAttributeOptions: shared.StatusAttributeOptions2 = /* values here */ +``` + diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md index 1db3789a1..16c968168 100755 --- a/entity/docs/sdks/activity/README.md +++ b/entity/docs/sdks/activity/README.md @@ -1,4 +1,5 @@ # Activity +(*activity*) ## Overview diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index ac89cb5f0..6ec9a1e55 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -1,4 +1,5 @@ # Entities +(*entities*) ## Overview diff --git a/entity/docs/sdks/entityimport/README.md b/entity/docs/sdks/entityimport/README.md index c989d8ec8..c533a56ab 100755 --- a/entity/docs/sdks/entityimport/README.md +++ b/entity/docs/sdks/entityimport/README.md @@ -1,4 +1,5 @@ # EntityImport +(*entity_import*) ### Available Operations diff --git a/entity/docs/sdks/epilot/README.md b/entity/docs/sdks/epilot/README.md index 67abac3cc..2668ec4da 100755 --- a/entity/docs/sdks/epilot/README.md +++ b/entity/docs/sdks/epilot/README.md @@ -1,5 +1,6 @@ # Epilot SDK + ## Overview Entity API: Flexible data layer for epilot Entities. diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md index bae6395ff..c8e9f6c8e 100755 --- a/entity/docs/sdks/export/README.md +++ b/entity/docs/sdks/export/README.md @@ -1,4 +1,5 @@ # Export +(*export*) ## Overview diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index 2dbe2b4e0..1177d9fdd 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -1,4 +1,5 @@ # Relations +(*relations*) ## Overview diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index 25bd64422..0972cd3ca 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -1,4 +1,5 @@ # SavedViews +(*saved_views*) ## Overview @@ -30,9 +31,7 @@ s = epilot.Epilot( ) req = shared.SavedView( - created_by=shared.SavedViewCreatedBy1( - user_id='10598', - ), + created_by=[], is_favorited_by=[ '11701', ], @@ -43,7 +42,7 @@ req = shared.SavedView( 'contact', ], ui_config={ - "cumque": 'soluta', + "voluptatem": 'cumque', }, ) @@ -82,7 +81,7 @@ s = epilot.Epilot( ) req = operations.DeleteSavedViewRequest( - id='b1e31b8b-90f3-4443-a110-8e0adcf4b921', + id='bb1e31b8-b90f-4344-ba11-08e0adcf4b92', ) res = s.saved_views.delete_saved_view(req) @@ -120,7 +119,7 @@ s = epilot.Epilot( ) req = operations.GetSavedViewRequest( - id='879fce95-3f73-4ef7-bbc7-abd74dd39c0f', + id='1879fce9-53f7-43ef-bfbc-7abd74dd39c0', ) res = s.saved_views.get_saved_view(req) @@ -217,9 +216,7 @@ s = epilot.Epilot( req = operations.UpdateSavedViewRequest( saved_view=shared.SavedView( - created_by=shared.SavedViewCreatedBy1( - user_id='10598', - ), + created_by=[], is_favorited_by=[ '11701', ], @@ -230,10 +227,10 @@ req = operations.UpdateSavedViewRequest( 'contact', ], ui_config={ - "nulla": 'fugit', + "voluptatibus": 'exercitationem', }, ), - id='cff7c70a-4562-46d4-b681-3f16d9f5fce6', + id='d2cff7c7-0a45-4626-9436-813f16d9f5fc', ) res = s.saved_views.update_saved_view(req) diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index 8e5b72dbd..056863b0f 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -1,4 +1,5 @@ # Schemas +(*schemas*) ## Overview @@ -69,7 +70,7 @@ s = epilot.Epilot( ) req = operations.GetSchemaRequest( - id='c556146c-3e25-40fb-808c-42e141aac366', + id='e6c55614-6c3e-4250-bb00-8c42e141aac3', slug='contact', ) @@ -108,11 +109,11 @@ s = epilot.Epilot( ) req = operations.GetSchemaVersionsRequest( - drafts_from=7521.35, - drafts_size=5573.69, + drafts_from=4321.48, + drafts_size=4205.39, slug='contact', - versions_from=8296.03, - versions_size=8605.52, + versions_from=7521.35, + versions_size=5573.69, ) res = s.schemas.get_schema_versions(req) @@ -217,8 +218,8 @@ s = epilot.Epilot( ) req = operations.ListTaxonomyClassificationsForSchemaRequest( - query='voluptas', - size=7270.44, + query='assumenda', + size=8605.52, slug='contact', taxonomy_slug='purpose', ) @@ -261,84 +262,16 @@ s = epilot.Epilot( req = operations.PutSchemaRequest( entity_schema=shared.EntitySchema( attributes=[ - shared.DateAttribute( - purpose=[ - '44290747-4778-4a7b-9466-d28c10ab3cdc', - ], - constraints=shared.DateAttributeConstraints(), - default_value='fuga', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='eius', - hidden=False, - hide_label=False, - icon='eos', - info_helpers=shared.DateAttributeInfoHelpers( - hint_custom_component='voluptas', - hint_text='ab', - hint_text_key='cupiditate', - hint_tooltip_placement='top', - ), - label='consequatur', - layout='full_width', - name='Henrietta Hilpert', - order=0, - placeholder='quo', - preview_value_formatter='esse', - protected=False, - readonly=False, - render_condition='recusandae', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - sortable=False, - type=shared.DateAttributeType.DATE, - value_formatter='distinctio', - ), + [], ], - blueprint='c7178e47-96f2-4a70-8688-282aa482562f', + blueprint='6b144290-7474-4778-a7bd-466d28c10ab3', capabilities=[ shared.EntityCapability( purpose=[ - '222e9817-ee17-4cbe-a1e6-b7b95bc0ab3c', + 'cdca4251-904e-4523-87e0-bc7178e4796f', ], attributes=[ - shared.BooleanAttribute( - purpose=[ - '0c4f3789-fd87-41f9-9dd2-efd121aa6f1e', - ], - constraints=shared.BooleanAttributeConstraints(), - default_value='vel', - deprecated=False, - entity_builder_disable_edit=False, - feature_flag='FF_MY_FEATURE_FLAG', - group='in', - hidden=False, - hide_label=False, - icon='eius', - info_helpers=shared.BooleanAttributeInfoHelpers( - hint_custom_component='libero', - hint_text='illum', - hint_text_key='soluta', - hint_tooltip_placement='top', - ), - label='accusantium', - layout='full_width', - name='Miranda Carter', - order=0, - placeholder='ullam', - preview_value_formatter='nisi', - protected=False, - readonly=False, - render_condition='aut', - required=False, - setting_flag='MY_SETTING', - show_in_table=False, - sortable=False, - type=shared.BooleanAttributeType.BOOLEAN, - value_formatter='voluptatum', - ), + [], ], feature_flag='FF_MY_FEATURE_FLAG', legacy=False, @@ -347,49 +280,49 @@ req = operations.PutSchemaRequest( title='Messaging', ui_hooks=[ { - "qui": 'quibusdam', + "dolores": 'deserunt', }, ], ), ], dialog_config={ - "ex": 'deleniti', + "molestiae": 'accusantium', }, draft=False, enable_setting=[ '360_features', ], explicit_search_mappings={ - "itaque": shared.SearchMappings( + "porro": shared.SearchMappings( fields_={ - "dolorum": 'architecto', + "eum": 'quas', }, index=False, - type=shared.SearchMappingsType.FLOAT, + type=shared.SearchMappingsType.LONG, ), }, feature_flag='FF_MY_FEATURE_FLAG', group_settings=[ shared.EntitySchemaGroupSettings( purpose=[ - 'f1d17051-339d-4080-86a1-840394c26071', + '282aa482-562f-4222-a981-7ee17cbe61e6', ], expanded=False, feature_flag='FF_MY_FEATURE_FLAG', - id='f93f5f06-42da-4c7a-b515-cc413aa63aae', + id='b7b95bc0-ab3c-420c-8f37-89fd871f99dd', info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( - default='totam', - key='fugiat', + default='quia', + key='eveniet', ), - label='vel', - order=497678, + label='asperiores', + order=815524, render_condition='_is_composite_price = "false"', setting_flag='MY_SETTING', ), ], icon='person', layout_settings={ - "quos": 'vel', + "veritatis": 'consequuntur', }, name='Contact', plural='Contacts', @@ -397,68 +330,20 @@ req = operations.PutSchemaRequest( slug='contact', title_template='{{first_name}} {{last_name}}', ui_config=shared.EntitySchemaUIConfig( - create_view=shared.EntityDefaultCreate( - search_params={ - "possimus": 'facilis', - }, - table_menu_options=shared.EntityDefaultCreateTableMenuOptions( - icon='cum', - label='commodi', - ), - view_type=shared.EntityDefaultCreateViewType.DEFAULT, - ), - edit_view=shared.RedirectEntityView( - route='/app/pricing-hub/product/:entityId', - view_type=shared.RedirectEntityViewViewType.REDIRECT, - ), + create_view=[], + edit_view=[], list_item=shared.EntitySchemaUIConfigListItem( summary_attributes=[ - shared.SummaryAttribute( - feature_flag='reiciendis', - label='assumenda', - render_condition='nemo', - setting_flag='recusandae', - show_as_tag=False, - tag_color='aliquid', - value='aperiam', - ), + [], ], ), sharing=shared.EntitySchemaUIConfigSharing( show_sharing_button=True, ), - single_view=shared.EntityViewDisabled( - view_type=shared.EntityViewDisabledViewType.DISABLED, - ), - table_view=shared.EntityDefaultTable( - classic_view='in', - dropdown_items=[ - shared.EntityDefaultTableDropdownItems1( - entity='contact', - feature_flag='FF_MY_FEATURE_FLAG', - legacy=False, - type=shared.EntityDefaultTableDropdownItems1Type.ENTITY, - ), - ], - enable_thumbnails=False, - navbar_actions=[ - shared.EntityDefaultTableNavbarActions( - options=[ - shared.EntityDefaultTableNavbarActionsOptions( - label='earum', - params=shared.EntityDefaultTableNavbarActionsOptionsParams(), - ), - ], - type='facere', - ), - ], - row_actions=[ - 'numquam', - ], - view_type=shared.EntityDefaultTableViewType.DEFAULT, - ), + single_view=[], + table_view=[], ), - version=985492, + version=94458, ), draft=False, slug='contact', diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index 3b25d1ec6..d4370e4f8 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -1,4 +1,5 @@ # Taxonomy +(*taxonomy*) ## Overview @@ -98,10 +99,10 @@ s = epilot.Epilot( req = operations.TaxonomiesClassificationsSearchRequest( request_body=operations.TaxonomiesClassificationsSearchRequestBody( classification_ids=[ - '6fbee41f-3331-47fe-b5b6-0eb1ea426555', + 'aa6f1e67-4bdb-404f-9575-6082d68ea19f', ], ), - taxonomy_slug='nobis', + taxonomy_slug='quasi', ) res = s.taxonomy.taxonomies_classifications_search(req) @@ -139,9 +140,9 @@ s = epilot.Epilot( ) req = operations.TaxonomyAutocompleteRequest( - query='dolorum', - size=2378.07, - taxonomy_slug='minus', + query='at', + size=920.27, + taxonomy_slug='voluptate', ) res = s.taxonomy.taxonomy_autocomplete(req) @@ -183,31 +184,31 @@ req = operations.UpdateClassificationsForTaxonomyRequest( classifications_update=shared.ClassificationsUpdate( create=[ shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-07-01T01:32:29.196Z'), - id='744ed53b-88f3-4a8d-8f5c-0b2f2fb7b194', + created_at=dateutil.parser.isoparse('2022-09-03T18:06:00.164Z'), + id='1339d080-86a1-4840-b94c-26071f93f5f0', name='Wallbox PV', parents=[ - 'a276b269-16fe-41f0-8f42-94e3698f447f', + '642dac7a-f515-4cc4-93aa-63aae8d67864', ], - updated_at=dateutil.parser.isoparse('2022-12-22T16:38:34.482Z'), + updated_at=dateutil.parser.isoparse('2020-11-18T07:12:59.777Z'), ), ], delete=[ - '3e8b445e-80ca-455e-bd20-e457e1858b6a', + 'b675fd5e-60b3-475e-94f6-fbee41f33317', ], update=[ shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2021-10-03T15:49:29.329Z'), - id='fbe3a5aa-8e48-424d-8ab4-075088e51862', + created_at=dateutil.parser.isoparse('2020-04-29T18:47:01.945Z'), + id='35b60eb1-ea42-4655-9ba3-c28744ed53b8', name='Wallbox PV', parents=[ - '065e904f-3b11-494b-8abf-603a79f9dfe0', + '8f3a8d8f-5c0b-42f2-bb7b-194a276b2691', ], - updated_at=dateutil.parser.isoparse('2021-08-10T13:37:39.961Z'), + updated_at=dateutil.parser.isoparse('2022-01-15T12:09:02.064Z'), ), ], ), - taxonomy_slug='reprehenderit', + taxonomy_slug='debitis', ) res = s.taxonomy.update_classifications_for_taxonomy(req) diff --git a/entity/files.gen b/entity/files.gen index 5766e7cc7..a4765dd2a 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -120,6 +120,7 @@ docs/models/operations/getentityactivityfeedrequest.md docs/models/operations/getentityactivityfeed200applicationjson.md docs/models/operations/getentityactivityfeedresponse.md docs/models/operations/autocompleterequest.md +docs/models/operations/autocomplete200applicationjsonresults.md docs/models/operations/autocomplete200applicationjson.md docs/models/operations/autocompleteresponse.md docs/models/operations/createentityrequest.md @@ -209,22 +210,31 @@ docs/models/shared/entitysearchparams.md docs/models/shared/entityimportparamss3reference.md docs/models/shared/entityimportparams.md docs/models/shared/relationitem.md +docs/models/shared/getrelationsresp.md docs/models/shared/getrelationsrespwithpagination.md docs/models/shared/savedviewitemcreatedby1.md +docs/models/shared/savedviewitemcreatedby.md docs/models/shared/savedviewitem.md docs/models/shared/savedviewcreatedby1.md +docs/models/shared/savedviewcreatedby.md docs/models/shared/savedview.md docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md docs/models/shared/entityschemaitemgroupsettings.md docs/models/shared/entityschemaitemsource.md +docs/models/shared/entityschemaitemuiconfigcreateview.md +docs/models/shared/entityschemaitemuiconfigeditview.md +docs/models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md docs/models/shared/entityschemaitemuiconfiglistitem.md docs/models/shared/entityschemaitemuiconfigsharing.md +docs/models/shared/entityschemaitemuiconfigsingleview.md +docs/models/shared/entityschemaitemuiconfigtableview.md docs/models/shared/entityschemaitemuiconfig.md docs/models/shared/entityschemaitem.md docs/models/shared/entitydefaulttabledropdownitems2type.md docs/models/shared/entitydefaulttabledropdownitems2.md docs/models/shared/entitydefaulttabledropdownitems1type.md docs/models/shared/entitydefaulttabledropdownitems1.md +docs/models/shared/entitydefaulttabledropdownitems.md docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md docs/models/shared/entitydefaulttablenavbaractionsoptions.md docs/models/shared/entitydefaulttablenavbaractions.md @@ -244,6 +254,7 @@ docs/models/shared/entitydefaultcreate.md docs/models/shared/searchmappingstype.md docs/models/shared/searchmappings.md docs/models/shared/entitycapability.md +docs/models/shared/attribute.md docs/models/shared/textattributeconstraints.md docs/models/shared/textattributeinfohelpers.md docs/models/shared/textattributetype.md @@ -267,16 +278,19 @@ docs/models/shared/booleanattribute.md docs/models/shared/selectattributeconstraints.md docs/models/shared/selectattributeinfohelpers.md docs/models/shared/selectattributeoptions1.md +docs/models/shared/selectattributeoptions.md docs/models/shared/selectattributetype.md docs/models/shared/selectattribute.md docs/models/shared/multiselectattributeconstraints.md docs/models/shared/multiselectattributeinfohelpers.md docs/models/shared/multiselectattributeoptions2.md +docs/models/shared/multiselectattributeoptions.md docs/models/shared/multiselectattributetype.md docs/models/shared/multiselectattribute.md docs/models/shared/statusattributeconstraints.md docs/models/shared/statusattributeinfohelpers.md docs/models/shared/statusattributeoptions2.md +docs/models/shared/statusattributeoptions.md docs/models/shared/statusattributetype.md docs/models/shared/statusattribute.md docs/models/shared/sequenceattributeconstraints.md @@ -291,6 +305,7 @@ docs/models/shared/relationattributeeditmode.md docs/models/shared/relationattributeinfohelpers.md docs/models/shared/relationattributerelationaffinitymode.md docs/models/shared/relationattributerelationtype.md +docs/models/shared/relationattributesummaryfields.md docs/models/shared/relationattributetype.md docs/models/shared/relationattribute.md docs/models/shared/summaryfield.md @@ -372,8 +387,13 @@ docs/models/shared/partnerorganisationattribute.md docs/models/shared/taxonomyclassification.md docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md docs/models/shared/entityschemagroupsettings.md +docs/models/shared/entityschemauiconfigcreateview.md +docs/models/shared/entityschemauiconfigeditview.md +docs/models/shared/entityschemauiconfiglistitemsummaryattributes.md docs/models/shared/entityschemauiconfiglistitem.md docs/models/shared/entityschemauiconfigsharing.md +docs/models/shared/entityschemauiconfigsingleview.md +docs/models/shared/entityschemauiconfigtableview.md docs/models/shared/entityschemauiconfig.md docs/models/shared/entityschema.md docs/models/shared/taxonomy.md diff --git a/entity/gen.yaml b/entity/gen.yaml index f7ef97cb5..c9e69902f 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: 285059cd6a6b4ebb4b50059166100555 docVersion: 1.0.0 - speakeasyVersion: 1.91.0 - generationVersion: 2.129.1 + speakeasyVersion: 1.91.2 + generationVersion: 2.131.1 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.86.0 + core: 2.86.1 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.24.0 + version: 1.24.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 09d77bbc5..8ba234d33 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.24.0", + version="1.24.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, @@ -19,7 +19,7 @@ install_requires=[ "certifi>=2022.12.7", "charset-normalizer>=2.1.1", - "dataclasses-json>=0.5.12", + "dataclasses-json>=0.6.1", "idna>=3.3", "jsonpath-python>=1.0.6 ", "marshmallow>=3.17.1", diff --git a/entity/src/epilot/models/operations/__init__.py b/entity/src/epilot/models/operations/__init__.py index a33e3caa3..78f8b3e41 100755 --- a/entity/src/epilot/models/operations/__init__.py +++ b/entity/src/epilot/models/operations/__init__.py @@ -38,4 +38,4 @@ from .updatesavedview import * from .upsertentity import * -__all__ = ["AddRelationsRequest","AddRelationsResponse","AttachActivityRequest","AttachActivityResponse","Autocomplete200ApplicationJSON","AutocompleteRequest","AutocompleteResponse","CreateActivityRequest","CreateActivityResponse","CreateEntityRequest","CreateEntityResponse","CreateSavedViewResponse","DeleteEntityRequest","DeleteEntityResponse","DeleteRelationRequest","DeleteRelationResponse","DeleteSavedViewRequest","DeleteSavedViewResponse","DeleteSchemaRequest","DeleteSchemaResponse","ExportEntitiesRequest","ExportEntitiesResponse","GetActivityRequest","GetActivityResponse","GetEntity200ApplicationJSON","GetEntityActivityFeed200ApplicationJSON","GetEntityActivityFeedRequest","GetEntityActivityFeedResponse","GetEntityRequest","GetEntityResponse","GetRelationsRequest","GetRelationsResponse","GetRelationsV2Request","GetRelationsV2Response","GetSavedView200ApplicationJSON","GetSavedViewRequest","GetSavedViewResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaVersions200ApplicationJSON","GetSchemaVersionsRequest","GetSchemaVersionsResponse","GetTaxonomyRequest","GetTaxonomyResponse","ImportEntitiesRequest","ImportEntitiesResponse","ListFavoriteViewsForUser200ApplicationJSON","ListFavoriteViewsForUserResponse","ListSavedViews200ApplicationJSON","ListSavedViewsResponse","ListSchemaBlueprints200ApplicationJSON","ListSchemaBlueprintsResponse","ListSchemas200ApplicationJSON","ListSchemasRequest","ListSchemasResponse","ListTaxonomies200ApplicationJSON","ListTaxonomiesResponse","ListTaxonomyClassificationsForSchema200ApplicationJSON","ListTaxonomyClassificationsForSchemaRequest","ListTaxonomyClassificationsForSchemaResponse","PatchEntityRequest","PatchEntityResponse","PutSchemaRequest","PutSchemaResponse","SearchEntitiesResponse","TaxonomiesClassificationsSearch200ApplicationJSON","TaxonomiesClassificationsSearchRequest","TaxonomiesClassificationsSearchRequestBody","TaxonomiesClassificationsSearchResponse","TaxonomyAutocomplete200ApplicationJSON","TaxonomyAutocompleteRequest","TaxonomyAutocompleteResponse","UpdateClassificationsForTaxonomy200ApplicationJSON","UpdateClassificationsForTaxonomy200ApplicationJSONDeleted","UpdateClassificationsForTaxonomyRequest","UpdateClassificationsForTaxonomyResponse","UpdateEntityRequest","UpdateEntityResponse","UpdateRelationRequest","UpdateRelationRequestBody","UpdateRelationResponse","UpdateSavedViewRequest","UpdateSavedViewResponse","UpsertEntityRequest","UpsertEntityRequestBody","UpsertEntityResponse"] +__all__ = ["AddRelationsRequest","AddRelationsResponse","AttachActivityRequest","AttachActivityResponse","Autocomplete200ApplicationJSON","Autocomplete200ApplicationJSONResults","AutocompleteRequest","AutocompleteResponse","CreateActivityRequest","CreateActivityResponse","CreateEntityRequest","CreateEntityResponse","CreateSavedViewResponse","DeleteEntityRequest","DeleteEntityResponse","DeleteRelationRequest","DeleteRelationResponse","DeleteSavedViewRequest","DeleteSavedViewResponse","DeleteSchemaRequest","DeleteSchemaResponse","ExportEntitiesRequest","ExportEntitiesResponse","GetActivityRequest","GetActivityResponse","GetEntity200ApplicationJSON","GetEntityActivityFeed200ApplicationJSON","GetEntityActivityFeedRequest","GetEntityActivityFeedResponse","GetEntityRequest","GetEntityResponse","GetRelationsRequest","GetRelationsResponse","GetRelationsV2Request","GetRelationsV2Response","GetSavedView200ApplicationJSON","GetSavedViewRequest","GetSavedViewResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaVersions200ApplicationJSON","GetSchemaVersionsRequest","GetSchemaVersionsResponse","GetTaxonomyRequest","GetTaxonomyResponse","ImportEntitiesRequest","ImportEntitiesResponse","ListFavoriteViewsForUser200ApplicationJSON","ListFavoriteViewsForUserResponse","ListSavedViews200ApplicationJSON","ListSavedViewsResponse","ListSchemaBlueprints200ApplicationJSON","ListSchemaBlueprintsResponse","ListSchemas200ApplicationJSON","ListSchemasRequest","ListSchemasResponse","ListTaxonomies200ApplicationJSON","ListTaxonomiesResponse","ListTaxonomyClassificationsForSchema200ApplicationJSON","ListTaxonomyClassificationsForSchemaRequest","ListTaxonomyClassificationsForSchemaResponse","PatchEntityRequest","PatchEntityResponse","PutSchemaRequest","PutSchemaResponse","SearchEntitiesResponse","TaxonomiesClassificationsSearch200ApplicationJSON","TaxonomiesClassificationsSearchRequest","TaxonomiesClassificationsSearchRequestBody","TaxonomiesClassificationsSearchResponse","TaxonomyAutocomplete200ApplicationJSON","TaxonomyAutocompleteRequest","TaxonomyAutocompleteResponse","UpdateClassificationsForTaxonomy200ApplicationJSON","UpdateClassificationsForTaxonomy200ApplicationJSONDeleted","UpdateClassificationsForTaxonomyRequest","UpdateClassificationsForTaxonomyResponse","UpdateEntityRequest","UpdateEntityResponse","UpdateRelationRequest","UpdateRelationRequestBody","UpdateRelationResponse","UpdateSavedViewRequest","UpdateSavedViewResponse","UpsertEntityRequest","UpsertEntityRequestBody","UpsertEntityResponse"] diff --git a/entity/src/epilot/models/operations/autocomplete.py b/entity/src/epilot/models/operations/autocomplete.py index 768997187..43692f560 100755 --- a/entity/src/epilot/models/operations/autocomplete.py +++ b/entity/src/epilot/models/operations/autocomplete.py @@ -5,7 +5,7 @@ import requests as requests_http from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union @@ -23,13 +23,19 @@ class AutocompleteRequest: + +@dataclasses.dataclass +class Autocomplete200ApplicationJSONResults: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class Autocomplete200ApplicationJSON: r"""Success""" hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) - results: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[list[Union[str, bool, dict[str, Any]]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py index 9e231e06c..3c62fa20c 100755 --- a/entity/src/epilot/models/operations/getrelations.py +++ b/entity/src/epilot/models/operations/getrelations.py @@ -3,7 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from typing import Any, Optional +from ..shared import relationitem as shared_relationitem +from typing import Any, Optional, Union @@ -28,7 +29,7 @@ class GetRelationsResponse: r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - get_relations_resp: Optional[list[Any]] = dataclasses.field(default=None) + get_relations_resp: Optional[list[Union[shared_relationitem.RelationItem, dict[str, Any]]]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index 505886ccb..a686402ca 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -54,4 +54,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigSharing","EntitySchemaUIConfig","EntitySchemaUIConfigListItem","EntitySchemaUIConfigSharing","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] +__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] diff --git a/entity/src/epilot/models/shared/entitycapability.py b/entity/src/epilot/models/shared/entitycapability.py index 65e2d15d6..82e55ca8d 100755 --- a/entity/src/epilot/models/shared/entitycapability.py +++ b/entity/src/epilot/models/shared/entitycapability.py @@ -2,9 +2,37 @@ from __future__ import annotations import dataclasses +from ..shared import addressrelationattribute as shared_addressrelationattribute +from ..shared import automationattribute as shared_automationattribute +from ..shared import booleanattribute as shared_booleanattribute +from ..shared import computedattribute as shared_computedattribute +from ..shared import consentattribute as shared_consentattribute +from ..shared import countryattribute as shared_countryattribute +from ..shared import currencyattribute as shared_currencyattribute +from ..shared import dateattribute as shared_dateattribute +from ..shared import fileattribute as shared_fileattribute +from ..shared import internalattribute as shared_internalattribute +from ..shared import internaluserattribute as shared_internaluserattribute +from ..shared import invitationemailattribute as shared_invitationemailattribute +from ..shared import linkattribute as shared_linkattribute +from ..shared import multiselectattribute as shared_multiselectattribute +from ..shared import numberattribute as shared_numberattribute +from ..shared import orderedlistattribute as shared_orderedlistattribute +from ..shared import partnerorganisationattribute as shared_partnerorganisationattribute +from ..shared import partnerstatusattribute as shared_partnerstatusattribute +from ..shared import paymentmethodrelationattribute as shared_paymentmethodrelationattribute +from ..shared import purposeattribute as shared_purposeattribute +from ..shared import relationattribute as shared_relationattribute +from ..shared import repeatableattribute as shared_repeatableattribute +from ..shared import selectattribute as shared_selectattribute +from ..shared import sequenceattribute as shared_sequenceattribute +from ..shared import statusattribute as shared_statusattribute +from ..shared import tagsattribute as shared_tagsattribute +from ..shared import textattribute as shared_textattribute +from ..shared import userrelationattribute as shared_userrelationattribute from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) @@ -15,7 +43,7 @@ class EntityCapability: name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Unique name for the capability""" purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes'), 'exclude': lambda f: f is None }}) + attributes: Optional[list[Union[shared_textattribute.TextAttribute, shared_linkattribute.LinkAttribute, shared_dateattribute.DateAttribute, shared_countryattribute.CountryAttribute, shared_booleanattribute.BooleanAttribute, shared_selectattribute.SelectAttribute, shared_multiselectattribute.MultiSelectAttribute, shared_statusattribute.StatusAttribute, shared_sequenceattribute.SequenceAttribute, shared_relationattribute.RelationAttribute, shared_userrelationattribute.UserRelationAttribute, shared_addressrelationattribute.AddressRelationAttribute, shared_paymentmethodrelationattribute.PaymentMethodRelationAttribute, shared_currencyattribute.CurrencyAttribute, shared_repeatableattribute.RepeatableAttribute, shared_tagsattribute.TagsAttribute, shared_numberattribute.NumberAttribute, shared_consentattribute.ConsentAttribute, shared_internalattribute.InternalAttribute, shared_orderedlistattribute.OrderedListAttribute, shared_fileattribute.FileAttribute, shared_computedattribute.ComputedAttribute, shared_partnerstatusattribute.PartnerStatusAttribute, shared_invitationemailattribute.InvitationEmailAttribute, shared_automationattribute.AutomationAttribute, shared_internaluserattribute.InternalUserAttribute, shared_purposeattribute.PurposeAttribute, shared_partnerorganisationattribute.PartnerOrganisationAttribute]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes'), 'exclude': lambda f: f is None }}) feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This capability should only be active when the feature flag is enabled""" legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py index e1ef9434b..a53db2f75 100755 --- a/entity/src/epilot/models/shared/entitydefaulttable.py +++ b/entity/src/epilot/models/shared/entitydefaulttable.py @@ -5,7 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Optional, Union class EntityDefaultTableDropdownItems2Type(str, Enum): LINK = 'link' @@ -45,6 +45,12 @@ class EntityDefaultTableDropdownItems1: +@dataclasses.dataclass +class EntityDefaultTableDropdownItems: + pass + + + @dataclasses.dataclass class EntityDefaultTableNavbarActionsOptionsParams: pass @@ -78,7 +84,7 @@ class EntityDefaultTableViewType(str, Enum): @dataclasses.dataclass class EntityDefaultTable: classic_view: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classic_view'), 'exclude': lambda f: f is None }}) - dropdown_items: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dropdown_items'), 'exclude': lambda f: f is None }}) + dropdown_items: Optional[list[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dropdown_items'), 'exclude': lambda f: f is None }}) enable_thumbnails: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_thumbnails'), 'exclude': lambda f: f is None }}) r"""Enable the thumbnail column""" navbar_actions: Optional[list[EntityDefaultTableNavbarActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('navbar_actions'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entityschema.py b/entity/src/epilot/models/shared/entityschema.py index bd1aa5794..b36416b90 100755 --- a/entity/src/epilot/models/shared/entityschema.py +++ b/entity/src/epilot/models/shared/entityschema.py @@ -2,11 +2,45 @@ from __future__ import annotations import dataclasses +from ..shared import addressrelationattribute as shared_addressrelationattribute +from ..shared import automationattribute as shared_automationattribute +from ..shared import booleanattribute as shared_booleanattribute +from ..shared import computedattribute as shared_computedattribute +from ..shared import consentattribute as shared_consentattribute +from ..shared import countryattribute as shared_countryattribute +from ..shared import currencyattribute as shared_currencyattribute +from ..shared import dateattribute as shared_dateattribute from ..shared import entitycapability as shared_entitycapability +from ..shared import entitydefaultcreate as shared_entitydefaultcreate +from ..shared import entitydefaultedit as shared_entitydefaultedit +from ..shared import entitydefaulttable as shared_entitydefaulttable +from ..shared import entityviewdisabled as shared_entityviewdisabled +from ..shared import fileattribute as shared_fileattribute +from ..shared import internalattribute as shared_internalattribute +from ..shared import internaluserattribute as shared_internaluserattribute +from ..shared import invitationemailattribute as shared_invitationemailattribute +from ..shared import linkattribute as shared_linkattribute +from ..shared import multiselectattribute as shared_multiselectattribute +from ..shared import numberattribute as shared_numberattribute +from ..shared import orderedlistattribute as shared_orderedlistattribute +from ..shared import partnerorganisationattribute as shared_partnerorganisationattribute +from ..shared import partnerstatusattribute as shared_partnerstatusattribute +from ..shared import paymentmethodrelationattribute as shared_paymentmethodrelationattribute +from ..shared import purposeattribute as shared_purposeattribute +from ..shared import redirectentityview as shared_redirectentityview +from ..shared import relationattribute as shared_relationattribute +from ..shared import repeatableattribute as shared_repeatableattribute from ..shared import searchmappings as shared_searchmappings +from ..shared import selectattribute as shared_selectattribute +from ..shared import sequenceattribute as shared_sequenceattribute +from ..shared import statusattribute as shared_statusattribute +from ..shared import summaryattribute as shared_summaryattribute +from ..shared import tagsattribute as shared_tagsattribute +from ..shared import textattribute as shared_textattribute +from ..shared import userrelationattribute as shared_userrelationattribute from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) @@ -39,11 +73,29 @@ class EntitySchemaGroupSettings: + +@dataclasses.dataclass +class EntitySchemaUIConfigCreateView: + pass + + + +@dataclasses.dataclass +class EntitySchemaUIConfigEditView: + pass + + + +@dataclasses.dataclass +class EntitySchemaUIConfigListItemSummaryAttributes: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaUIConfigListItem: - summary_attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) + summary_attributes: Optional[list[Union[shared_summaryattribute.SummaryAttribute, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) @@ -58,16 +110,28 @@ class EntitySchemaUIConfigSharing: + +@dataclasses.dataclass +class EntitySchemaUIConfigSingleView: + pass + + + +@dataclasses.dataclass +class EntitySchemaUIConfigTableView: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaUIConfig: - create_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) - edit_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_view'), 'exclude': lambda f: f is None }}) + create_view: Optional[Union[shared_entitydefaultcreate.EntityDefaultCreate, shared_redirectentityview.RedirectEntityView, shared_entityviewdisabled.EntityViewDisabled]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) + edit_view: Optional[Union[shared_entitydefaultedit.EntityDefaultEdit, shared_redirectentityview.RedirectEntityView, shared_entityviewdisabled.EntityViewDisabled]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_view'), 'exclude': lambda f: f is None }}) list_item: Optional[EntitySchemaUIConfigListItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('list_item'), 'exclude': lambda f: f is None }}) sharing: Optional[EntitySchemaUIConfigSharing] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sharing'), 'exclude': lambda f: f is None }}) - single_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('single_view'), 'exclude': lambda f: f is None }}) - table_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_view'), 'exclude': lambda f: f is None }}) + single_view: Optional[Union[shared_entitydefaultedit.EntityDefaultEdit, shared_redirectentityview.RedirectEntityView, shared_entityviewdisabled.EntityViewDisabled]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('single_view'), 'exclude': lambda f: f is None }}) + table_view: Optional[Union[shared_entitydefaulttable.EntityDefaultTable, shared_redirectentityview.RedirectEntityView, shared_entityviewdisabled.EntityViewDisabled]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_view'), 'exclude': lambda f: f is None }}) @@ -77,7 +141,7 @@ class EntitySchemaUIConfig: @dataclasses.dataclass class EntitySchema: r"""The \\"type\\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.""" - attributes: list[Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) + attributes: list[Union[shared_textattribute.TextAttribute, shared_linkattribute.LinkAttribute, shared_dateattribute.DateAttribute, shared_countryattribute.CountryAttribute, shared_booleanattribute.BooleanAttribute, shared_selectattribute.SelectAttribute, shared_multiselectattribute.MultiSelectAttribute, shared_statusattribute.StatusAttribute, shared_sequenceattribute.SequenceAttribute, shared_relationattribute.RelationAttribute, shared_userrelationattribute.UserRelationAttribute, shared_addressrelationattribute.AddressRelationAttribute, shared_paymentmethodrelationattribute.PaymentMethodRelationAttribute, shared_currencyattribute.CurrencyAttribute, shared_repeatableattribute.RepeatableAttribute, shared_tagsattribute.TagsAttribute, shared_numberattribute.NumberAttribute, shared_consentattribute.ConsentAttribute, shared_internalattribute.InternalAttribute, shared_orderedlistattribute.OrderedListAttribute, shared_fileattribute.FileAttribute, shared_computedattribute.ComputedAttribute, shared_partnerstatusattribute.PartnerStatusAttribute, shared_invitationemailattribute.InvitationEmailAttribute, shared_automationattribute.AutomationAttribute, shared_internaluserattribute.InternalUserAttribute, shared_purposeattribute.PurposeAttribute, shared_partnerorganisationattribute.PartnerOrganisationAttribute]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) r"""An ordered list of attributes the entity contains""" capabilities: list[shared_entitycapability.EntityCapability] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) diff --git a/entity/src/epilot/models/shared/entityschemaitem.py b/entity/src/epilot/models/shared/entityschemaitem.py index 82f3c5df1..419dc98e7 100755 --- a/entity/src/epilot/models/shared/entityschemaitem.py +++ b/entity/src/epilot/models/shared/entityschemaitem.py @@ -2,11 +2,45 @@ from __future__ import annotations import dataclasses +from ..shared import addressrelationattribute as shared_addressrelationattribute +from ..shared import automationattribute as shared_automationattribute +from ..shared import booleanattribute as shared_booleanattribute +from ..shared import computedattribute as shared_computedattribute +from ..shared import consentattribute as shared_consentattribute +from ..shared import countryattribute as shared_countryattribute +from ..shared import currencyattribute as shared_currencyattribute +from ..shared import dateattribute as shared_dateattribute from ..shared import entitycapability as shared_entitycapability +from ..shared import entitydefaultcreate as shared_entitydefaultcreate +from ..shared import entitydefaultedit as shared_entitydefaultedit +from ..shared import entitydefaulttable as shared_entitydefaulttable +from ..shared import entityviewdisabled as shared_entityviewdisabled +from ..shared import fileattribute as shared_fileattribute +from ..shared import internalattribute as shared_internalattribute +from ..shared import internaluserattribute as shared_internaluserattribute +from ..shared import invitationemailattribute as shared_invitationemailattribute +from ..shared import linkattribute as shared_linkattribute +from ..shared import multiselectattribute as shared_multiselectattribute +from ..shared import numberattribute as shared_numberattribute +from ..shared import orderedlistattribute as shared_orderedlistattribute +from ..shared import partnerorganisationattribute as shared_partnerorganisationattribute +from ..shared import partnerstatusattribute as shared_partnerstatusattribute +from ..shared import paymentmethodrelationattribute as shared_paymentmethodrelationattribute +from ..shared import purposeattribute as shared_purposeattribute +from ..shared import redirectentityview as shared_redirectentityview +from ..shared import relationattribute as shared_relationattribute +from ..shared import repeatableattribute as shared_repeatableattribute from ..shared import searchmappings as shared_searchmappings +from ..shared import selectattribute as shared_selectattribute +from ..shared import sequenceattribute as shared_sequenceattribute +from ..shared import statusattribute as shared_statusattribute +from ..shared import summaryattribute as shared_summaryattribute +from ..shared import tagsattribute as shared_tagsattribute +from ..shared import textattribute as shared_textattribute +from ..shared import userrelationattribute as shared_userrelationattribute from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) @@ -49,11 +83,29 @@ class EntitySchemaItemSource: + +@dataclasses.dataclass +class EntitySchemaItemUIConfigCreateView: + pass + + + +@dataclasses.dataclass +class EntitySchemaItemUIConfigEditView: + pass + + + +@dataclasses.dataclass +class EntitySchemaItemUIConfigListItemSummaryAttributes: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaItemUIConfigListItem: - summary_attributes: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) + summary_attributes: Optional[list[Union[shared_summaryattribute.SummaryAttribute, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) @@ -68,16 +120,28 @@ class EntitySchemaItemUIConfigSharing: + +@dataclasses.dataclass +class EntitySchemaItemUIConfigSingleView: + pass + + + +@dataclasses.dataclass +class EntitySchemaItemUIConfigTableView: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaItemUIConfig: - create_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) - edit_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_view'), 'exclude': lambda f: f is None }}) + create_view: Optional[Union[shared_entitydefaultcreate.EntityDefaultCreate, shared_redirectentityview.RedirectEntityView, shared_entityviewdisabled.EntityViewDisabled]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) + edit_view: Optional[Union[shared_entitydefaultedit.EntityDefaultEdit, shared_redirectentityview.RedirectEntityView, shared_entityviewdisabled.EntityViewDisabled]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_view'), 'exclude': lambda f: f is None }}) list_item: Optional[EntitySchemaItemUIConfigListItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('list_item'), 'exclude': lambda f: f is None }}) sharing: Optional[EntitySchemaItemUIConfigSharing] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sharing'), 'exclude': lambda f: f is None }}) - single_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('single_view'), 'exclude': lambda f: f is None }}) - table_view: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_view'), 'exclude': lambda f: f is None }}) + single_view: Optional[Union[shared_entitydefaultedit.EntityDefaultEdit, shared_redirectentityview.RedirectEntityView, shared_entityviewdisabled.EntityViewDisabled]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('single_view'), 'exclude': lambda f: f is None }}) + table_view: Optional[Union[shared_entitydefaulttable.EntityDefaultTable, shared_redirectentityview.RedirectEntityView, shared_entityviewdisabled.EntityViewDisabled]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_view'), 'exclude': lambda f: f is None }}) @@ -87,7 +151,7 @@ class EntitySchemaItemUIConfig: @dataclasses.dataclass class EntitySchemaItem: r"""The \\"type\\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.""" - attributes: list[Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) + attributes: list[Union[shared_textattribute.TextAttribute, shared_linkattribute.LinkAttribute, shared_dateattribute.DateAttribute, shared_countryattribute.CountryAttribute, shared_booleanattribute.BooleanAttribute, shared_selectattribute.SelectAttribute, shared_multiselectattribute.MultiSelectAttribute, shared_statusattribute.StatusAttribute, shared_sequenceattribute.SequenceAttribute, shared_relationattribute.RelationAttribute, shared_userrelationattribute.UserRelationAttribute, shared_addressrelationattribute.AddressRelationAttribute, shared_paymentmethodrelationattribute.PaymentMethodRelationAttribute, shared_currencyattribute.CurrencyAttribute, shared_repeatableattribute.RepeatableAttribute, shared_tagsattribute.TagsAttribute, shared_numberattribute.NumberAttribute, shared_consentattribute.ConsentAttribute, shared_internalattribute.InternalAttribute, shared_orderedlistattribute.OrderedListAttribute, shared_fileattribute.FileAttribute, shared_computedattribute.ComputedAttribute, shared_partnerstatusattribute.PartnerStatusAttribute, shared_invitationemailattribute.InvitationEmailAttribute, shared_automationattribute.AutomationAttribute, shared_internaluserattribute.InternalUserAttribute, shared_purposeattribute.PurposeAttribute, shared_partnerorganisationattribute.PartnerOrganisationAttribute]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) r"""An ordered list of attributes the entity contains""" capabilities: list[shared_entitycapability.EntityCapability] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) diff --git a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py index 5c28fe277..e0f082009 100755 --- a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py +++ b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py @@ -2,9 +2,10 @@ from __future__ import annotations import dataclasses +from ..shared import relationitem as shared_relationitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) @@ -12,6 +13,6 @@ @dataclasses.dataclass class GetRelationsRespWithPagination: hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) - relations: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) + relations: Optional[list[Union[shared_relationitem.RelationItem, dict[str, Any]]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/multiselectattribute.py b/entity/src/epilot/models/shared/multiselectattribute.py index 00a63ee9f..6041610a9 100755 --- a/entity/src/epilot/models/shared/multiselectattribute.py +++ b/entity/src/epilot/models/shared/multiselectattribute.py @@ -5,7 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union @@ -53,6 +53,12 @@ class MultiSelectAttributeOptions2: + + +@dataclasses.dataclass +class MultiSelectAttributeOptions: + pass + class MultiSelectAttributeType(str, Enum): MULTISELECT = 'multiselect' CHECKBOX = 'checkbox' @@ -95,7 +101,7 @@ class MultiSelectAttribute: info_helpers: Optional[MultiSelectAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) r"""A set of configurations meant to document and assist the user in filling the attribute.""" layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + options: Optional[list[Union[str, MultiSelectAttributeOptions2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py index eb4ca7ee2..ae7ea28ca 100755 --- a/entity/src/epilot/models/shared/relationattribute.py +++ b/entity/src/epilot/models/shared/relationattribute.py @@ -2,10 +2,11 @@ from __future__ import annotations import dataclasses +from ..shared import summaryfield as shared_summaryfield from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union class RelationAttributeActionsActionType(str, Enum): r"""The action type. Currently supported actions: @@ -99,6 +100,12 @@ class RelationAttributeRelationType(str, Enum): HAS_MANY = 'has_many' HAS_ONE = 'has_one' + + +@dataclasses.dataclass +class RelationAttributeSummaryFields: + pass + class RelationAttributeType(str, Enum): RELATION = 'relation' @@ -170,7 +177,7 @@ class RelationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - summary_fields: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_fields'), 'exclude': lambda f: f is None }}) + summary_fields: Optional[list[Union[str, shared_summaryfield.SummaryField]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_fields'), 'exclude': lambda f: f is None }}) type: Optional[RelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/savedview.py b/entity/src/epilot/models/shared/savedview.py index b1bbb0c84..5d7971195 100755 --- a/entity/src/epilot/models/shared/savedview.py +++ b/entity/src/epilot/models/shared/savedview.py @@ -4,7 +4,7 @@ import dataclasses from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) @@ -17,12 +17,18 @@ class SavedViewCreatedBy1: + +@dataclasses.dataclass +class SavedViewCreatedBy: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SavedView: r"""A saved entity view""" - created_by: Any = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) + created_by: Union[SavedViewCreatedBy1, dict[str, Any]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""User-friendly identifier for the saved view""" slug: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) diff --git a/entity/src/epilot/models/shared/savedviewitem.py b/entity/src/epilot/models/shared/savedviewitem.py index 416c60f18..07d9ec7b3 100755 --- a/entity/src/epilot/models/shared/savedviewitem.py +++ b/entity/src/epilot/models/shared/savedviewitem.py @@ -4,7 +4,7 @@ import dataclasses from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) @@ -17,12 +17,18 @@ class SavedViewItemCreatedBy1: + +@dataclasses.dataclass +class SavedViewItemCreatedBy: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SavedViewItem: r"""A saved entity view""" - created_by: Any = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) + created_by: Union[SavedViewItemCreatedBy1, dict[str, Any]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""User-friendly identifier for the saved view""" slug: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) diff --git a/entity/src/epilot/models/shared/selectattribute.py b/entity/src/epilot/models/shared/selectattribute.py index 413f0aa4f..d0b4c0e77 100755 --- a/entity/src/epilot/models/shared/selectattribute.py +++ b/entity/src/epilot/models/shared/selectattribute.py @@ -5,7 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union @@ -53,6 +53,12 @@ class SelectAttributeOptions1: + + +@dataclasses.dataclass +class SelectAttributeOptions: + pass + class SelectAttributeType(str, Enum): SELECT = 'select' RADIO = 'radio' @@ -91,7 +97,7 @@ class SelectAttribute: info_helpers: Optional[SelectAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) r"""A set of configurations meant to document and assist the user in filling the attribute.""" layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + options: Optional[list[Union[SelectAttributeOptions1, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py index 000270c3a..c10017f84 100755 --- a/entity/src/epilot/models/shared/statusattribute.py +++ b/entity/src/epilot/models/shared/statusattribute.py @@ -5,7 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Optional, Union @@ -55,6 +55,12 @@ class StatusAttributeOptions2: + + +@dataclasses.dataclass +class StatusAttributeOptions: + pass + class StatusAttributeType(str, Enum): STATUS = 'status' @@ -90,7 +96,7 @@ class StatusAttribute: info_helpers: Optional[StatusAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) r"""A set of configurations meant to document and assist the user in filling the attribute.""" layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + options: Optional[list[Union[str, StatusAttributeOptions2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py index 7f7ae4aa9..001a57e33 100755 --- a/entity/src/epilot/relations.py +++ b/entity/src/epilot/relations.py @@ -3,7 +3,7 @@ from .sdkconfiguration import SDKConfiguration from epilot import utils from epilot.models import errors, operations, shared -from typing import Any, Optional +from typing import Any, Optional, Union class Relations: r"""Entity Relationships""" @@ -93,7 +93,7 @@ def get_relations(self, request: operations.GetRelationsRequest) -> operations.G if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[list[Any]]) + out = utils.unmarshal_json(http_res.text, Optional[list[Union[shared.RelationItem, dict[str, Any]]]]) res.get_relations_resp = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 22f69897c..7ced66fe0 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,8 +19,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.24.0' - gen_version: str = '2.129.1' + sdk_version: str = '1.24.1' + gen_version: str = '2.131.1' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: diff --git a/entity/src/epilot/utils/utils.py b/entity/src/epilot/utils/utils.py index 05eafba6c..b0aeb54de 100755 --- a/entity/src/epilot/utils/utils.py +++ b/entity/src/epilot/utils/utils.py @@ -1,5 +1,6 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" +import sys import base64 import json import re @@ -796,3 +797,10 @@ def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: d value = global_value return value + + +def decoder_with_discriminator(field_name): + def decode_fx(obj): + kls = getattr(sys.modules['sdk.models.shared'], obj[field_name]) + return unmarshal_json(json.dumps(obj), kls) + return decode_fx From d98b0139d161ca4005286a39b27a631814b18bb7 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 29 Sep 2023 01:14:04 +0000 Subject: [PATCH 42/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.3 --- entity/README.md | 2 +- entity/RELEASES.md | 10 ++- entity/USAGE.md | 2 +- .../models/operations/addrelationsrequest.md | 6 +- .../models/operations/addrelationsresponse.md | 6 +- .../operations/attachactivityrequest.md | 2 +- .../operations/attachactivityresponse.md | 6 +- .../autocomplete200applicationjson.md | 8 +- .../models/operations/autocompleterequest.md | 2 +- .../models/operations/autocompleteresponse.md | 12 +-- .../operations/createactivityrequest.md | 2 +- .../operations/createactivityresponse.md | 6 +- .../models/operations/createentityrequest.md | 2 +- .../models/operations/createentityresponse.md | 4 +- .../operations/createsavedviewresponse.md | 6 +- .../models/operations/deleteentityrequest.md | 4 +- .../models/operations/deleteentityresponse.md | 4 +- .../operations/deleterelationrequest.md | 8 +- .../operations/deleterelationresponse.md | 4 +- .../operations/deletesavedviewrequest.md | 2 +- .../operations/deletesavedviewresponse.md | 4 +- .../models/operations/deleteschemarequest.md | 2 +- .../models/operations/deleteschemaresponse.md | 4 +- .../operations/exportentitiesrequest.md | 12 +-- .../operations/exportentitiesresponse.md | 4 +- .../models/operations/getactivityrequest.md | 2 +- .../models/operations/getactivityresponse.md | 6 +- ...getentityactivityfeed200applicationjson.md | 8 +- .../getentityactivityfeedrequest.md | 4 +- .../getentityactivityfeedresponse.md | 12 +-- .../models/operations/getentityrequest.md | 4 +- .../models/operations/getentityresponse.md | 12 +-- .../models/operations/getrelationsrequest.md | 4 +- .../models/operations/getrelationsresponse.md | 12 +-- .../operations/getrelationsv2request.md | 4 +- .../operations/getrelationsv2response.md | 12 +-- .../getsavedview200applicationjson.md | 6 +- .../models/operations/getsavedviewrequest.md | 2 +- .../models/operations/getsavedviewresponse.md | 12 +-- .../models/operations/getschemarequest.md | 2 +- .../models/operations/getschemaresponse.md | 6 +- .../getschemaversions200applicationjson.md | 8 +- .../operations/getschemaversionsrequest.md | 2 +- .../operations/getschemaversionsresponse.md | 12 +-- .../models/operations/gettaxonomyrequest.md | 2 +- .../models/operations/gettaxonomyresponse.md | 6 +- .../operations/importentitiesrequest.md | 2 +- .../operations/importentitiesresponse.md | 4 +- ...tfavoriteviewsforuser200applicationjson.md | 6 +- .../listfavoriteviewsforuserresponse.md | 12 +-- .../listsavedviews200applicationjson.md | 6 +- .../operations/listsavedviewsresponse.md | 12 +-- .../listschemablueprints200applicationjson.md | 6 +- .../listschemablueprintsresponse.md | 12 +-- .../listschemas200applicationjson.md | 6 +- .../models/operations/listschemasresponse.md | 12 +-- .../listtaxonomies200applicationjson.md | 6 +- .../operations/listtaxonomiesresponse.md | 12 +-- ...ssificationsforschema200applicationjson.md | 6 +- ...taxonomyclassificationsforschemarequest.md | 4 +- ...axonomyclassificationsforschemaresponse.md | 12 +-- .../models/operations/patchentityrequest.md | 4 +- .../models/operations/patchentityresponse.md | 4 +- .../models/operations/putschemarequest.md | 10 +-- .../models/operations/putschemaresponse.md | 6 +- .../operations/searchentitiesresponse.md | 14 ++-- ...classificationssearch200applicationjson.md | 6 +- .../taxonomiesclassificationssearchrequest.md | 8 +- ...taxonomiesclassificationssearchresponse.md | 12 +-- .../taxonomyautocomplete200applicationjson.md | 6 +- .../operations/taxonomyautocompleterequest.md | 2 +- .../taxonomyautocompleteresponse.md | 12 +-- ...ificationsfortaxonomy200applicationjson.md | 10 +-- ...updateclassificationsfortaxonomyrequest.md | 8 +- ...pdateclassificationsfortaxonomyresponse.md | 12 +-- .../models/operations/updateentityrequest.md | 4 +- .../models/operations/updateentityresponse.md | 4 +- .../operations/updaterelationrequest.md | 18 ++--- .../operations/updaterelationresponse.md | 6 +- .../operations/updatesavedviewrequest.md | 8 +- .../operations/updatesavedviewresponse.md | 6 +- .../models/operations/upsertentityrequest.md | 14 ++-- .../models/operations/upsertentityresponse.md | 4 +- entity/docs/models/shared/activity.md | 6 +- entity/docs/models/shared/activityitem.md | 22 +++--- .../models/shared/addressrelationattribute.md | 10 +-- .../shared/addressrelationattributetype.md | 8 -- .../docs/models/shared/automationattribute.md | 10 +-- .../models/shared/automationattributetype.md | 8 -- entity/docs/models/shared/booleanattribute.md | 10 +-- .../models/shared/booleanattributetype.md | 8 -- .../models/shared/classificationsupdate.md | 10 +-- .../docs/models/shared/computedattribute.md | 10 +-- .../models/shared/computedattributetype.md | 8 -- entity/docs/models/shared/consentattribute.md | 12 +-- .../models/shared/consentattributetype.md | 8 -- entity/docs/models/shared/countryattribute.md | 10 +-- .../models/shared/countryattributetype.md | 8 -- .../docs/models/shared/currencyattribute.md | 12 +-- .../shared/currencyattributecurrency.md | 6 +- .../models/shared/currencyattributetype.md | 8 -- entity/docs/models/shared/dateattribute.md | 10 +-- entity/docs/models/shared/entitycapability.md | 20 ++--- .../docs/models/shared/entitydefaultcreate.md | 10 +-- .../shared/entitydefaultcreateviewtype.md | 8 -- .../docs/models/shared/entitydefaultedit.md | 12 +-- .../shared/entitydefaulteditviewtype.md | 8 -- .../docs/models/shared/entitydefaulttable.md | 16 ++-- .../entitydefaulttabledropdownitems1.md | 12 +-- .../entitydefaulttabledropdownitems1type.md | 8 -- .../entitydefaulttabledropdownitems2.md | 14 ++-- .../entitydefaulttabledropdownitems2type.md | 8 -- .../shared/entitydefaulttablenavbaractions.md | 8 +- .../entitydefaulttablenavbaractionsoptions.md | 8 +- .../shared/entitydefaulttableviewtype.md | 8 -- .../docs/models/shared/entityimportparams.md | 8 +- .../shared/entityimportparamss3reference.md | 4 +- entity/docs/models/shared/entityoperation.md | 18 ++--- entity/docs/models/shared/entityschema.md | 40 +++++----- .../shared/entityschemagroupsettings.md | 22 +++--- entity/docs/models/shared/entityschemaitem.md | 50 ++++++------ .../shared/entityschemaitemgroupsettings.md | 22 +++--- .../models/shared/entityschemaitemuiconfig.md | 16 ++-- .../entityschemaitemuiconfiglistitem.md | 6 +- .../models/shared/entityschemauiconfig.md | 16 ++-- .../shared/entityschemauiconfiglistitem.md | 6 +- .../docs/models/shared/entitysearchparams.md | 4 +- .../docs/models/shared/entitysearchresults.md | 10 +-- .../docs/models/shared/entityviewdisabled.md | 6 +- .../shared/entityviewdisabledviewtype.md | 8 -- entity/docs/models/shared/fileattribute.md | 12 +-- .../shared/getrelationsrespwithpagination.md | 8 +- .../docs/models/shared/internalattribute.md | 10 +-- .../models/shared/internalattributetype.md | 8 -- .../models/shared/internaluserattribute.md | 10 +-- .../shared/internaluserattributetype.md | 8 -- .../models/shared/invitationemailattribute.md | 10 +-- .../shared/invitationemailattributetype.md | 8 -- entity/docs/models/shared/linkattribute.md | 10 +-- .../docs/models/shared/linkattributetype.md | 8 -- .../models/shared/multiselectattribute.md | 12 +-- .../shared/multiselectattributeoptions2.md | 2 +- entity/docs/models/shared/numberattribute.md | 10 +-- .../docs/models/shared/numberattributetype.md | 8 -- .../models/shared/orderedlistattribute.md | 10 +-- .../models/shared/orderedlistattributetype.md | 8 -- .../shared/partnerorganisationattribute.md | 10 +-- .../partnerorganisationattributetype.md | 8 -- .../models/shared/partnerstatusattribute.md | 10 +-- .../shared/partnerstatusattributetype.md | 8 -- .../shared/paymentmethodrelationattribute.md | 10 +-- .../paymentmethodrelationattributetype.md | 8 -- entity/docs/models/shared/purposeattribute.md | 10 +-- .../models/shared/purposeattributetype.md | 8 -- .../docs/models/shared/redirectentityview.md | 8 +- .../shared/redirectentityviewviewtype.md | 8 -- .../docs/models/shared/relationattribute.md | 22 +++--- .../models/shared/relationattributeactions.md | 2 +- .../shared/relationattributeeditmode.md | 8 -- .../models/shared/relationattributetype.md | 8 -- entity/docs/models/shared/relationitem.md | 4 +- .../docs/models/shared/repeatableattribute.md | 12 +-- entity/docs/models/shared/savedview.md | 18 ++--- entity/docs/models/shared/savedviewitem.md | 24 +++--- entity/docs/models/shared/searchmappings.md | 10 +-- entity/docs/models/shared/selectattribute.md | 12 +-- .../models/shared/selectattributeoptions1.md | 2 +- .../docs/models/shared/sequenceattribute.md | 10 +-- .../models/shared/sequenceattributetype.md | 8 -- entity/docs/models/shared/statusattribute.md | 12 +-- .../models/shared/statusattributeoptions2.md | 2 +- .../docs/models/shared/statusattributetype.md | 8 -- entity/docs/models/shared/summaryattribute.md | 4 +- entity/docs/models/shared/tagsattribute.md | 10 +-- .../docs/models/shared/tagsattributetype.md | 8 -- entity/docs/models/shared/taxonomy.md | 4 +- .../models/shared/taxonomyclassification.md | 2 +- entity/docs/models/shared/textattribute.md | 10 +-- .../docs/models/shared/textattributetype.md | 8 -- .../models/shared/userrelationattribute.md | 10 +-- .../shared/userrelationattributetype.md | 8 -- entity/docs/sdks/activity/README.md | 20 ++--- entity/docs/sdks/entities/README.md | 26 +++--- entity/docs/sdks/export/README.md | 8 +- entity/docs/sdks/relations/README.md | 34 ++++---- entity/docs/sdks/savedviews/README.md | 10 +-- entity/docs/sdks/schemas/README.md | 44 +++++------ entity/docs/sdks/taxonomy/README.md | 30 +++---- entity/files.gen | 31 -------- entity/gen.yaml | 8 +- entity/pylintrc | 4 +- entity/setup.py | 2 +- entity/src/epilot/activity.py | 10 +-- entity/src/epilot/entities.py | 26 +++--- entity/src/epilot/entity_import.py | 4 +- entity/src/epilot/export.py | 4 +- .../epilot/models/operations/addrelations.py | 2 +- .../epilot/models/operations/autocomplete.py | 2 +- .../epilot/models/operations/createentity.py | 2 +- .../models/operations/deleterelation.py | 2 +- .../epilot/models/operations/getactivity.py | 4 +- .../src/epilot/models/operations/getentity.py | 2 +- .../operations/getentityactivityfeed.py | 6 +- .../epilot/models/operations/getrelations.py | 4 +- .../models/operations/getrelationsv2.py | 8 +- .../epilot/models/operations/listschemas.py | 2 +- .../epilot/models/operations/patchentity.py | 4 +- .../src/epilot/models/operations/putschema.py | 2 +- .../epilot/models/operations/updateentity.py | 2 +- .../models/operations/updaterelation.py | 2 +- .../epilot/models/operations/upsertentity.py | 4 +- entity/src/epilot/models/shared/__init__.py | 2 +- .../models/shared/addressrelationattribute.py | 22 +++--- .../models/shared/automationattribute.py | 22 +++--- .../epilot/models/shared/booleanattribute.py | 22 +++--- .../epilot/models/shared/computedattribute.py | 22 +++--- .../epilot/models/shared/consentattribute.py | 22 +++--- .../epilot/models/shared/countryattribute.py | 22 +++--- .../epilot/models/shared/currencyattribute.py | 24 +++--- .../src/epilot/models/shared/dateattribute.py | 14 ++-- .../models/shared/entitydefaultcreate.py | 8 +- .../epilot/models/shared/entitydefaultedit.py | 8 +- .../models/shared/entitydefaulttable.py | 20 ++--- .../src/epilot/models/shared/entityschema.py | 2 +- .../epilot/models/shared/entityschemaitem.py | 2 +- .../models/shared/entitysearchparams.py | 8 +- .../models/shared/entityviewdisabled.py | 8 +- .../src/epilot/models/shared/fileattribute.py | 14 ++-- .../epilot/models/shared/internalattribute.py | 22 +++--- .../models/shared/internaluserattribute.py | 22 +++--- .../models/shared/invitationemailattribute.py | 22 +++--- .../src/epilot/models/shared/linkattribute.py | 22 +++--- .../models/shared/multiselectattribute.py | 18 ++--- .../epilot/models/shared/numberattribute.py | 22 +++--- .../models/shared/orderedlistattribute.py | 22 +++--- .../shared/partnerorganisationattribute.py | 22 +++--- .../models/shared/partnerstatusattribute.py | 22 +++--- .../shared/paymentmethodrelationattribute.py | 22 +++--- .../epilot/models/shared/purposeattribute.py | 22 +++--- .../models/shared/redirectentityview.py | 8 +- .../epilot/models/shared/relationattribute.py | 32 +++----- .../models/shared/repeatableattribute.py | 16 ++-- .../epilot/models/shared/searchmappings.py | 2 +- .../epilot/models/shared/selectattribute.py | 14 ++-- .../epilot/models/shared/sequenceattribute.py | 22 +++--- .../epilot/models/shared/statusattribute.py | 22 +++--- .../src/epilot/models/shared/tagsattribute.py | 22 +++--- .../src/epilot/models/shared/textattribute.py | 22 +++--- .../models/shared/userrelationattribute.py | 24 +++--- entity/src/epilot/relations.py | 14 ++-- entity/src/epilot/saved_views.py | 16 ++-- entity/src/epilot/schemas.py | 16 ++-- entity/src/epilot/sdkconfiguration.py | 5 +- entity/src/epilot/taxonomy.py | 14 ++-- entity/src/epilot/utils/utils.py | 79 ++++++++++++++++--- 255 files changed, 1180 insertions(+), 1511 deletions(-) delete mode 100755 entity/docs/models/shared/addressrelationattributetype.md delete mode 100755 entity/docs/models/shared/automationattributetype.md delete mode 100755 entity/docs/models/shared/booleanattributetype.md delete mode 100755 entity/docs/models/shared/computedattributetype.md delete mode 100755 entity/docs/models/shared/consentattributetype.md delete mode 100755 entity/docs/models/shared/countryattributetype.md delete mode 100755 entity/docs/models/shared/currencyattributetype.md delete mode 100755 entity/docs/models/shared/entitydefaultcreateviewtype.md delete mode 100755 entity/docs/models/shared/entitydefaulteditviewtype.md delete mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems1type.md delete mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems2type.md delete mode 100755 entity/docs/models/shared/entitydefaulttableviewtype.md delete mode 100755 entity/docs/models/shared/entityviewdisabledviewtype.md delete mode 100755 entity/docs/models/shared/internalattributetype.md delete mode 100755 entity/docs/models/shared/internaluserattributetype.md delete mode 100755 entity/docs/models/shared/invitationemailattributetype.md delete mode 100755 entity/docs/models/shared/linkattributetype.md delete mode 100755 entity/docs/models/shared/numberattributetype.md delete mode 100755 entity/docs/models/shared/orderedlistattributetype.md delete mode 100755 entity/docs/models/shared/partnerorganisationattributetype.md delete mode 100755 entity/docs/models/shared/partnerstatusattributetype.md delete mode 100755 entity/docs/models/shared/paymentmethodrelationattributetype.md delete mode 100755 entity/docs/models/shared/purposeattributetype.md delete mode 100755 entity/docs/models/shared/redirectentityviewviewtype.md delete mode 100755 entity/docs/models/shared/relationattributeeditmode.md delete mode 100755 entity/docs/models/shared/relationattributetype.md delete mode 100755 entity/docs/models/shared/sequenceattributetype.md delete mode 100755 entity/docs/models/shared/statusattributetype.md delete mode 100755 entity/docs/models/shared/tagsattributetype.md delete mode 100755 entity/docs/models/shared/textattributetype.md delete mode 100755 entity/docs/models/shared/userrelationattributetype.md diff --git a/entity/README.md b/entity/README.md index fe283ccb3..017659dea 100755 --- a/entity/README.md +++ b/entity/README.md @@ -22,7 +22,7 @@ s = epilot.Epilot( req = operations.AttachActivityRequest( entities=[ - 'a05dfc2d-df7c-4c78-8a1b-a928fc816742', + 'ee1dee63-2954-4671-8246-751c43fec091', ], id='01F130Q52Q6MWSNS8N2AVXV4JN', ) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 6383a3b47..1bb16f403 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -308,4 +308,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.91.2 (2.131.1) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.24.1] entity \ No newline at end of file +- [python v1.24.1] entity + +## 2023-09-29 01:13:36 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.91.3 (2.139.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.25.0] entity \ No newline at end of file diff --git a/entity/USAGE.md b/entity/USAGE.md index 5cebff912..bfd2656de 100755 --- a/entity/USAGE.md +++ b/entity/USAGE.md @@ -13,7 +13,7 @@ s = epilot.Epilot( req = operations.AttachActivityRequest( entities=[ - '89bd9d8d-69a6-474e-8f46-7cc8796ed151', + 'ee1dee63-2954-4671-8246-751c43fec091', ], id='01F130Q52Q6MWSNS8N2AVXV4JN', ) diff --git a/entity/docs/models/operations/addrelationsrequest.md b/entity/docs/models/operations/addrelationsrequest.md index 62a5f2a79..510a3cf42 100755 --- a/entity/docs/models/operations/addrelationsrequest.md +++ b/entity/docs/models/operations/addrelationsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `request_body` | list[[shared.RelationItem](../../models/shared/relationitem.md)] | :heavy_minus_sign: | N/A | | +| `request_body` | list[[shared.RelationItem](undefined/models/shared/relationitem.md)] | :heavy_minus_sign: | N/A | | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `id` | *str* | :heavy_check_mark: | Entity id | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/addrelationsresponse.md b/entity/docs/models/operations/addrelationsresponse.md index 6001b8933..f76081ed8 100755 --- a/entity/docs/models/operations/addrelationsresponse.md +++ b/entity/docs/models/operations/addrelationsresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `relation_item` | [Optional[shared.RelationItem]](../../models/shared/relationitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `relation_item` | [Optional[shared.RelationItem]](undefined/models/shared/relationitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/attachactivityrequest.md b/entity/docs/models/operations/attachactivityrequest.md index 871cb14d9..865fab626 100755 --- a/entity/docs/models/operations/attachactivityrequest.md +++ b/entity/docs/models/operations/attachactivityrequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | | `entities` | list[*str*] | :heavy_minus_sign: | Comma-separated list of entities which the activity primarily concerns | | -| `id` | *str* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | \ No newline at end of file diff --git a/entity/docs/models/operations/attachactivityresponse.md b/entity/docs/models/operations/attachactivityresponse.md index 78ed39dc2..a30861e02 100755 --- a/entity/docs/models/operations/attachactivityresponse.md +++ b/entity/docs/models/operations/attachactivityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `activity_item` | [Optional[shared.ActivityItem]](undefined/models/shared/activityitem.md) | :heavy_minus_sign: | Success | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/autocomplete200applicationjson.md b/entity/docs/models/operations/autocomplete200applicationjson.md index 6a664b07a..14c36f0c7 100755 --- a/entity/docs/models/operations/autocomplete200applicationjson.md +++ b/entity/docs/models/operations/autocomplete200applicationjson.md @@ -5,7 +5,7 @@ Success ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `results` | list[[Union[str, bool, dict[str, Any]]](../../models/operations/autocomplete200applicationjsonresults.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `results` | list[[Union[str, bool, dict[str, Any]]](undefined/models/operations/autocomplete200applicationjsonresults.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/operations/autocompleterequest.md b/entity/docs/models/operations/autocompleterequest.md index 788da2934..a349ef863 100755 --- a/entity/docs/models/operations/autocompleterequest.md +++ b/entity/docs/models/operations/autocompleterequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `attribute` | *str* | :heavy_check_mark: | Autocomplete attribute | _tags | +| `attribute` | *Optional[str]* | :heavy_check_mark: | Autocomplete attribute | _tags | | `input` | *Optional[str]* | :heavy_minus_sign: | Input to autocomplete | | | `size` | *Optional[int]* | :heavy_minus_sign: | Maximum number of results to return | | | `slug` | *Optional[str]* | :heavy_minus_sign: | Limit results to entity schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/autocompleteresponse.md b/entity/docs/models/operations/autocompleteresponse.md index 8f820dff9..d3fa102a4 100755 --- a/entity/docs/models/operations/autocompleteresponse.md +++ b/entity/docs/models/operations/autocompleteresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `autocomplete_200_application_json_object` | [Optional[Autocomplete200ApplicationJSON]](../../models/operations/autocomplete200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `autocomplete_200_application_json_object` | [Optional[operations.Autocomplete200ApplicationJSON]](undefined/models/operations/autocomplete200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/createactivityrequest.md b/entity/docs/models/operations/createactivityrequest.md index eaf600128..f573d69cc 100755 --- a/entity/docs/models/operations/createactivityrequest.md +++ b/entity/docs/models/operations/createactivityrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `activity` | [Optional[shared.Activity]](../../models/shared/activity.md) | :heavy_minus_sign: | N/A | +| `activity` | [Optional[shared.Activity]](undefined/models/shared/activity.md) | :heavy_minus_sign: | N/A | | `entities` | list[*str*] | :heavy_minus_sign: | Comma-separated list of entities which the activity primarily concerns | \ No newline at end of file diff --git a/entity/docs/models/operations/createactivityresponse.md b/entity/docs/models/operations/createactivityresponse.md index 81bd58bde..7f865e4b4 100755 --- a/entity/docs/models/operations/createactivityresponse.md +++ b/entity/docs/models/operations/createactivityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `activity_item` | [Optional[shared.ActivityItem]](undefined/models/shared/activityitem.md) | :heavy_minus_sign: | Success | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityrequest.md b/entity/docs/models/operations/createentityrequest.md index 90b2700ee..f9efa87a3 100755 --- a/entity/docs/models/operations/createentityrequest.md +++ b/entity/docs/models/operations/createentityrequest.md @@ -8,4 +8,4 @@ | `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityresponse.md b/entity/docs/models/operations/createentityresponse.md index d7c244dbc..cd30cdfae 100755 --- a/entity/docs/models/operations/createentityresponse.md +++ b/entity/docs/models/operations/createentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/createsavedviewresponse.md b/entity/docs/models/operations/createsavedviewresponse.md index c40e1dc1e..aa4a3373a 100755 --- a/entity/docs/models/operations/createsavedviewresponse.md +++ b/entity/docs/models/operations/createsavedviewresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `saved_view_item` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `saved_view_item` | [Optional[shared.SavedViewItem]](undefined/models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteentityrequest.md b/entity/docs/models/operations/deleteentityrequest.md index 2d034cf52..bf61df601 100755 --- a/entity/docs/models/operations/deleteentityrequest.md +++ b/entity/docs/models/operations/deleteentityrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteentityresponse.md b/entity/docs/models/operations/deleteentityresponse.md index 1ff556201..b1dfc7456 100755 --- a/entity/docs/models/operations/deleteentityresponse.md +++ b/entity/docs/models/operations/deleteentityresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deleterelationrequest.md b/entity/docs/models/operations/deleterelationrequest.md index e20e7c9a2..d84a3467a 100755 --- a/entity/docs/models/operations/deleterelationrequest.md +++ b/entity/docs/models/operations/deleterelationrequest.md @@ -7,7 +7,7 @@ | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `attribute` | *str* | :heavy_check_mark: | The attribute that express meaning | | -| `entity_id` | *str* | :heavy_check_mark: | The attribute that express meaning | | -| `id` | *str* | :heavy_check_mark: | Entity id | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `attribute` | *Optional[str]* | :heavy_check_mark: | The attribute that express meaning | | +| `entity_id` | *Optional[str]* | :heavy_check_mark: | The attribute that express meaning | | +| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleterelationresponse.md b/entity/docs/models/operations/deleterelationresponse.md index 1c6ddb31d..d32bf6719 100755 --- a/entity/docs/models/operations/deleterelationresponse.md +++ b/entity/docs/models/operations/deleterelationresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deletesavedviewrequest.md b/entity/docs/models/operations/deletesavedviewrequest.md index 2d3befa8e..1d3561a75 100755 --- a/entity/docs/models/operations/deletesavedviewrequest.md +++ b/entity/docs/models/operations/deletesavedviewrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *str* | :heavy_check_mark: | View id | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_check_mark: | View id | \ No newline at end of file diff --git a/entity/docs/models/operations/deletesavedviewresponse.md b/entity/docs/models/operations/deletesavedviewresponse.md index 1be59ea6d..af2d5652b 100755 --- a/entity/docs/models/operations/deletesavedviewresponse.md +++ b/entity/docs/models/operations/deletesavedviewresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteschemarequest.md b/entity/docs/models/operations/deleteschemarequest.md index 6de6bc920..f10f3f9e6 100755 --- a/entity/docs/models/operations/deleteschemarequest.md +++ b/entity/docs/models/operations/deleteschemarequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file +| `slug` | *Optional[str]* | :heavy_check_mark: | N/A | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteschemaresponse.md b/entity/docs/models/operations/deleteschemaresponse.md index 9c6e1c201..5cf6b25f3 100755 --- a/entity/docs/models/operations/deleteschemaresponse.md +++ b/entity/docs/models/operations/deleteschemaresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/exportentitiesrequest.md b/entity/docs/models/operations/exportentitiesrequest.md index 7143d4571..8992b8c65 100755 --- a/entity/docs/models/operations/exportentitiesrequest.md +++ b/entity/docs/models/operations/exportentitiesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `entity_search_params` | [Optional[shared.EntitySearchParams]](../../models/shared/entitysearchparams.md) | :heavy_minus_sign: | N/A | | -| `is_template` | *Optional[bool]* | :heavy_minus_sign: | Pass 'true' to generate import template | | -| `job_id` | *Optional[str]* | :heavy_minus_sign: | Export Job Id to get the result | abc123 | -| `language` | *Optional[str]* | :heavy_minus_sign: | Export headers translation language | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `entity_search_params` | [Optional[shared.EntitySearchParams]](undefined/models/shared/entitysearchparams.md) | :heavy_minus_sign: | N/A | | +| `is_template` | *Optional[bool]* | :heavy_minus_sign: | Pass 'true' to generate import template | | +| `job_id` | *Optional[str]* | :heavy_minus_sign: | Export Job Id to get the result | abc123 | +| `language` | *Optional[str]* | :heavy_minus_sign: | Export headers translation language | | \ No newline at end of file diff --git a/entity/docs/models/operations/exportentitiesresponse.md b/entity/docs/models/operations/exportentitiesresponse.md index f5039e620..029251b45 100755 --- a/entity/docs/models/operations/exportentitiesresponse.md +++ b/entity/docs/models/operations/exportentitiesresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getactivityrequest.md b/entity/docs/models/operations/getactivityrequest.md index b0e3dff9a..98bc760da 100755 --- a/entity/docs/models/operations/getactivityrequest.md +++ b/entity/docs/models/operations/getactivityrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `id` | *str* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `id` | *Optional[str]* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | | `operations_from` | *Optional[int]* | :heavy_minus_sign: | Pagination offset for operations
| | | `operations_size` | *Optional[int]* | :heavy_minus_sign: | Maximum number of operations to include in response (default: 10)
| | \ No newline at end of file diff --git a/entity/docs/models/operations/getactivityresponse.md b/entity/docs/models/operations/getactivityresponse.md index 98ce41384..ec2307279 100755 --- a/entity/docs/models/operations/getactivityresponse.md +++ b/entity/docs/models/operations/getactivityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `activity_item` | [Optional[shared.ActivityItem]](undefined/models/shared/activityitem.md) | :heavy_minus_sign: | Success | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeed200applicationjson.md b/entity/docs/models/operations/getentityactivityfeed200applicationjson.md index 607e07ad4..cf21468ea 100755 --- a/entity/docs/models/operations/getentityactivityfeed200applicationjson.md +++ b/entity/docs/models/operations/getentityactivityfeed200applicationjson.md @@ -5,7 +5,7 @@ Success ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `results` | list[[shared.ActivityItem](../../models/shared/activityitem.md)] | :heavy_minus_sign: | N/A | | -| `total` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `results` | list[[shared.ActivityItem](undefined/models/shared/activityitem.md)] | :heavy_minus_sign: | N/A | | +| `total` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeedrequest.md b/entity/docs/models/operations/getentityactivityfeedrequest.md index f60f393f5..402e8b244 100755 --- a/entity/docs/models/operations/getentityactivityfeedrequest.md +++ b/entity/docs/models/operations/getentityactivityfeedrequest.md @@ -8,8 +8,8 @@ | `after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Get activities after this timestamp | | | `before` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | get activities before this timestamp | | | `from_` | *Optional[int]* | :heavy_minus_sign: | start from page | | -| `id` | *str* | :heavy_check_mark: | Entity id | | +| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | | `include_relations` | *Optional[bool]* | :heavy_minus_sign: | Include activities from related entities | | | `size` | *Optional[int]* | :heavy_minus_sign: | max number of results to return | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | | `type` | *Optional[str]* | :heavy_minus_sign: | Filter by activity type | SyncActivity | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeedresponse.md b/entity/docs/models/operations/getentityactivityfeedresponse.md index 79a167013..21bf4c76c 100755 --- a/entity/docs/models/operations/getentityactivityfeedresponse.md +++ b/entity/docs/models/operations/getentityactivityfeedresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `get_entity_activity_feed_200_application_json_object` | [Optional[GetEntityActivityFeed200ApplicationJSON]](../../models/operations/getentityactivityfeed200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_entity_activity_feed_200_application_json_object` | [Optional[operations.GetEntityActivityFeed200ApplicationJSON]](undefined/models/operations/getentityactivityfeed200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityrequest.md b/entity/docs/models/operations/getentityrequest.md index 3b1f862d1..7f1b2917e 100755 --- a/entity/docs/models/operations/getentityrequest.md +++ b/entity/docs/models/operations/getentityrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | -| `id` | *str* | :heavy_check_mark: | Entity id | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityresponse.md b/entity/docs/models/operations/getentityresponse.md index 51acec577..f02495a3d 100755 --- a/entity/docs/models/operations/getentityresponse.md +++ b/entity/docs/models/operations/getentityresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `get_entity_200_application_json_object` | [Optional[GetEntity200ApplicationJSON]](../../models/operations/getentity200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_entity_200_application_json_object` | [Optional[operations.GetEntity200ApplicationJSON]](undefined/models/operations/getentity200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsrequest.md b/entity/docs/models/operations/getrelationsrequest.md index b0b69507e..18b8140ea 100755 --- a/entity/docs/models/operations/getrelationsrequest.md +++ b/entity/docs/models/operations/getrelationsrequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | -| `id` | *str* | :heavy_check_mark: | Entity id | | +| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | | `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsresponse.md b/entity/docs/models/operations/getrelationsresponse.md index 148425e2d..ae2352419 100755 --- a/entity/docs/models/operations/getrelationsresponse.md +++ b/entity/docs/models/operations/getrelationsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `get_relations_resp` | list[[Union[shared.RelationItem, dict[str, Any]]](../../models/shared/getrelationsresp.md)] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `get_relations_resp` | list[[Union[shared.RelationItem, dict[str, Any]]](undefined/models/shared/getrelationsresp.md)] | :heavy_minus_sign: | Success | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv2request.md b/entity/docs/models/operations/getrelationsv2request.md index a3f19f6c7..ae769fa23 100755 --- a/entity/docs/models/operations/getrelationsv2request.md +++ b/entity/docs/models/operations/getrelationsv2request.md @@ -8,8 +8,8 @@ | `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in results | | | `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | -| `id` | *str* | :heavy_check_mark: | Entity id | | +| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | | `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | | `query` | *Optional[str]* | :heavy_minus_sign: | Input to filter search results | | | `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv2response.md b/entity/docs/models/operations/getrelationsv2response.md index 1f3d24b91..0c79d5668 100755 --- a/entity/docs/models/operations/getrelationsv2response.md +++ b/entity/docs/models/operations/getrelationsv2response.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `get_relations_resp_with_pagination` | [Optional[shared.GetRelationsRespWithPagination]](../../models/shared/getrelationsrespwithpagination.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `get_relations_resp_with_pagination` | [Optional[shared.GetRelationsRespWithPagination]](undefined/models/shared/getrelationsrespwithpagination.md) | :heavy_minus_sign: | Success | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getsavedview200applicationjson.md b/entity/docs/models/operations/getsavedview200applicationjson.md index 882160635..c15701787 100755 --- a/entity/docs/models/operations/getsavedview200applicationjson.md +++ b/entity/docs/models/operations/getsavedview200applicationjson.md @@ -5,6 +5,6 @@ Success ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `view` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `view` | [Optional[shared.SavedViewItem]](undefined/models/shared/savedviewitem.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getsavedviewrequest.md b/entity/docs/models/operations/getsavedviewrequest.md index 926155d37..65b452d43 100755 --- a/entity/docs/models/operations/getsavedviewrequest.md +++ b/entity/docs/models/operations/getsavedviewrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *str* | :heavy_check_mark: | View id | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_check_mark: | View id | \ No newline at end of file diff --git a/entity/docs/models/operations/getsavedviewresponse.md b/entity/docs/models/operations/getsavedviewresponse.md index 84207c031..db006a0d1 100755 --- a/entity/docs/models/operations/getsavedviewresponse.md +++ b/entity/docs/models/operations/getsavedviewresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `get_saved_view_200_application_json_object` | [Optional[GetSavedView200ApplicationJSON]](../../models/operations/getsavedview200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_saved_view_200_application_json_object` | [Optional[operations.GetSavedView200ApplicationJSON]](undefined/models/operations/getsavedview200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemarequest.md b/entity/docs/models/operations/getschemarequest.md index 8c26cdd5c..6bbc61c91 100755 --- a/entity/docs/models/operations/getschemarequest.md +++ b/entity/docs/models/operations/getschemarequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file +| `slug` | *Optional[str]* | :heavy_check_mark: | N/A | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaresponse.md b/entity/docs/models/operations/getschemaresponse.md index 7c661e329..6d9464322 100755 --- a/entity/docs/models/operations/getschemaresponse.md +++ b/entity/docs/models/operations/getschemaresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `entity_schema_item` | [Optional[shared.EntitySchemaItem]](../../models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `entity_schema_item` | [Optional[shared.EntitySchemaItem]](undefined/models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversions200applicationjson.md b/entity/docs/models/operations/getschemaversions200applicationjson.md index c04fd28b3..3198da5ab 100755 --- a/entity/docs/models/operations/getschemaversions200applicationjson.md +++ b/entity/docs/models/operations/getschemaversions200applicationjson.md @@ -5,7 +5,7 @@ Success ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `drafts` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | -| `versions` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `drafts` | list[[shared.EntitySchemaItem](undefined/models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | +| `versions` | list[[shared.EntitySchemaItem](undefined/models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversionsrequest.md b/entity/docs/models/operations/getschemaversionsrequest.md index 64d754a5d..f8b163844 100755 --- a/entity/docs/models/operations/getschemaversionsrequest.md +++ b/entity/docs/models/operations/getschemaversionsrequest.md @@ -7,6 +7,6 @@ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | `drafts_from` | *Optional[float]* | :heavy_minus_sign: | N/A | | | `drafts_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | contact | +| `slug` | *Optional[str]* | :heavy_check_mark: | N/A | contact | | `versions_from` | *Optional[float]* | :heavy_minus_sign: | N/A | | | `versions_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversionsresponse.md b/entity/docs/models/operations/getschemaversionsresponse.md index 16df859a3..cea3fdfbe 100755 --- a/entity/docs/models/operations/getschemaversionsresponse.md +++ b/entity/docs/models/operations/getschemaversionsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `get_schema_versions_200_application_json_object` | [Optional[GetSchemaVersions200ApplicationJSON]](../../models/operations/getschemaversions200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_schema_versions_200_application_json_object` | [Optional[operations.GetSchemaVersions200ApplicationJSON]](undefined/models/operations/getschemaversions200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/gettaxonomyrequest.md b/entity/docs/models/operations/gettaxonomyrequest.md index 32f13f4e2..a9b3bb19e 100755 --- a/entity/docs/models/operations/gettaxonomyrequest.md +++ b/entity/docs/models/operations/gettaxonomyrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug to return taxonomy for | purpose | \ No newline at end of file +| `taxonomy_slug` | *Optional[str]* | :heavy_check_mark: | Taxonomy slug to return taxonomy for | purpose | \ No newline at end of file diff --git a/entity/docs/models/operations/gettaxonomyresponse.md b/entity/docs/models/operations/gettaxonomyresponse.md index c4407cd22..c30704d86 100755 --- a/entity/docs/models/operations/gettaxonomyresponse.md +++ b/entity/docs/models/operations/gettaxonomyresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `taxonomy` | [Optional[shared.Taxonomy]](../../models/shared/taxonomy.md) | :heavy_minus_sign: | Taxonomy | \ No newline at end of file +| `taxonomy` | [Optional[shared.Taxonomy]](undefined/models/shared/taxonomy.md) | :heavy_minus_sign: | Taxonomy | \ No newline at end of file diff --git a/entity/docs/models/operations/importentitiesrequest.md b/entity/docs/models/operations/importentitiesrequest.md index 29780c4c1..252acfba1 100755 --- a/entity/docs/models/operations/importentitiesrequest.md +++ b/entity/docs/models/operations/importentitiesrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `entity_import_params` | [Optional[shared.EntityImportParams]](../../models/shared/entityimportparams.md) | :heavy_minus_sign: | N/A | | +| `entity_import_params` | [Optional[shared.EntityImportParams]](undefined/models/shared/entityimportparams.md) | :heavy_minus_sign: | N/A | | | `job_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the import job. This ID is used to track the progress and fetch the result of the import operation. | abc123 | \ No newline at end of file diff --git a/entity/docs/models/operations/importentitiesresponse.md b/entity/docs/models/operations/importentitiesresponse.md index 39f37b821..c42fdd72c 100755 --- a/entity/docs/models/operations/importentitiesresponse.md +++ b/entity/docs/models/operations/importentitiesresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md b/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md index c0ef2ddef..348ffd044 100755 --- a/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md +++ b/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md @@ -5,6 +5,6 @@ Success ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `results` | list[[shared.SavedViewItem](../../models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `results` | list[[shared.SavedViewItem](undefined/models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listfavoriteviewsforuserresponse.md b/entity/docs/models/operations/listfavoriteviewsforuserresponse.md index b857e12ff..746ba5ed3 100755 --- a/entity/docs/models/operations/listfavoriteviewsforuserresponse.md +++ b/entity/docs/models/operations/listfavoriteviewsforuserresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_favorite_views_for_user_200_application_json_object` | [Optional[ListFavoriteViewsForUser200ApplicationJSON]](../../models/operations/listfavoriteviewsforuser200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_favorite_views_for_user_200_application_json_object` | [Optional[operations.ListFavoriteViewsForUser200ApplicationJSON]](undefined/models/operations/listfavoriteviewsforuser200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listsavedviews200applicationjson.md b/entity/docs/models/operations/listsavedviews200applicationjson.md index 1b3bd47f5..0ee868680 100755 --- a/entity/docs/models/operations/listsavedviews200applicationjson.md +++ b/entity/docs/models/operations/listsavedviews200applicationjson.md @@ -5,6 +5,6 @@ Success ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `results` | list[[shared.SavedViewItem](../../models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `results` | list[[shared.SavedViewItem](undefined/models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listsavedviewsresponse.md b/entity/docs/models/operations/listsavedviewsresponse.md index 89fb9157e..832a17d60 100755 --- a/entity/docs/models/operations/listsavedviewsresponse.md +++ b/entity/docs/models/operations/listsavedviewsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_saved_views_200_application_json_object` | [Optional[ListSavedViews200ApplicationJSON]](../../models/operations/listsavedviews200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_saved_views_200_application_json_object` | [Optional[operations.ListSavedViews200ApplicationJSON]](undefined/models/operations/listsavedviews200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemablueprints200applicationjson.md b/entity/docs/models/operations/listschemablueprints200applicationjson.md index 57d194fdb..f530ec086 100755 --- a/entity/docs/models/operations/listschemablueprints200applicationjson.md +++ b/entity/docs/models/operations/listschemablueprints200applicationjson.md @@ -5,6 +5,6 @@ Success ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `results` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `results` | list[[shared.EntitySchemaItem](undefined/models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemablueprintsresponse.md b/entity/docs/models/operations/listschemablueprintsresponse.md index 779aa958f..80802dea3 100755 --- a/entity/docs/models/operations/listschemablueprintsresponse.md +++ b/entity/docs/models/operations/listschemablueprintsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_schema_blueprints_200_application_json_object` | [Optional[ListSchemaBlueprints200ApplicationJSON]](../../models/operations/listschemablueprints200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_schema_blueprints_200_application_json_object` | [Optional[operations.ListSchemaBlueprints200ApplicationJSON]](undefined/models/operations/listschemablueprints200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemas200applicationjson.md b/entity/docs/models/operations/listschemas200applicationjson.md index fd7595402..8fe7da9dc 100755 --- a/entity/docs/models/operations/listschemas200applicationjson.md +++ b/entity/docs/models/operations/listschemas200applicationjson.md @@ -5,6 +5,6 @@ Success ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `results` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `results` | list[[shared.EntitySchemaItem](undefined/models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemasresponse.md b/entity/docs/models/operations/listschemasresponse.md index 000d9c8e2..75a8e6bd0 100755 --- a/entity/docs/models/operations/listschemasresponse.md +++ b/entity/docs/models/operations/listschemasresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_schemas_200_application_json_object` | [Optional[ListSchemas200ApplicationJSON]](../../models/operations/listschemas200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_schemas_200_application_json_object` | [Optional[operations.ListSchemas200ApplicationJSON]](undefined/models/operations/listschemas200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomies200applicationjson.md b/entity/docs/models/operations/listtaxonomies200applicationjson.md index 57b6fab4c..6d82508e2 100755 --- a/entity/docs/models/operations/listtaxonomies200applicationjson.md +++ b/entity/docs/models/operations/listtaxonomies200applicationjson.md @@ -5,6 +5,6 @@ Returns list of taxonomies in an organisation ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `results` | list[[shared.Taxonomy](../../models/shared/taxonomy.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `results` | list[[shared.Taxonomy](undefined/models/shared/taxonomy.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomiesresponse.md b/entity/docs/models/operations/listtaxonomiesresponse.md index 781676fee..2e5c00523 100755 --- a/entity/docs/models/operations/listtaxonomiesresponse.md +++ b/entity/docs/models/operations/listtaxonomiesresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_taxonomies_200_application_json_object` | [Optional[ListTaxonomies200ApplicationJSON]](../../models/operations/listtaxonomies200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomies in an organisation | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_taxonomies_200_application_json_object` | [Optional[operations.ListTaxonomies200ApplicationJSON]](undefined/models/operations/listtaxonomies200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomies in an organisation | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md b/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md index 9bee2d403..42e6ae878 100755 --- a/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md @@ -5,6 +5,6 @@ List of taxonomy classifications ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `results` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md index 9e1d16f97..828968736 100755 --- a/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md @@ -7,5 +7,5 @@ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | `query` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `size` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | contact | -| `taxonomy_slug` | *str* | :heavy_check_mark: | N/A | purpose | \ No newline at end of file +| `slug` | *Optional[str]* | :heavy_check_mark: | N/A | contact | +| `taxonomy_slug` | *Optional[str]* | :heavy_check_mark: | N/A | purpose | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md index c31eb9a54..a48dff834 100755 --- a/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_taxonomy_classifications_for_schema_200_application_json_object` | [Optional[ListTaxonomyClassificationsForSchema200ApplicationJSON]](../../models/operations/listtaxonomyclassificationsforschema200applicationjson.md) | :heavy_minus_sign: | List of taxonomy classifications | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_taxonomy_classifications_for_schema_200_application_json_object` | [Optional[operations.ListTaxonomyClassificationsForSchema200ApplicationJSON]](undefined/models/operations/listtaxonomyclassificationsforschema200applicationjson.md) | :heavy_minus_sign: | List of taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/patchentityrequest.md b/entity/docs/models/operations/patchentityrequest.md index 14dd1b0e1..aad56728b 100755 --- a/entity/docs/models/operations/patchentityrequest.md +++ b/entity/docs/models/operations/patchentityrequest.md @@ -9,5 +9,5 @@ | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for the patch entity to become available in Search API. Useful for large migrations | | | `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = returns the patch result but doesn't perform the patch. | | -| `id` | *str* | :heavy_check_mark: | Entity Id | | -| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_check_mark: | Entity Id | | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/patchentityresponse.md b/entity/docs/models/operations/patchentityresponse.md index da6a41325..435c05811 100755 --- a/entity/docs/models/operations/patchentityresponse.md +++ b/entity/docs/models/operations/patchentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/putschemarequest.md b/entity/docs/models/operations/putschemarequest.md index c9a028b63..2b2102ed8 100755 --- a/entity/docs/models/operations/putschemarequest.md +++ b/entity/docs/models/operations/putschemarequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `entity_schema` | [Optional[shared.EntitySchema]](../../models/shared/entityschema.md) | :heavy_minus_sign: | N/A | | -| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `entity_schema` | [Optional[shared.EntitySchema]](undefined/models/shared/entityschema.md) | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `slug` | *Optional[str]* | :heavy_check_mark: | N/A | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/putschemaresponse.md b/entity/docs/models/operations/putschemaresponse.md index 1a7de73be..0e1de68dd 100755 --- a/entity/docs/models/operations/putschemaresponse.md +++ b/entity/docs/models/operations/putschemaresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `entity_schema_item` | [Optional[shared.EntitySchemaItem]](../../models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `entity_schema_item` | [Optional[shared.EntitySchemaItem]](undefined/models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/searchentitiesresponse.md b/entity/docs/models/operations/searchentitiesresponse.md index 99f85991b..0b5135c92 100755 --- a/entity/docs/models/operations/searchentitiesresponse.md +++ b/entity/docs/models/operations/searchentitiesresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `entity_search_results` | [Optional[shared.EntitySearchResults]](../../models/shared/entitysearchresults.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `search_entities_200_text_csv_string` | *Optional[str]* | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `entity_search_results` | [Optional[shared.EntitySearchResults]](undefined/models/shared/entitysearchresults.md) | :heavy_minus_sign: | Success | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `search_entities_200_text_csv_string` | *Optional[str]* | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md b/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md index 5338757ad..690c86d9d 100755 --- a/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md +++ b/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md @@ -5,6 +5,6 @@ Returns list of taxonomy classifications ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `results` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md b/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md index 72c3d46d5..12dd4bd6b 100755 --- a/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md +++ b/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `request_body` | [Optional[TaxonomiesClassificationsSearchRequestBody]](../../models/operations/taxonomiesclassificationssearchrequestbody.md) | :heavy_minus_sign: | N/A | -| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[operations.TaxonomiesClassificationsSearchRequestBody]](undefined/models/operations/taxonomiesclassificationssearchrequestbody.md) | :heavy_minus_sign: | N/A | +| `taxonomy_slug` | *Optional[str]* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md b/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md index 90328113f..05462f09f 100755 --- a/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md +++ b/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `taxonomies_classifications_search_200_application_json_object` | [Optional[TaxonomiesClassificationsSearch200ApplicationJSON]](../../models/operations/taxonomiesclassificationssearch200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomy classifications | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `taxonomies_classifications_search_200_application_json_object` | [Optional[operations.TaxonomiesClassificationsSearch200ApplicationJSON]](undefined/models/operations/taxonomiesclassificationssearch200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md b/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md index 697d86e3b..bb9f710a8 100755 --- a/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md +++ b/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md @@ -5,6 +5,6 @@ Taxonomy classifications ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `results` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocompleterequest.md b/entity/docs/models/operations/taxonomyautocompleterequest.md index 5a8b57d23..b0ccee272 100755 --- a/entity/docs/models/operations/taxonomyautocompleterequest.md +++ b/entity/docs/models/operations/taxonomyautocompleterequest.md @@ -7,4 +7,4 @@ | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | | `query` | *Optional[str]* | :heavy_minus_sign: | Input to autocomplete | | `size` | *Optional[float]* | :heavy_minus_sign: | Minimum number of results to return | -| `taxonomy_slug` | *str* | :heavy_check_mark: | Limit results to slug | \ No newline at end of file +| `taxonomy_slug` | *Optional[str]* | :heavy_check_mark: | Limit results to slug | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocompleteresponse.md b/entity/docs/models/operations/taxonomyautocompleteresponse.md index fb8e9b28c..73f9f929b 100755 --- a/entity/docs/models/operations/taxonomyautocompleteresponse.md +++ b/entity/docs/models/operations/taxonomyautocompleteresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `taxonomy_autocomplete_200_application_json_object` | [Optional[TaxonomyAutocomplete200ApplicationJSON]](../../models/operations/taxonomyautocomplete200applicationjson.md) | :heavy_minus_sign: | Taxonomy classifications | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `taxonomy_autocomplete_200_application_json_object` | [Optional[operations.TaxonomyAutocomplete200ApplicationJSON]](undefined/models/operations/taxonomyautocomplete200applicationjson.md) | :heavy_minus_sign: | Taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md index 4518623a3..11d503bf4 100755 --- a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md +++ b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md @@ -5,8 +5,8 @@ Taxonomies classifications ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | -| `deleted` | [Optional[UpdateClassificationsForTaxonomy200ApplicationJSONDeleted]](../../models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md) | :heavy_minus_sign: | N/A | -| `updated` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `created` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | +| `deleted` | [Optional[operations.UpdateClassificationsForTaxonomy200ApplicationJSONDeleted]](undefined/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md) | :heavy_minus_sign: | N/A | +| `updated` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md b/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md index 900518fe5..bf89060b3 100755 --- a/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md +++ b/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `classifications_update` | [Optional[shared.ClassificationsUpdate]](../../models/shared/classificationsupdate.md) | :heavy_minus_sign: | N/A | -| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `classifications_update` | [Optional[shared.ClassificationsUpdate]](undefined/models/shared/classificationsupdate.md) | :heavy_minus_sign: | N/A | +| `taxonomy_slug` | *Optional[str]* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md b/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md index 7bde6558d..689b6da6b 100755 --- a/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md +++ b/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `update_classifications_for_taxonomy_200_application_json_object` | [Optional[UpdateClassificationsForTaxonomy200ApplicationJSON]](../../models/operations/updateclassificationsfortaxonomy200applicationjson.md) | :heavy_minus_sign: | Taxonomies classifications | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `update_classifications_for_taxonomy_200_application_json_object` | [Optional[operations.UpdateClassificationsForTaxonomy200ApplicationJSON]](undefined/models/operations/updateclassificationsfortaxonomy200applicationjson.md) | :heavy_minus_sign: | Taxonomies classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/updateentityrequest.md b/entity/docs/models/operations/updateentityrequest.md index d16031a1a..5fc57f80f 100755 --- a/entity/docs/models/operations/updateentityrequest.md +++ b/entity/docs/models/operations/updateentityrequest.md @@ -8,5 +8,5 @@ | `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `id` | *str* | :heavy_check_mark: | Entity id | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/updateentityresponse.md b/entity/docs/models/operations/updateentityresponse.md index 9255fbd0b..36f99db17 100755 --- a/entity/docs/models/operations/updateentityresponse.md +++ b/entity/docs/models/operations/updateentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/updaterelationrequest.md b/entity/docs/models/operations/updaterelationrequest.md index f7302c10e..3a90f4f27 100755 --- a/entity/docs/models/operations/updaterelationrequest.md +++ b/entity/docs/models/operations/updaterelationrequest.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `request_body` | [Optional[UpdateRelationRequestBody]](../../models/operations/updaterelationrequestbody.md) | :heavy_minus_sign: | N/A | | -| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `attribute` | *str* | :heavy_check_mark: | The attribute that express meaning | | -| `entity_id` | *str* | :heavy_check_mark: | The attribute that express meaning | | -| `id` | *str* | :heavy_check_mark: | Entity id | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[operations.UpdateRelationRequestBody]](undefined/models/operations/updaterelationrequestbody.md) | :heavy_minus_sign: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `attribute` | *Optional[str]* | :heavy_check_mark: | The attribute that express meaning | | +| `entity_id` | *Optional[str]* | :heavy_check_mark: | The attribute that express meaning | | +| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/updaterelationresponse.md b/entity/docs/models/operations/updaterelationresponse.md index 5d2853163..c98fc1049 100755 --- a/entity/docs/models/operations/updaterelationresponse.md +++ b/entity/docs/models/operations/updaterelationresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `relation_item` | [Optional[shared.RelationItem]](../../models/shared/relationitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `relation_item` | [Optional[shared.RelationItem]](undefined/models/shared/relationitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/updatesavedviewrequest.md b/entity/docs/models/operations/updatesavedviewrequest.md index 6ffa26a00..2ef3070b0 100755 --- a/entity/docs/models/operations/updatesavedviewrequest.md +++ b/entity/docs/models/operations/updatesavedviewrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `saved_view` | [Optional[shared.SavedView]](../../models/shared/savedview.md) | :heavy_minus_sign: | N/A | -| `id` | *str* | :heavy_check_mark: | View id | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `saved_view` | [Optional[shared.SavedView]](undefined/models/shared/savedview.md) | :heavy_minus_sign: | N/A | +| `id` | *Optional[str]* | :heavy_check_mark: | View id | \ No newline at end of file diff --git a/entity/docs/models/operations/updatesavedviewresponse.md b/entity/docs/models/operations/updatesavedviewresponse.md index 583681685..2fa831d23 100755 --- a/entity/docs/models/operations/updatesavedviewresponse.md +++ b/entity/docs/models/operations/updatesavedviewresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `saved_view_item` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `saved_view_item` | [Optional[shared.SavedViewItem]](undefined/models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityrequest.md b/entity/docs/models/operations/upsertentityrequest.md index b531e76f2..83137b212 100755 --- a/entity/docs/models/operations/upsertentityrequest.md +++ b/entity/docs/models/operations/upsertentityrequest.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `request_body` | [Optional[UpsertEntityRequestBody]](../../models/operations/upsertentityrequestbody.md) | :heavy_minus_sign: | N/A | | -| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = return matched entities but don't update them. | | -| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `request_body` | [Optional[operations.UpsertEntityRequestBody]](undefined/models/operations/upsertentityrequestbody.md) | :heavy_minus_sign: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = return matched entities but don't update them. | | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityresponse.md b/entity/docs/models/operations/upsertentityresponse.md index fbb29f8de..26ccfa898 100755 --- a/entity/docs/models/operations/upsertentityresponse.md +++ b/entity/docs/models/operations/upsertentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/shared/activity.md b/entity/docs/models/shared/activity.md index f7027948d..1daebfb91 100755 --- a/entity/docs/models/shared/activity.md +++ b/entity/docs/models/shared/activity.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `message` | *str* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | +| `message` | *Optional[str]* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | | `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `title` | *str* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | -| `type` | *str* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file +| `title` | *Optional[str]* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | +| `type` | *Optional[str]* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file diff --git a/entity/docs/models/shared/activityitem.md b/entity/docs/models/shared/activityitem.md index 0918052ca..0b0c43653 100755 --- a/entity/docs/models/shared/activityitem.md +++ b/entity/docs/models/shared/activityitem.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `caller` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `message` | *str* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | -| `operations` | list[[EntityOperation](../../models/shared/entityoperation.md)] | :heavy_minus_sign: | N/A | | -| `operations_total` | *Optional[int]* | :heavy_minus_sign: | Count of total operations attached to this activity | 1 | -| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | -| `title` | *str* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | -| `type` | *str* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `caller` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `message` | *Optional[str]* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | +| `operations` | list[[shared.EntityOperation](undefined/models/shared/entityoperation.md)] | :heavy_minus_sign: | N/A | | +| `operations_total` | *Optional[int]* | :heavy_minus_sign: | Count of total operations attached to this activity | 1 | +| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | +| `title` | *Optional[str]* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | +| `type` | *Optional[str]* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattribute.md b/entity/docs/models/shared/addressrelationattribute.md index a7b8382bd..f63361463 100755 --- a/entity/docs/models/shared/addressrelationattribute.md +++ b/entity/docs/models/shared/addressrelationattribute.md @@ -8,7 +8,7 @@ Reference to an address attribute of another entity | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[AddressRelationAttributeConstraints]](../../models/shared/addressrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.AddressRelationAttributeConstraints]](undefined/models/shared/addressrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -18,10 +18,10 @@ Reference to an address attribute of another entity | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[AddressRelationAttributeInfoHelpers]](../../models/shared/addressrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.AddressRelationAttributeInfoHelpers]](undefined/models/shared/addressrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ Reference to an address attribute of another entity | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[AddressRelationAttributeType]](../../models/shared/addressrelationattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattributetype.md b/entity/docs/models/shared/addressrelationattributetype.md deleted file mode 100755 index 591ef24a0..000000000 --- a/entity/docs/models/shared/addressrelationattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# AddressRelationAttributeType - - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `RELATION_ADDRESS` | relation_address | \ No newline at end of file diff --git a/entity/docs/models/shared/automationattribute.md b/entity/docs/models/shared/automationattribute.md index f0806752c..0f4cb4b01 100755 --- a/entity/docs/models/shared/automationattribute.md +++ b/entity/docs/models/shared/automationattribute.md @@ -8,7 +8,7 @@ Automation entity | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[AutomationAttributeConstraints]](../../models/shared/automationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.AutomationAttributeConstraints]](undefined/models/shared/automationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Automation entity | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[AutomationAttributeInfoHelpers]](../../models/shared/automationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.AutomationAttributeInfoHelpers]](undefined/models/shared/automationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Automation entity | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[AutomationAttributeType]](../../models/shared/automationattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/automationattributetype.md b/entity/docs/models/shared/automationattributetype.md deleted file mode 100755 index f32481040..000000000 --- a/entity/docs/models/shared/automationattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# AutomationAttributeType - - -## Values - -| Name | Value | -| ------------ | ------------ | -| `AUTOMATION` | automation | \ No newline at end of file diff --git a/entity/docs/models/shared/booleanattribute.md b/entity/docs/models/shared/booleanattribute.md index 83a502ad8..efcce4015 100755 --- a/entity/docs/models/shared/booleanattribute.md +++ b/entity/docs/models/shared/booleanattribute.md @@ -8,7 +8,7 @@ Yes / No Toggle | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[BooleanAttributeConstraints]](../../models/shared/booleanattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.BooleanAttributeConstraints]](undefined/models/shared/booleanattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Yes / No Toggle | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[BooleanAttributeInfoHelpers]](../../models/shared/booleanattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.BooleanAttributeInfoHelpers]](undefined/models/shared/booleanattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Yes / No Toggle | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[BooleanAttributeType]](../../models/shared/booleanattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/booleanattributetype.md b/entity/docs/models/shared/booleanattributetype.md deleted file mode 100755 index 42e4baaee..000000000 --- a/entity/docs/models/shared/booleanattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# BooleanAttributeType - - -## Values - -| Name | Value | -| --------- | --------- | -| `BOOLEAN` | boolean | \ No newline at end of file diff --git a/entity/docs/models/shared/classificationsupdate.md b/entity/docs/models/shared/classificationsupdate.md index b54b24277..dfdb2ba28 100755 --- a/entity/docs/models/shared/classificationsupdate.md +++ b/entity/docs/models/shared/classificationsupdate.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `create` | list[[TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | -| `delete` | list[*str*] | :heavy_minus_sign: | N/A | -| `update` | list[[TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `create` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | +| `delete` | list[*str*] | :heavy_minus_sign: | N/A | +| `update` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattribute.md b/entity/docs/models/shared/computedattribute.md index ea4891fac..bacd312b5 100755 --- a/entity/docs/models/shared/computedattribute.md +++ b/entity/docs/models/shared/computedattribute.md @@ -8,7 +8,7 @@ An attribute that is computed from the entity data. For more details on how to u | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[ComputedAttributeConstraints]](../../models/shared/computedattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.ComputedAttributeConstraints]](undefined/models/shared/computedattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ An attribute that is computed from the entity data. For more details on how to u | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[ComputedAttributeInfoHelpers]](../../models/shared/computedattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.ComputedAttributeInfoHelpers]](undefined/models/shared/computedattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ An attribute that is computed from the entity data. For more details on how to u | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[ComputedAttributeType]](../../models/shared/computedattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattributetype.md b/entity/docs/models/shared/computedattributetype.md deleted file mode 100755 index 2155a2f01..000000000 --- a/entity/docs/models/shared/computedattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# ComputedAttributeType - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `COMPUTED` | computed | \ No newline at end of file diff --git a/entity/docs/models/shared/consentattribute.md b/entity/docs/models/shared/consentattribute.md index 375da754a..1b8bc865e 100755 --- a/entity/docs/models/shared/consentattribute.md +++ b/entity/docs/models/shared/consentattribute.md @@ -8,7 +8,7 @@ Consent Management | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[ConsentAttributeConstraints]](../../models/shared/consentattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.ConsentAttributeConstraints]](undefined/models/shared/consentattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -18,10 +18,10 @@ Consent Management | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | | `identifiers` | list[*str*] | :heavy_minus_sign: | N/A | | -| `info_helpers` | [Optional[ConsentAttributeInfoHelpers]](../../models/shared/consentattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.ConsentAttributeInfoHelpers]](undefined/models/shared/consentattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,6 +32,6 @@ Consent Management | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `topic` | *str* | :heavy_check_mark: | N/A | | -| `type` | [ConsentAttributeType](../../models/shared/consentattributetype.md) | :heavy_check_mark: | N/A | | +| `topic` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `type` | *Optional[str]* | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/consentattributetype.md b/entity/docs/models/shared/consentattributetype.md deleted file mode 100755 index 705bf9776..000000000 --- a/entity/docs/models/shared/consentattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# ConsentAttributeType - - -## Values - -| Name | Value | -| --------- | --------- | -| `CONSENT` | consent | \ No newline at end of file diff --git a/entity/docs/models/shared/countryattribute.md b/entity/docs/models/shared/countryattribute.md index d734f6d41..99a12df83 100755 --- a/entity/docs/models/shared/countryattribute.md +++ b/entity/docs/models/shared/countryattribute.md @@ -8,7 +8,7 @@ Country picker | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[CountryAttributeConstraints]](../../models/shared/countryattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.CountryAttributeConstraints]](undefined/models/shared/countryattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Country picker | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[CountryAttributeInfoHelpers]](../../models/shared/countryattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.CountryAttributeInfoHelpers]](undefined/models/shared/countryattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Country picker | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[CountryAttributeType]](../../models/shared/countryattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/countryattributetype.md b/entity/docs/models/shared/countryattributetype.md deleted file mode 100755 index d40e0ef82..000000000 --- a/entity/docs/models/shared/countryattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# CountryAttributeType - - -## Values - -| Name | Value | -| --------- | --------- | -| `COUNTRY` | country | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattribute.md b/entity/docs/models/shared/currencyattribute.md index 0a3812d7f..e4aa821c9 100755 --- a/entity/docs/models/shared/currencyattribute.md +++ b/entity/docs/models/shared/currencyattribute.md @@ -8,8 +8,8 @@ Currency input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[CurrencyAttributeConstraints]](../../models/shared/currencyattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | -| `currency` | list[[CurrencyAttributeCurrency](../../models/shared/currencyattributecurrency.md)] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | +| `constraints` | [Optional[shared.CurrencyAttributeConstraints]](undefined/models/shared/currencyattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `currency` | list[[shared.CurrencyAttributeCurrency](undefined/models/shared/currencyattributecurrency.md)] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | | `currency_selector_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | @@ -19,10 +19,10 @@ Currency input | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[CurrencyAttributeInfoHelpers]](../../models/shared/currencyattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.CurrencyAttributeInfoHelpers]](undefined/models/shared/currencyattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -33,5 +33,5 @@ Currency input | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [CurrencyAttributeType](../../models/shared/currencyattributetype.md) | :heavy_check_mark: | N/A | | +| `type` | *Optional[str]* | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattributecurrency.md b/entity/docs/models/shared/currencyattributecurrency.md index 66d213167..c165e258e 100755 --- a/entity/docs/models/shared/currencyattributecurrency.md +++ b/entity/docs/models/shared/currencyattributecurrency.md @@ -7,7 +7,7 @@ A currency configuration | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *str* | :heavy_check_mark: | N/A | -| `description` | *str* | :heavy_check_mark: | N/A | +| `code` | *Optional[str]* | :heavy_check_mark: | N/A | +| `description` | *Optional[str]* | :heavy_check_mark: | N/A | | `flag` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `symbol` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `symbol` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattributetype.md b/entity/docs/models/shared/currencyattributetype.md deleted file mode 100755 index 037e5d352..000000000 --- a/entity/docs/models/shared/currencyattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# CurrencyAttributeType - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `CURRENCY` | currency | \ No newline at end of file diff --git a/entity/docs/models/shared/dateattribute.md b/entity/docs/models/shared/dateattribute.md index 43649e651..218fd7ddc 100755 --- a/entity/docs/models/shared/dateattribute.md +++ b/entity/docs/models/shared/dateattribute.md @@ -8,7 +8,7 @@ Date or Datetime picker | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[DateAttributeConstraints]](../../models/shared/dateattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.DateAttributeConstraints]](undefined/models/shared/dateattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Date or Datetime picker | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[DateAttributeInfoHelpers]](../../models/shared/dateattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.DateAttributeInfoHelpers]](undefined/models/shared/dateattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Date or Datetime picker | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[DateAttributeType]](../../models/shared/dateattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.DateAttributeType]](undefined/models/shared/dateattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitycapability.md b/entity/docs/models/shared/entitycapability.md index 0c39a607d..7017f2881 100755 --- a/entity/docs/models/shared/entitycapability.md +++ b/entity/docs/models/shared/entitycapability.md @@ -5,13 +5,13 @@ Capabilities the Entity has. Turn features on/off for entities. ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_minus_sign: | N/A | | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show capability for legacy tenants (ivy) | | -| `name` | *str* | :heavy_check_mark: | Unique name for the capability | customer_messaging | -| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the setting is enabled | MY_SETTING | -| `title` | *Optional[str]* | :heavy_minus_sign: | Human readable title of the capability | Messaging | -| `ui_hooks` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `attributes` | list[[Union[shared.TextAttribute, shared.LinkAttribute, shared.DateAttribute, shared.CountryAttribute, shared.BooleanAttribute, shared.SelectAttribute, shared.MultiSelectAttribute, shared.StatusAttribute, shared.SequenceAttribute, shared.RelationAttribute, shared.UserRelationAttribute, shared.AddressRelationAttribute, shared.PaymentMethodRelationAttribute, shared.CurrencyAttribute, shared.RepeatableAttribute, shared.TagsAttribute, shared.NumberAttribute, shared.ConsentAttribute, shared.InternalAttribute, shared.OrderedListAttribute, shared.FileAttribute, shared.ComputedAttribute, shared.PartnerStatusAttribute, shared.InvitationEmailAttribute, shared.AutomationAttribute, shared.InternalUserAttribute, shared.PurposeAttribute, shared.PartnerOrganisationAttribute]](undefined/models/shared/attribute.md)] | :heavy_minus_sign: | N/A | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show capability for legacy tenants (ivy) | | +| `name` | *Optional[str]* | :heavy_check_mark: | Unique name for the capability | customer_messaging | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the setting is enabled | MY_SETTING | +| `title` | *Optional[str]* | :heavy_minus_sign: | Human readable title of the capability | Messaging | +| `ui_hooks` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreate.md b/entity/docs/models/shared/entitydefaultcreate.md index d4699a2db..93412a485 100755 --- a/entity/docs/models/shared/entitydefaultcreate.md +++ b/entity/docs/models/shared/entitydefaultcreate.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | -| `table_menu_options` | [Optional[EntityDefaultCreateTableMenuOptions]](../../models/shared/entitydefaultcreatetablemenuoptions.md) | :heavy_minus_sign: | N/A | -| `view_type` | [Optional[EntityDefaultCreateViewType]](../../models/shared/entitydefaultcreateviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | +| `table_menu_options` | [Optional[shared.EntityDefaultCreateTableMenuOptions]](undefined/models/shared/entitydefaultcreatetablemenuoptions.md) | :heavy_minus_sign: | N/A | +| `view_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreateviewtype.md b/entity/docs/models/shared/entitydefaultcreateviewtype.md deleted file mode 100755 index 387ef6ef2..000000000 --- a/entity/docs/models/shared/entitydefaultcreateviewtype.md +++ /dev/null @@ -1,8 +0,0 @@ -# EntityDefaultCreateViewType - - -## Values - -| Name | Value | -| --------- | --------- | -| `DEFAULT` | default | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultedit.md b/entity/docs/models/shared/entitydefaultedit.md index bb7faa418..e78300c8d 100755 --- a/entity/docs/models/shared/entitydefaultedit.md +++ b/entity/docs/models/shared/entitydefaultedit.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | -| `summary_attributes` | list[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | -| `table_menu_options` | [Optional[EntityDefaultEditTableMenuOptions]](../../models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | -| `view_type` | [Optional[EntityDefaultEditViewType]](../../models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | +| `summary_attributes` | list[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | +| `table_menu_options` | [Optional[shared.EntityDefaultEditTableMenuOptions]](undefined/models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | +| `view_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulteditviewtype.md b/entity/docs/models/shared/entitydefaulteditviewtype.md deleted file mode 100755 index 300ea7dd7..000000000 --- a/entity/docs/models/shared/entitydefaulteditviewtype.md +++ /dev/null @@ -1,8 +0,0 @@ -# EntityDefaultEditViewType - - -## Values - -| Name | Value | -| --------- | --------- | -| `DEFAULT` | default | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttable.md b/entity/docs/models/shared/entitydefaulttable.md index 4fd442fe1..d8243fa94 100755 --- a/entity/docs/models/shared/entitydefaulttable.md +++ b/entity/docs/models/shared/entitydefaulttable.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `classic_view` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `dropdown_items` | list[[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]](../../models/shared/entitydefaulttabledropdownitems.md)] | :heavy_minus_sign: | N/A | -| `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | -| `navbar_actions` | list[[EntityDefaultTableNavbarActions](../../models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | -| `row_actions` | list[*str*] | :heavy_minus_sign: | N/A | -| `view_type` | [Optional[EntityDefaultTableViewType]](../../models/shared/entitydefaulttableviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `classic_view` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `dropdown_items` | list[[Union[shared.EntityDefaultTableDropdownItems1, shared.EntityDefaultTableDropdownItems2]](undefined/models/shared/entitydefaulttabledropdownitems.md)] | :heavy_minus_sign: | N/A | +| `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | +| `navbar_actions` | list[[shared.EntityDefaultTableNavbarActions](undefined/models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | +| `row_actions` | list[*str*] | :heavy_minus_sign: | N/A | +| `view_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md index 1627f2b02..f1a67b43f 100755 --- a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `entity` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | -| `type` | [Optional[EntityDefaultTableDropdownItems1Type]](../../models/shared/entitydefaulttabledropdownitems1type.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `entity` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md deleted file mode 100755 index dd78cb538..000000000 --- a/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md +++ /dev/null @@ -1,8 +0,0 @@ -# EntityDefaultTableDropdownItems1Type - - -## Values - -| Name | Value | -| -------- | -------- | -| `ENTITY` | entity | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md index 0dab288f3..5055cfc3c 100755 --- a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | -| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Opportunities | -| `type` | [Optional[EntityDefaultTableDropdownItems2Type]](../../models/shared/entitydefaulttabledropdownitems2type.md) | :heavy_minus_sign: | N/A | | -| `uri` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Opportunities | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `uri` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md deleted file mode 100755 index 3e3a26e10..000000000 --- a/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md +++ /dev/null @@ -1,8 +0,0 @@ -# EntityDefaultTableDropdownItems2Type - - -## Values - -| Name | Value | -| ------ | ------ | -| `LINK` | link | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractions.md b/entity/docs/models/shared/entitydefaulttablenavbaractions.md index 0d1db344c..9858f0d20 100755 --- a/entity/docs/models/shared/entitydefaulttablenavbaractions.md +++ b/entity/docs/models/shared/entitydefaulttablenavbaractions.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `options` | list[[EntityDefaultTableNavbarActionsOptions](../../models/shared/entitydefaulttablenavbaractionsoptions.md)] | :heavy_minus_sign: | N/A | -| `type` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `options` | list[[shared.EntityDefaultTableNavbarActionsOptions](undefined/models/shared/entitydefaulttablenavbaractionsoptions.md)] | :heavy_minus_sign: | N/A | +| `type` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md index 31a355818..9b00b17b0 100755 --- a/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md +++ b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `label` | *str* | :heavy_check_mark: | N/A | -| `params` | [Optional[EntityDefaultTableNavbarActionsOptionsParams]](../../models/shared/entitydefaulttablenavbaractionsoptionsparams.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | +| `params` | [Optional[shared.EntityDefaultTableNavbarActionsOptionsParams]](undefined/models/shared/entitydefaulttablenavbaractionsoptionsparams.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttableviewtype.md b/entity/docs/models/shared/entitydefaulttableviewtype.md deleted file mode 100755 index e42ccf697..000000000 --- a/entity/docs/models/shared/entitydefaulttableviewtype.md +++ /dev/null @@ -1,8 +0,0 @@ -# EntityDefaultTableViewType - - -## Values - -| Name | Value | -| --------- | --------- | -| `DEFAULT` | default | \ No newline at end of file diff --git a/entity/docs/models/shared/entityimportparams.md b/entity/docs/models/shared/entityimportparams.md index c61968d20..0b21c75df 100755 --- a/entity/docs/models/shared/entityimportparams.md +++ b/entity/docs/models/shared/entityimportparams.md @@ -5,7 +5,7 @@ The parameters for importing entities. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `s3_reference` | [EntityImportParamsS3Reference](../../models/shared/entityimportparamss3reference.md) | :heavy_check_mark: | The S3 bucket and key where the JSON file for import is located. | | -| `schema` | *str* | :heavy_check_mark: | The schema of the entities being imported. This must match the schema of the entities on the platform. | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `s3_reference` | [Optional[shared.EntityImportParamsS3Reference]](undefined/models/shared/entityimportparamss3reference.md) | :heavy_check_mark: | The S3 bucket and key where the JSON file for import is located. | | +| `schema` | *Optional[str]* | :heavy_check_mark: | The schema of the entities being imported. This must match the schema of the entities on the platform. | contact | \ No newline at end of file diff --git a/entity/docs/models/shared/entityimportparamss3reference.md b/entity/docs/models/shared/entityimportparamss3reference.md index 20d56e6ca..c45c62831 100755 --- a/entity/docs/models/shared/entityimportparamss3reference.md +++ b/entity/docs/models/shared/entityimportparamss3reference.md @@ -7,5 +7,5 @@ The S3 bucket and key where the JSON file for import is located. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `bucket` | *str* | :heavy_check_mark: | The name of the S3 bucket where the JSON file for import is stored. | my-bucket | -| `key` | *str* | :heavy_check_mark: | The key or path to the JSON file within the S3 bucket. | imports/my-import.json | \ No newline at end of file +| `bucket` | *Optional[str]* | :heavy_check_mark: | The name of the S3 bucket where the JSON file for import is stored. | my-bucket | +| `key` | *Optional[str]* | :heavy_check_mark: | The key or path to the JSON file within the S3 bucket. | imports/my-import.json | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperation.md b/entity/docs/models/shared/entityoperation.md index 1019dc921..da006a1fa 100755 --- a/entity/docs/models/shared/entityoperation.md +++ b/entity/docs/models/shared/entityoperation.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `activity_id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `diff` | [Optional[EntityOperationDiff]](../../models/shared/entityoperationdiff.md) | :heavy_minus_sign: | N/A | | -| `entity` | *str* | :heavy_check_mark: | N/A | | -| `operation` | [EntityOperationOperation](../../models/shared/entityoperationoperation.md) | :heavy_check_mark: | N/A | | -| `org` | *str* | :heavy_check_mark: | N/A | 123 | -| `params` | [Optional[EntityOperationParams]](../../models/shared/entityoperationparams.md) | :heavy_minus_sign: | N/A | | -| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `diff` | [Optional[shared.EntityOperationDiff]](undefined/models/shared/entityoperationdiff.md) | :heavy_minus_sign: | N/A | | +| `entity` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `operation` | [Optional[shared.EntityOperationOperation]](undefined/models/shared/entityoperationoperation.md) | :heavy_check_mark: | N/A | | +| `org` | *Optional[str]* | :heavy_check_mark: | N/A | 123 | +| `params` | [Optional[shared.EntityOperationParams]](undefined/models/shared/entityoperationparams.md) | :heavy_minus_sign: | N/A | | +| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschema.md b/entity/docs/models/shared/entityschema.md index db8ca673b..8a207ecf8 100755 --- a/entity/docs/models/shared/entityschema.md +++ b/entity/docs/models/shared/entityschema.md @@ -5,23 +5,23 @@ The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relati ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | | -| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | -| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | -| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | -| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `group_settings` | list[[EntitySchemaGroupSettings](../../models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | -| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | -| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | -| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | -| `plural` | *str* | :heavy_check_mark: | N/A | Contacts | -| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | -| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | -| `ui_config` | [Optional[EntitySchemaUIConfig]](../../models/shared/entityschemauiconfig.md) | :heavy_minus_sign: | N/A | | -| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `attributes` | list[[Union[shared.TextAttribute, shared.LinkAttribute, shared.DateAttribute, shared.CountryAttribute, shared.BooleanAttribute, shared.SelectAttribute, shared.MultiSelectAttribute, shared.StatusAttribute, shared.SequenceAttribute, shared.RelationAttribute, shared.UserRelationAttribute, shared.AddressRelationAttribute, shared.PaymentMethodRelationAttribute, shared.CurrencyAttribute, shared.RepeatableAttribute, shared.TagsAttribute, shared.NumberAttribute, shared.ConsentAttribute, shared.InternalAttribute, shared.OrderedListAttribute, shared.FileAttribute, shared.ComputedAttribute, shared.PartnerStatusAttribute, shared.InvitationEmailAttribute, shared.AutomationAttribute, shared.InternalUserAttribute, shared.PurposeAttribute, shared.PartnerOrganisationAttribute]](undefined/models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | | +| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | +| `capabilities` | list[[shared.EntityCapability](undefined/models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | +| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | +| `explicit_search_mappings` | dict[str, [shared.SearchMappings](undefined/models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group_settings` | list[[shared.EntitySchemaGroupSettings](undefined/models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | +| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | +| `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | +| `plural` | *Optional[str]* | :heavy_check_mark: | N/A | Contacts | +| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `slug` | *Optional[str]* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | +| `ui_config` | [Optional[shared.EntitySchemaUIConfig]](undefined/models/shared/entityschemauiconfig.md) | :heavy_minus_sign: | N/A | | +| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemagroupsettings.md b/entity/docs/models/shared/entityschemagroupsettings.md index 22ed11aff..b7c6a17df 100755 --- a/entity/docs/models/shared/entityschemagroupsettings.md +++ b/entity/docs/models/shared/entityschemagroupsettings.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `info_tooltip_title` | [Optional[EntitySchemaGroupSettingsInfoTooltipTitle]](../../models/shared/entityschemagroupsettingsinfotooltiptitle.md) | :heavy_minus_sign: | N/A | | -| `label` | *str* | :heavy_check_mark: | N/A | | -| `order` | *Optional[int]* | :heavy_minus_sign: | Render order of the group | | -| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | -| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the setting is enabled | MY_SETTING | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `id` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_tooltip_title` | [Optional[shared.EntitySchemaGroupSettingsInfoTooltipTitle]](undefined/models/shared/entityschemagroupsettingsinfotooltiptitle.md) | :heavy_minus_sign: | N/A | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Render order of the group | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the setting is enabled | MY_SETTING | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitem.md b/entity/docs/models/shared/entityschemaitem.md index 4bc70a6a4..3da754319 100755 --- a/entity/docs/models/shared/entityschemaitem.md +++ b/entity/docs/models/shared/entityschemaitem.md @@ -5,28 +5,28 @@ The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relati ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | | -| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | -| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | -| `comment` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | -| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `group_settings` | list[[EntitySchemaItemGroupSettings](../../models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | -| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | -| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for schema | | -| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | -| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | -| `plural` | *str* | :heavy_check_mark: | N/A | Contacts | -| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | -| `source` | [Optional[EntitySchemaItemSource]](../../models/shared/entityschemaitemsource.md) | :heavy_minus_sign: | N/A | | -| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | -| `ui_config` | [Optional[EntitySchemaItemUIConfig]](../../models/shared/entityschemaitemuiconfig.md) | :heavy_minus_sign: | N/A | | -| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `attributes` | list[[Union[shared.TextAttribute, shared.LinkAttribute, shared.DateAttribute, shared.CountryAttribute, shared.BooleanAttribute, shared.SelectAttribute, shared.MultiSelectAttribute, shared.StatusAttribute, shared.SequenceAttribute, shared.RelationAttribute, shared.UserRelationAttribute, shared.AddressRelationAttribute, shared.PaymentMethodRelationAttribute, shared.CurrencyAttribute, shared.RepeatableAttribute, shared.TagsAttribute, shared.NumberAttribute, shared.ConsentAttribute, shared.InternalAttribute, shared.OrderedListAttribute, shared.FileAttribute, shared.ComputedAttribute, shared.PartnerStatusAttribute, shared.InvitationEmailAttribute, shared.AutomationAttribute, shared.InternalUserAttribute, shared.PurposeAttribute, shared.PartnerOrganisationAttribute]](undefined/models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | | +| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | +| `capabilities` | list[[shared.EntityCapability](undefined/models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | +| `comment` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | +| `explicit_search_mappings` | dict[str, [shared.SearchMappings](undefined/models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group_settings` | list[[shared.EntitySchemaItemGroupSettings](undefined/models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | +| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for schema | | +| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | +| `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | +| `plural` | *Optional[str]* | :heavy_check_mark: | N/A | Contacts | +| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `slug` | *Optional[str]* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `source` | [Optional[shared.EntitySchemaItemSource]](undefined/models/shared/entityschemaitemsource.md) | :heavy_minus_sign: | N/A | | +| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | +| `ui_config` | [Optional[shared.EntitySchemaItemUIConfig]](undefined/models/shared/entityschemaitemuiconfig.md) | :heavy_minus_sign: | N/A | | +| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemgroupsettings.md b/entity/docs/models/shared/entityschemaitemgroupsettings.md index 764606624..c16cf1bbc 100755 --- a/entity/docs/models/shared/entityschemaitemgroupsettings.md +++ b/entity/docs/models/shared/entityschemaitemgroupsettings.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `info_tooltip_title` | [Optional[EntitySchemaItemGroupSettingsInfoTooltipTitle]](../../models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md) | :heavy_minus_sign: | N/A | | -| `label` | *str* | :heavy_check_mark: | N/A | | -| `order` | *Optional[int]* | :heavy_minus_sign: | Render order of the group | | -| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | -| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the setting is enabled | MY_SETTING | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `id` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_tooltip_title` | [Optional[shared.EntitySchemaItemGroupSettingsInfoTooltipTitle]](undefined/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md) | :heavy_minus_sign: | N/A | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Render order of the group | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the setting is enabled | MY_SETTING | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfig.md b/entity/docs/models/shared/entityschemaitemuiconfig.md index 94301cef2..eed4cf516 100755 --- a/entity/docs/models/shared/entityschemaitemuiconfig.md +++ b/entity/docs/models/shared/entityschemaitemuiconfig.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `create_view` | [Optional[Union[EntityDefaultCreate, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigcreateview.md) | :heavy_minus_sign: | N/A | -| `edit_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigeditview.md) | :heavy_minus_sign: | N/A | -| `list_item` | [Optional[EntitySchemaItemUIConfigListItem]](../../models/shared/entityschemaitemuiconfiglistitem.md) | :heavy_minus_sign: | N/A | -| `sharing` | [Optional[EntitySchemaItemUIConfigSharing]](../../models/shared/entityschemaitemuiconfigsharing.md) | :heavy_minus_sign: | N/A | -| `single_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigsingleview.md) | :heavy_minus_sign: | N/A | -| `table_view` | [Optional[Union[EntityDefaultTable, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigtableview.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `create_view` | [Optional[Union[shared.EntityDefaultCreate, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemaitemuiconfigcreateview.md) | :heavy_minus_sign: | N/A | +| `edit_view` | [Optional[Union[shared.EntityDefaultEdit, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemaitemuiconfigeditview.md) | :heavy_minus_sign: | N/A | +| `list_item` | [Optional[shared.EntitySchemaItemUIConfigListItem]](undefined/models/shared/entityschemaitemuiconfiglistitem.md) | :heavy_minus_sign: | N/A | +| `sharing` | [Optional[shared.EntitySchemaItemUIConfigSharing]](undefined/models/shared/entityschemaitemuiconfigsharing.md) | :heavy_minus_sign: | N/A | +| `single_view` | [Optional[Union[shared.EntityDefaultEdit, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemaitemuiconfigsingleview.md) | :heavy_minus_sign: | N/A | +| `table_view` | [Optional[Union[shared.EntityDefaultTable, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemaitemuiconfigtableview.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md index baa96f3e0..1b1b26ad6 100755 --- a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md +++ b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `summary_attributes` | list[[Union[SummaryAttribute, str]](../../models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `summary_attributes` | list[[Union[shared.SummaryAttribute, str]](undefined/models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfig.md b/entity/docs/models/shared/entityschemauiconfig.md index 246332f95..081ebac9c 100755 --- a/entity/docs/models/shared/entityschemauiconfig.md +++ b/entity/docs/models/shared/entityschemauiconfig.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| `create_view` | [Optional[Union[EntityDefaultCreate, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigcreateview.md) | :heavy_minus_sign: | N/A | -| `edit_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigeditview.md) | :heavy_minus_sign: | N/A | -| `list_item` | [Optional[EntitySchemaUIConfigListItem]](../../models/shared/entityschemauiconfiglistitem.md) | :heavy_minus_sign: | N/A | -| `sharing` | [Optional[EntitySchemaUIConfigSharing]](../../models/shared/entityschemauiconfigsharing.md) | :heavy_minus_sign: | N/A | -| `single_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigsingleview.md) | :heavy_minus_sign: | N/A | -| `table_view` | [Optional[Union[EntityDefaultTable, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigtableview.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `create_view` | [Optional[Union[shared.EntityDefaultCreate, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemauiconfigcreateview.md) | :heavy_minus_sign: | N/A | +| `edit_view` | [Optional[Union[shared.EntityDefaultEdit, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemauiconfigeditview.md) | :heavy_minus_sign: | N/A | +| `list_item` | [Optional[shared.EntitySchemaUIConfigListItem]](undefined/models/shared/entityschemauiconfiglistitem.md) | :heavy_minus_sign: | N/A | +| `sharing` | [Optional[shared.EntitySchemaUIConfigSharing]](undefined/models/shared/entityschemauiconfigsharing.md) | :heavy_minus_sign: | N/A | +| `single_view` | [Optional[Union[shared.EntityDefaultEdit, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemauiconfigsingleview.md) | :heavy_minus_sign: | N/A | +| `table_view` | [Optional[Union[shared.EntityDefaultTable, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemauiconfigtableview.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfiglistitem.md b/entity/docs/models/shared/entityschemauiconfiglistitem.md index d55ca9564..4f06adebf 100755 --- a/entity/docs/models/shared/entityschemauiconfiglistitem.md +++ b/entity/docs/models/shared/entityschemauiconfiglistitem.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `summary_attributes` | list[[Union[SummaryAttribute, str]](../../models/shared/entityschemauiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `summary_attributes` | list[[Union[shared.SummaryAttribute, str]](undefined/models/shared/entityschemauiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitysearchparams.md b/entity/docs/models/shared/entitysearchparams.md index 44d3afaba..ebcf74b3c 100755 --- a/entity/docs/models/shared/entitysearchparams.md +++ b/entity/docs/models/shared/entitysearchparams.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `aggs` | [Optional[EntitySearchParamsAggs]](../../models/shared/entitysearchparamsaggs.md) | :heavy_minus_sign: | Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics. | | +| `aggs` | [Optional[shared.EntitySearchParamsAggs]](undefined/models/shared/entitysearchparamsaggs.md) | :heavy_minus_sign: | Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics. | | | `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in search results | | | `from_` | *Optional[int]* | :heavy_minus_sign: | N/A | | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | | `include_scores` | *Optional[bool]* | :heavy_minus_sign: | Adds a `_score` number field to results that can be used to rank by match score | | -| `q` | *str* | :heavy_check_mark: | Lucene queries supported with ElasticSearch | _schema:contact AND status:active | +| `q` | *Optional[str]* | :heavy_check_mark: | Lucene queries supported with ElasticSearch | _schema:contact AND status:active | | `size` | *Optional[int]* | :heavy_minus_sign: | Max search size is 1000 with higher values defaulting to 1000 | | | `sort` | *Optional[str]* | :heavy_minus_sign: | N/A | _created_at:desc | \ No newline at end of file diff --git a/entity/docs/models/shared/entitysearchresults.md b/entity/docs/models/shared/entitysearchresults.md index bc0247253..06024d2ab 100755 --- a/entity/docs/models/shared/entitysearchresults.md +++ b/entity/docs/models/shared/entitysearchresults.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `aggregations` | [Optional[EntitySearchResultsAggregations]](../../models/shared/entitysearchresultsaggregations.md) | :heavy_minus_sign: | N/A | | -| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `results` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `aggregations` | [Optional[shared.EntitySearchResultsAggregations]](undefined/models/shared/entitysearchresultsaggregations.md) | :heavy_minus_sign: | N/A | | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `results` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityviewdisabled.md b/entity/docs/models/shared/entityviewdisabled.md index bce87a9f8..db0f74b4f 100755 --- a/entity/docs/models/shared/entityviewdisabled.md +++ b/entity/docs/models/shared/entityviewdisabled.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `view_type` | [Optional[EntityViewDisabledViewType]](../../models/shared/entityviewdisabledviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `view_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityviewdisabledviewtype.md b/entity/docs/models/shared/entityviewdisabledviewtype.md deleted file mode 100755 index 332085008..000000000 --- a/entity/docs/models/shared/entityviewdisabledviewtype.md +++ /dev/null @@ -1,8 +0,0 @@ -# EntityViewDisabledViewType - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `DISABLED` | disabled | \ No newline at end of file diff --git a/entity/docs/models/shared/fileattribute.md b/entity/docs/models/shared/fileattribute.md index adb9c3b02..19cbbbbb9 100755 --- a/entity/docs/models/shared/fileattribute.md +++ b/entity/docs/models/shared/fileattribute.md @@ -9,8 +9,8 @@ File or Image Attachment | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | | `allowed_extensions` | list[*str*] | :heavy_minus_sign: | List of file extensions (without the dot suffix) | | -| `constraints` | [Optional[FileAttributeConstraints]](../../models/shared/fileattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | -| `default_access_control` | [Optional[FileAttributeDefaultAccessControl]](../../models/shared/fileattributedefaultaccesscontrol.md) | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[shared.FileAttributeConstraints]](undefined/models/shared/fileattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_access_control` | [Optional[shared.FileAttributeDefaultAccessControl]](undefined/models/shared/fileattributedefaultaccesscontrol.md) | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `display_images_landscaped` | *Optional[bool]* | :heavy_minus_sign: | Controls how the images are presented to the user during upload on the Entity Details view. | | @@ -21,11 +21,11 @@ File or Image Attachment | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[FileAttributeInfoHelpers]](../../models/shared/fileattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.FileAttributeInfoHelpers]](undefined/models/shared/fileattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `multiple` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -36,5 +36,5 @@ File or Image Attachment | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [FileAttributeType](../../models/shared/fileattributetype.md) | :heavy_check_mark: | N/A | | +| `type` | [Optional[shared.FileAttributeType]](undefined/models/shared/fileattributetype.md) | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/getrelationsrespwithpagination.md b/entity/docs/models/shared/getrelationsrespwithpagination.md index 37bfbbe33..f5cde89e4 100755 --- a/entity/docs/models/shared/getrelationsrespwithpagination.md +++ b/entity/docs/models/shared/getrelationsrespwithpagination.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `relations` | list[[Union[RelationItem, dict[str, Any]]](../../models/shared/getrelationsresp.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `relations` | list[[Union[shared.RelationItem, dict[str, Any]]](undefined/models/shared/getrelationsresp.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattribute.md b/entity/docs/models/shared/internalattribute.md index 88f5067bd..48b4a9235 100755 --- a/entity/docs/models/shared/internalattribute.md +++ b/entity/docs/models/shared/internalattribute.md @@ -8,7 +8,7 @@ No UI representation | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[InternalAttributeConstraints]](../../models/shared/internalattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.InternalAttributeConstraints]](undefined/models/shared/internalattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ No UI representation | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[InternalAttributeInfoHelpers]](../../models/shared/internalattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.InternalAttributeInfoHelpers]](undefined/models/shared/internalattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ No UI representation | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[InternalAttributeType]](../../models/shared/internalattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattributetype.md b/entity/docs/models/shared/internalattributetype.md deleted file mode 100755 index ce3397a2e..000000000 --- a/entity/docs/models/shared/internalattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# InternalAttributeType - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `INTERNAL` | internal | \ No newline at end of file diff --git a/entity/docs/models/shared/internaluserattribute.md b/entity/docs/models/shared/internaluserattribute.md index 03a2edc50..11d7e4422 100755 --- a/entity/docs/models/shared/internaluserattribute.md +++ b/entity/docs/models/shared/internaluserattribute.md @@ -8,7 +8,7 @@ Epilot internal user info | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[InternalUserAttributeConstraints]](../../models/shared/internaluserattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.InternalUserAttributeConstraints]](undefined/models/shared/internaluserattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Epilot internal user info | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[InternalUserAttributeInfoHelpers]](../../models/shared/internaluserattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.InternalUserAttributeInfoHelpers]](undefined/models/shared/internaluserattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Epilot internal user info | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[InternalUserAttributeType]](../../models/shared/internaluserattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internaluserattributetype.md b/entity/docs/models/shared/internaluserattributetype.md deleted file mode 100755 index f6f08a50c..000000000 --- a/entity/docs/models/shared/internaluserattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# InternalUserAttributeType - - -## Values - -| Name | Value | -| --------------- | --------------- | -| `INTERNAL_USER` | internal_user | \ No newline at end of file diff --git a/entity/docs/models/shared/invitationemailattribute.md b/entity/docs/models/shared/invitationemailattribute.md index 3537e8fa1..cd4ec9cee 100755 --- a/entity/docs/models/shared/invitationemailattribute.md +++ b/entity/docs/models/shared/invitationemailattribute.md @@ -8,7 +8,7 @@ Email address for send invitation | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[InvitationEmailAttributeConstraints]](../../models/shared/invitationemailattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.InvitationEmailAttributeConstraints]](undefined/models/shared/invitationemailattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Email address for send invitation | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[InvitationEmailAttributeInfoHelpers]](../../models/shared/invitationemailattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.InvitationEmailAttributeInfoHelpers]](undefined/models/shared/invitationemailattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Email address for send invitation | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[InvitationEmailAttributeType]](../../models/shared/invitationemailattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/invitationemailattributetype.md b/entity/docs/models/shared/invitationemailattributetype.md deleted file mode 100755 index ddd4ae2c4..000000000 --- a/entity/docs/models/shared/invitationemailattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# InvitationEmailAttributeType - - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `INVITATION_EMAIL` | invitation_email | \ No newline at end of file diff --git a/entity/docs/models/shared/linkattribute.md b/entity/docs/models/shared/linkattribute.md index 7a898a93b..07c97f47a 100755 --- a/entity/docs/models/shared/linkattribute.md +++ b/entity/docs/models/shared/linkattribute.md @@ -8,7 +8,7 @@ Link with title and href | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[LinkAttributeConstraints]](../../models/shared/linkattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.LinkAttributeConstraints]](undefined/models/shared/linkattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Link with title and href | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[LinkAttributeInfoHelpers]](../../models/shared/linkattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.LinkAttributeInfoHelpers]](undefined/models/shared/linkattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Link with title and href | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[LinkAttributeType]](../../models/shared/linkattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/linkattributetype.md b/entity/docs/models/shared/linkattributetype.md deleted file mode 100755 index 5da92ba14..000000000 --- a/entity/docs/models/shared/linkattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# LinkAttributeType - - -## Values - -| Name | Value | -| ------ | ------ | -| `LINK` | link | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattribute.md b/entity/docs/models/shared/multiselectattribute.md index 93811b3a9..f36e935f8 100755 --- a/entity/docs/models/shared/multiselectattribute.md +++ b/entity/docs/models/shared/multiselectattribute.md @@ -10,7 +10,7 @@ Multi Choice Selection | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | | `allow_any` | *Optional[bool]* | :heavy_minus_sign: | Allow arbitrary input values in addition to provided options | | | `allow_extra_options` | *Optional[bool]* | :heavy_minus_sign: | controls if the 360 ui will allow the user to enter a value which is not defined by the options | | -| `constraints` | [Optional[MultiSelectAttributeConstraints]](../../models/shared/multiselectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.MultiSelectAttributeConstraints]](undefined/models/shared/multiselectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `disable_case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | controls if the matching of values against the options is case sensitive or not | | @@ -20,11 +20,11 @@ Multi Choice Selection | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[MultiSelectAttributeInfoHelpers]](../../models/shared/multiselectattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.MultiSelectAttributeInfoHelpers]](undefined/models/shared/multiselectattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `options` | list[[Union[str, MultiSelectAttributeOptions2]](../../models/shared/multiselectattributeoptions.md)] | :heavy_minus_sign: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `options` | list[[Union[str, shared.MultiSelectAttributeOptions2]](undefined/models/shared/multiselectattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -35,5 +35,5 @@ Multi Choice Selection | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[MultiSelectAttributeType]](../../models/shared/multiselectattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.MultiSelectAttributeType]](undefined/models/shared/multiselectattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattributeoptions2.md b/entity/docs/models/shared/multiselectattributeoptions2.md index 48fc585d5..5ac818288 100755 --- a/entity/docs/models/shared/multiselectattributeoptions2.md +++ b/entity/docs/models/shared/multiselectattributeoptions2.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | | `title` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/numberattribute.md b/entity/docs/models/shared/numberattribute.md index 8c3c883bb..7886a1d2e 100755 --- a/entity/docs/models/shared/numberattribute.md +++ b/entity/docs/models/shared/numberattribute.md @@ -8,7 +8,7 @@ Numeric input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[NumberAttributeConstraints]](../../models/shared/numberattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.NumberAttributeConstraints]](undefined/models/shared/numberattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -18,10 +18,10 @@ Numeric input | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[NumberAttributeInfoHelpers]](../../models/shared/numberattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.NumberAttributeInfoHelpers]](undefined/models/shared/numberattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ Numeric input | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[NumberAttributeType]](../../models/shared/numberattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/numberattributetype.md b/entity/docs/models/shared/numberattributetype.md deleted file mode 100755 index a355b2afb..000000000 --- a/entity/docs/models/shared/numberattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# NumberAttributeType - - -## Values - -| Name | Value | -| -------- | -------- | -| `NUMBER` | number | \ No newline at end of file diff --git a/entity/docs/models/shared/orderedlistattribute.md b/entity/docs/models/shared/orderedlistattribute.md index 7e9bc77d4..7b5b7613c 100755 --- a/entity/docs/models/shared/orderedlistattribute.md +++ b/entity/docs/models/shared/orderedlistattribute.md @@ -8,7 +8,7 @@ Type of attribute to render N number of ordered fields | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[OrderedListAttributeConstraints]](../../models/shared/orderedlistattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.OrderedListAttributeConstraints]](undefined/models/shared/orderedlistattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Type of attribute to render N number of ordered fields | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[OrderedListAttributeInfoHelpers]](../../models/shared/orderedlistattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.OrderedListAttributeInfoHelpers]](undefined/models/shared/orderedlistattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Type of attribute to render N number of ordered fields | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[OrderedListAttributeType]](../../models/shared/orderedlistattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/orderedlistattributetype.md b/entity/docs/models/shared/orderedlistattributetype.md deleted file mode 100755 index 7954fba64..000000000 --- a/entity/docs/models/shared/orderedlistattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# OrderedListAttributeType - - -## Values - -| Name | Value | -| -------------- | -------------- | -| `ORDERED_LIST` | ordered_list | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerorganisationattribute.md b/entity/docs/models/shared/partnerorganisationattribute.md index e792e4d42..9f1d3ec87 100755 --- a/entity/docs/models/shared/partnerorganisationattribute.md +++ b/entity/docs/models/shared/partnerorganisationattribute.md @@ -8,7 +8,7 @@ Shared Partner Organisations | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[PartnerOrganisationAttributeConstraints]](../../models/shared/partnerorganisationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.PartnerOrganisationAttributeConstraints]](undefined/models/shared/partnerorganisationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Shared Partner Organisations | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[PartnerOrganisationAttributeInfoHelpers]](../../models/shared/partnerorganisationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.PartnerOrganisationAttributeInfoHelpers]](undefined/models/shared/partnerorganisationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Shared Partner Organisations | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[PartnerOrganisationAttributeType]](../../models/shared/partnerorganisationattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerorganisationattributetype.md b/entity/docs/models/shared/partnerorganisationattributetype.md deleted file mode 100755 index 2ed31a1e1..000000000 --- a/entity/docs/models/shared/partnerorganisationattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# PartnerOrganisationAttributeType - - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `PARTNER_ORGANISATION` | partner_organisation | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerstatusattribute.md b/entity/docs/models/shared/partnerstatusattribute.md index a56225c9a..e30a10855 100755 --- a/entity/docs/models/shared/partnerstatusattribute.md +++ b/entity/docs/models/shared/partnerstatusattribute.md @@ -8,7 +8,7 @@ Partner Status | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[PartnerStatusAttributeConstraints]](../../models/shared/partnerstatusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.PartnerStatusAttributeConstraints]](undefined/models/shared/partnerstatusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Partner Status | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[PartnerStatusAttributeInfoHelpers]](../../models/shared/partnerstatusattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.PartnerStatusAttributeInfoHelpers]](undefined/models/shared/partnerstatusattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Partner Status | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[PartnerStatusAttributeType]](../../models/shared/partnerstatusattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerstatusattributetype.md b/entity/docs/models/shared/partnerstatusattributetype.md deleted file mode 100755 index f9be21824..000000000 --- a/entity/docs/models/shared/partnerstatusattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# PartnerStatusAttributeType - - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `PARTNER_STATUS` | partner_status | \ No newline at end of file diff --git a/entity/docs/models/shared/paymentmethodrelationattribute.md b/entity/docs/models/shared/paymentmethodrelationattribute.md index 9586f898f..833af7952 100755 --- a/entity/docs/models/shared/paymentmethodrelationattribute.md +++ b/entity/docs/models/shared/paymentmethodrelationattribute.md @@ -8,7 +8,7 @@ Reference to a payment method attribute of another entity | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[PaymentMethodRelationAttributeConstraints]](../../models/shared/paymentmethodrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.PaymentMethodRelationAttributeConstraints]](undefined/models/shared/paymentmethodrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -18,10 +18,10 @@ Reference to a payment method attribute of another entity | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[PaymentMethodRelationAttributeInfoHelpers]](../../models/shared/paymentmethodrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.PaymentMethodRelationAttributeInfoHelpers]](undefined/models/shared/paymentmethodrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ Reference to a payment method attribute of another entity | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[PaymentMethodRelationAttributeType]](../../models/shared/paymentmethodrelationattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/paymentmethodrelationattributetype.md b/entity/docs/models/shared/paymentmethodrelationattributetype.md deleted file mode 100755 index 3a5cdf1c9..000000000 --- a/entity/docs/models/shared/paymentmethodrelationattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# PaymentMethodRelationAttributeType - - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `RELATION_PAYMENT_METHOD` | relation_payment_method | \ No newline at end of file diff --git a/entity/docs/models/shared/purposeattribute.md b/entity/docs/models/shared/purposeattribute.md index 6816d073d..855be733e 100755 --- a/entity/docs/models/shared/purposeattribute.md +++ b/entity/docs/models/shared/purposeattribute.md @@ -8,7 +8,7 @@ Entity Taxonomy | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[PurposeAttributeConstraints]](../../models/shared/purposeattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.PurposeAttributeConstraints]](undefined/models/shared/purposeattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | @@ -19,10 +19,10 @@ Entity Taxonomy | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | | `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `info_helpers` | [Optional[PurposeAttributeInfoHelpers]](../../models/shared/purposeattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.PurposeAttributeInfoHelpers]](undefined/models/shared/purposeattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | Wallbox PV | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | Wallbox PV | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `parents` | list[*str*] | :heavy_minus_sign: | N/A | | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -34,6 +34,6 @@ Entity Taxonomy | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[PurposeAttributeType]](../../models/shared/purposeattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/purposeattributetype.md b/entity/docs/models/shared/purposeattributetype.md deleted file mode 100755 index a46263d3b..000000000 --- a/entity/docs/models/shared/purposeattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# PurposeAttributeType - - -## Values - -| Name | Value | -| --------- | --------- | -| `PURPOSE` | purpose | \ No newline at end of file diff --git a/entity/docs/models/shared/redirectentityview.md b/entity/docs/models/shared/redirectentityview.md index 7146cfa18..b3923f504 100755 --- a/entity/docs/models/shared/redirectentityview.md +++ b/entity/docs/models/shared/redirectentityview.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `route` | *Optional[str]* | :heavy_minus_sign: | N/A | /app/pricing-hub/product/:entityId | -| `view_type` | [Optional[RedirectEntityViewViewType]](../../models/shared/redirectentityviewviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `route` | *Optional[str]* | :heavy_minus_sign: | N/A | /app/pricing-hub/product/:entityId | +| `view_type` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/redirectentityviewviewtype.md b/entity/docs/models/shared/redirectentityviewviewtype.md deleted file mode 100755 index f1f49db52..000000000 --- a/entity/docs/models/shared/redirectentityviewviewtype.md +++ /dev/null @@ -1,8 +0,0 @@ -# RedirectEntityViewViewType - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `REDIRECT` | redirect | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattribute.md b/entity/docs/models/shared/relationattribute.md index da8b5fa1d..629257b6f 100755 --- a/entity/docs/models/shared/relationattribute.md +++ b/entity/docs/models/shared/relationattribute.md @@ -8,15 +8,15 @@ Entity Relationship | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `actions` | list[[RelationAttributeActions](../../models/shared/relationattributeactions.md)] | :heavy_minus_sign: | N/A | | +| `actions` | list[[shared.RelationAttributeActions](undefined/models/shared/relationattributeactions.md)] | :heavy_minus_sign: | N/A | | | `add_button_label` | *Optional[str]* | :heavy_minus_sign: | Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is. | | | `allowed_schemas` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[RelationAttributeConstraints]](../../models/shared/relationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.RelationAttributeConstraints]](undefined/models/shared/relationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `details_view_mode_enabled` | *Optional[bool]* | :heavy_minus_sign: | Enables the preview, edition, and creation of relation items on a Master-Details view mode. | | -| `drawer_size` | [Optional[RelationAttributeDrawerSize]](../../models/shared/relationattributedrawersize.md) | :heavy_minus_sign: | N/A | | -| `edit_mode` | [Optional[RelationAttributeEditMode]](../../models/shared/relationattributeeditmode.md) | :heavy_minus_sign: | N/A | | +| `drawer_size` | [Optional[shared.RelationAttributeDrawerSize]](undefined/models/shared/relationattributedrawersize.md) | :heavy_minus_sign: | N/A | | +| `edit_mode` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `enable_relation_picker` | *Optional[bool]* | :heavy_minus_sign: | When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link. | | | `enable_relation_tags` | *Optional[bool]* | :heavy_minus_sign: | When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item. | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -26,17 +26,17 @@ Entity Relationship | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `info_helpers` | [Optional[RelationAttributeInfoHelpers]](../../models/shared/relationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.RelationAttributeInfoHelpers]](undefined/models/shared/relationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | | `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `relation_affinity_mode` | [Optional[RelationAttributeRelationAffinityMode]](../../models/shared/relationattributerelationaffinitymode.md) | :heavy_minus_sign: | Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity. | | -| `relation_type` | [Optional[RelationAttributeRelationType]](../../models/shared/relationattributerelationtype.md) | :heavy_minus_sign: | N/A | | +| `relation_affinity_mode` | [Optional[shared.RelationAttributeRelationAffinityMode]](undefined/models/shared/relationattributerelationaffinitymode.md) | :heavy_minus_sign: | Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity. | | +| `relation_type` | [Optional[shared.RelationAttributeRelationType]](undefined/models/shared/relationattributerelationtype.md) | :heavy_minus_sign: | N/A | | | `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `reverse_attributes` | dict[str, *str*] | :heavy_minus_sign: | Map of schema slug to target relation attribute | | @@ -44,6 +44,6 @@ Entity Relationship | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `summary_fields` | list[[Union[str, SummaryField]](../../models/shared/relationattributesummaryfields.md)] | :heavy_minus_sign: | N/A | | -| `type` | [Optional[RelationAttributeType]](../../models/shared/relationattributetype.md) | :heavy_minus_sign: | N/A | | +| `summary_fields` | list[[Union[str, shared.SummaryField]](undefined/models/shared/relationattributesummaryfields.md)] | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributeactions.md b/entity/docs/models/shared/relationattributeactions.md index bd8afb4b9..856efc2ab 100755 --- a/entity/docs/models/shared/relationattributeactions.md +++ b/entity/docs/models/shared/relationattributeactions.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action_type` | [Optional[RelationAttributeActionsActionType]](../../models/shared/relationattributeactionsactiontype.md) | :heavy_minus_sign: | The action type. Currently supported actions:

\| action \| description \|
\|--------\|-------------\|
\| add_existing \| Enables the user to pick an existing entity to link as relation \|
\| create_new \| Enables the user to create a new entity using the first/main `allowed_schemas` schema
\| create_from_existing \| Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation \|
| +| `action_type` | [Optional[shared.RelationAttributeActionsActionType]](undefined/models/shared/relationattributeactionsactiontype.md) | :heavy_minus_sign: | The action type. Currently supported actions:

\| action \| description \|
\|--------\|-------------\|
\| add_existing \| Enables the user to pick an existing entity to link as relation \|
\| create_new \| Enables the user to create a new entity using the first/main `allowed_schemas` schema
\| create_from_existing \| Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation \|
| | `default` | *Optional[bool]* | :heavy_minus_sign: | Sets the action as the default action, visible as the main action button. | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the feature flag that enables this action | | `label` | *Optional[str]* | :heavy_minus_sign: | The action label or action translation key (i18n) | diff --git a/entity/docs/models/shared/relationattributeeditmode.md b/entity/docs/models/shared/relationattributeeditmode.md deleted file mode 100755 index cc0a9a767..000000000 --- a/entity/docs/models/shared/relationattributeeditmode.md +++ /dev/null @@ -1,8 +0,0 @@ -# RelationAttributeEditMode - - -## Values - -| Name | Value | -| ----------- | ----------- | -| `LIST_VIEW` | list-view | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributetype.md b/entity/docs/models/shared/relationattributetype.md deleted file mode 100755 index 233bc4c95..000000000 --- a/entity/docs/models/shared/relationattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# RelationAttributeType - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `RELATION` | relation | \ No newline at end of file diff --git a/entity/docs/models/shared/relationitem.md b/entity/docs/models/shared/relationitem.md index 900acb8c8..76ca794c0 100755 --- a/entity/docs/models/shared/relationitem.md +++ b/entity/docs/models/shared/relationitem.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | | `tags` | list[*str*] | :heavy_minus_sign: | N/A | -| `attribute` | *str* | :heavy_check_mark: | N/A | -| `entity_id` | *str* | :heavy_check_mark: | N/A | +| `attribute` | *Optional[str]* | :heavy_check_mark: | N/A | +| `entity_id` | *Optional[str]* | :heavy_check_mark: | N/A | | `reverse` | *Optional[bool]* | :heavy_minus_sign: | Whether this is a reverse relation | \ No newline at end of file diff --git a/entity/docs/models/shared/repeatableattribute.md b/entity/docs/models/shared/repeatableattribute.md index ba13a0dc0..9a2aaa7fe 100755 --- a/entity/docs/models/shared/repeatableattribute.md +++ b/entity/docs/models/shared/repeatableattribute.md @@ -8,7 +8,7 @@ Repeatable (add N number of fields) | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[RepeatableAttributeConstraints]](../../models/shared/repeatableattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.RepeatableAttributeConstraints]](undefined/models/shared/repeatableattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `enable_relation_picker` | *Optional[bool]* | :heavy_minus_sign: | when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link. | | @@ -19,21 +19,21 @@ Repeatable (add N number of fields) | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[RepeatableAttributeInfoHelpers]](../../models/shared/repeatableattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.RepeatableAttributeInfoHelpers]](undefined/models/shared/repeatableattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | | `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `relation_affinity_mode` | [Optional[RepeatableAttributeRelationAffinityMode]](../../models/shared/repeatableattributerelationaffinitymode.md) | :heavy_minus_sign: | Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity. | | +| `relation_affinity_mode` | [Optional[shared.RepeatableAttributeRelationAffinityMode]](undefined/models/shared/repeatableattributerelationaffinitymode.md) | :heavy_minus_sign: | Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity. | | | `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | | `repeatable` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[RepeatableAttributeType]](../../models/shared/repeatableattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.RepeatableAttributeType]](undefined/models/shared/repeatableattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/savedview.md b/entity/docs/models/shared/savedview.md index e00cb8246..53eaa5dbe 100755 --- a/entity/docs/models/shared/savedview.md +++ b/entity/docs/models/shared/savedview.md @@ -5,12 +5,12 @@ A saved entity view ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `created_by` | [Union[SavedViewCreatedBy1, dict[str, Any]]](../../models/shared/savedviewcreatedby.md) | :heavy_check_mark: | N/A | | -| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | -| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | -| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | -| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | -| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | -| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `created_by` | [Optional[Union[shared.SavedViewCreatedBy1, dict[str, Any]]]](undefined/models/shared/savedviewcreatedby.md) | :heavy_check_mark: | N/A | | +| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | +| `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | +| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | +| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | +| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewitem.md b/entity/docs/models/shared/savedviewitem.md index 4adfe17cd..3172591dd 100755 --- a/entity/docs/models/shared/savedviewitem.md +++ b/entity/docs/models/shared/savedviewitem.md @@ -5,15 +5,15 @@ A saved entity view ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `created_by` | [Union[SavedViewItemCreatedBy1, dict[str, Any]]](../../models/shared/savedviewitemcreatedby.md) | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | -| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | -| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | -| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | -| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | -| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | -| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | -| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `created_by` | [Optional[Union[shared.SavedViewItemCreatedBy1, dict[str, Any]]]](undefined/models/shared/savedviewitemcreatedby.md) | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | +| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | +| `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | +| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | +| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | +| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | +| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/searchmappings.md b/entity/docs/models/shared/searchmappings.md index 117bd6494..b64abe4b1 100755 --- a/entity/docs/models/shared/searchmappings.md +++ b/entity/docs/models/shared/searchmappings.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `fields_` | dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `index` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [Optional[SearchMappingsType]](../../models/shared/searchmappingstype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `fields_` | dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `index` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[shared.SearchMappingsType]](undefined/models/shared/searchmappingstype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattribute.md b/entity/docs/models/shared/selectattribute.md index 443b89dd0..b6a085a89 100755 --- a/entity/docs/models/shared/selectattribute.md +++ b/entity/docs/models/shared/selectattribute.md @@ -9,7 +9,7 @@ Dropdown select | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | | `allow_any` | *Optional[bool]* | :heavy_minus_sign: | Allow arbitrary input values in addition to provided options | | -| `constraints` | [Optional[SelectAttributeConstraints]](../../models/shared/selectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.SelectAttributeConstraints]](undefined/models/shared/selectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -18,11 +18,11 @@ Dropdown select | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[SelectAttributeInfoHelpers]](../../models/shared/selectattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.SelectAttributeInfoHelpers]](undefined/models/shared/selectattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `options` | list[[Union[SelectAttributeOptions1, str]](../../models/shared/selectattributeoptions.md)] | :heavy_minus_sign: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `options` | list[[Union[shared.SelectAttributeOptions1, str]](undefined/models/shared/selectattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -33,5 +33,5 @@ Dropdown select | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[SelectAttributeType]](../../models/shared/selectattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.SelectAttributeType]](undefined/models/shared/selectattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattributeoptions1.md b/entity/docs/models/shared/selectattributeoptions1.md index 0bb8bf0c4..c80258c77 100755 --- a/entity/docs/models/shared/selectattributeoptions1.md +++ b/entity/docs/models/shared/selectattributeoptions1.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | | `title` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/sequenceattribute.md b/entity/docs/models/shared/sequenceattribute.md index 9eb78732b..4e3602fa1 100755 --- a/entity/docs/models/shared/sequenceattribute.md +++ b/entity/docs/models/shared/sequenceattribute.md @@ -8,7 +8,7 @@ Sequence of unique identifiers | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[SequenceAttributeConstraints]](../../models/shared/sequenceattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.SequenceAttributeConstraints]](undefined/models/shared/sequenceattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Sequence of unique identifiers | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[SequenceAttributeInfoHelpers]](../../models/shared/sequenceattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.SequenceAttributeInfoHelpers]](undefined/models/shared/sequenceattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `prefix` | *Optional[str]* | :heavy_minus_sign: | Prefix added before the sequence number | OR- | @@ -33,5 +33,5 @@ Sequence of unique identifiers | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `start_number` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `type` | [Optional[SequenceAttributeType]](../../models/shared/sequenceattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/sequenceattributetype.md b/entity/docs/models/shared/sequenceattributetype.md deleted file mode 100755 index e2592e106..000000000 --- a/entity/docs/models/shared/sequenceattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# SequenceAttributeType - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `SEQUENCE` | sequence | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattribute.md b/entity/docs/models/shared/statusattribute.md index 0a33a27a1..3d5707d14 100755 --- a/entity/docs/models/shared/statusattribute.md +++ b/entity/docs/models/shared/statusattribute.md @@ -8,7 +8,7 @@ Status select | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[StatusAttributeConstraints]](../../models/shared/statusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.StatusAttributeConstraints]](undefined/models/shared/statusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,11 +17,11 @@ Status select | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[StatusAttributeInfoHelpers]](../../models/shared/statusattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.StatusAttributeInfoHelpers]](undefined/models/shared/statusattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `options` | list[[Union[str, StatusAttributeOptions2]](../../models/shared/statusattributeoptions.md)] | :heavy_minus_sign: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `options` | list[[Union[str, shared.StatusAttributeOptions2]](undefined/models/shared/statusattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ Status select | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[StatusAttributeType]](../../models/shared/statusattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattributeoptions2.md b/entity/docs/models/shared/statusattributeoptions2.md index b363733b6..64199c976 100755 --- a/entity/docs/models/shared/statusattributeoptions2.md +++ b/entity/docs/models/shared/statusattributeoptions2.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | | `title` | *Optional[str]* | :heavy_minus_sign: | The displayed title of the option | -| `value` | *str* | :heavy_check_mark: | The stored value of the option | \ No newline at end of file +| `value` | *Optional[str]* | :heavy_check_mark: | The stored value of the option | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattributetype.md b/entity/docs/models/shared/statusattributetype.md deleted file mode 100755 index 8a9b3b5f1..000000000 --- a/entity/docs/models/shared/statusattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# StatusAttributeType - - -## Values - -| Name | Value | -| -------- | -------- | -| `STATUS` | status | \ No newline at end of file diff --git a/entity/docs/models/shared/summaryattribute.md b/entity/docs/models/shared/summaryattribute.md index 0eb07aab0..66cdeb084 100755 --- a/entity/docs/models/shared/summaryattribute.md +++ b/entity/docs/models/shared/summaryattribute.md @@ -19,9 +19,9 @@ The value field supports handlebar expressions from which you can pick any field | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | Binds summary field visibility to the feature flag state. | -| `label` | *str* | :heavy_check_mark: | Label to be shown on the top of the value. | +| `label` | *Optional[str]* | :heavy_check_mark: | Label to be shown on the top of the value. | | `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | Binds summary field visibility to the setting flag state. | | `show_as_tag` | *Optional[bool]* | :heavy_minus_sign: | Displays the value within a tag chip. | | `tag_color` | *Optional[str]* | :heavy_minus_sign: | CSS hex color or CSS color name for the tag chip. | -| `value` | *str* | :heavy_check_mark: | A static value or an handlebar expression. | \ No newline at end of file +| `value` | *Optional[str]* | :heavy_check_mark: | A static value or an handlebar expression. | \ No newline at end of file diff --git a/entity/docs/models/shared/tagsattribute.md b/entity/docs/models/shared/tagsattribute.md index c8332cf8a..2576cfc6c 100755 --- a/entity/docs/models/shared/tagsattribute.md +++ b/entity/docs/models/shared/tagsattribute.md @@ -8,7 +8,7 @@ Tags | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[TagsAttributeConstraints]](../../models/shared/tagsattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.TagsAttributeConstraints]](undefined/models/shared/tagsattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Tags | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[TagsAttributeInfoHelpers]](../../models/shared/tagsattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.TagsAttributeInfoHelpers]](undefined/models/shared/tagsattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `options` | list[*str*] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -33,5 +33,5 @@ Tags | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `suggestions` | list[*str*] | :heavy_minus_sign: | N/A | | -| `type` | [Optional[TagsAttributeType]](../../models/shared/tagsattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/tagsattributetype.md b/entity/docs/models/shared/tagsattributetype.md deleted file mode 100755 index cf2593e33..000000000 --- a/entity/docs/models/shared/tagsattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# TagsAttributeType - - -## Values - -| Name | Value | -| ------ | ------ | -| `TAGS` | tags | \ No newline at end of file diff --git a/entity/docs/models/shared/taxonomy.md b/entity/docs/models/shared/taxonomy.md index 84674090e..cdf634202 100755 --- a/entity/docs/models/shared/taxonomy.md +++ b/entity/docs/models/shared/taxonomy.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag | Purpose | +| `name` | *Optional[str]* | :heavy_check_mark: | A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag | Purpose | | `plural` | *Optional[str]* | :heavy_minus_sign: | Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags | Purposes | -| `slug` | *str* | :heavy_check_mark: | URL-friendly name for taxonomy | purpose | +| `slug` | *Optional[str]* | :heavy_check_mark: | URL-friendly name for taxonomy | purpose | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/taxonomyclassification.md b/entity/docs/models/shared/taxonomyclassification.md index 3a7f5794f..42765826f 100755 --- a/entity/docs/models/shared/taxonomyclassification.md +++ b/entity/docs/models/shared/taxonomyclassification.md @@ -7,6 +7,6 @@ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | Wallbox PV | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | Wallbox PV | | `parents` | list[*str*] | :heavy_minus_sign: | N/A | | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/textattribute.md b/entity/docs/models/shared/textattribute.md index 32ce14b7e..eb600ae76 100755 --- a/entity/docs/models/shared/textattribute.md +++ b/entity/docs/models/shared/textattribute.md @@ -8,7 +8,7 @@ Textarea or text input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[TextAttributeConstraints]](../../models/shared/textattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.TextAttributeConstraints]](undefined/models/shared/textattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,11 +17,11 @@ Textarea or text input | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[TextAttributeInfoHelpers]](../../models/shared/textattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.TextAttributeInfoHelpers]](undefined/models/shared/textattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `multiline` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ Textarea or text input | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[TextAttributeType]](../../models/shared/textattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/textattributetype.md b/entity/docs/models/shared/textattributetype.md deleted file mode 100755 index 88054505a..000000000 --- a/entity/docs/models/shared/textattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# TextAttributeType - - -## Values - -| Name | Value | -| -------- | -------- | -| `STRING` | string | \ No newline at end of file diff --git a/entity/docs/models/shared/userrelationattribute.md b/entity/docs/models/shared/userrelationattribute.md index b21332cde..3afc9360f 100755 --- a/entity/docs/models/shared/userrelationattribute.md +++ b/entity/docs/models/shared/userrelationattribute.md @@ -8,7 +8,7 @@ User Relationship | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[UserRelationAttributeConstraints]](../../models/shared/userrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[shared.UserRelationAttributeConstraints]](undefined/models/shared/userrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,11 +17,11 @@ User Relationship | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[UserRelationAttributeInfoHelpers]](../../models/shared/userrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *str* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[shared.UserRelationAttributeInfoHelpers]](undefined/models/shared/userrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `multiple` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | +| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ User Relationship | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[UserRelationAttributeType]](../../models/shared/userrelationattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/userrelationattributetype.md b/entity/docs/models/shared/userrelationattributetype.md deleted file mode 100755 index 3cca95f1e..000000000 --- a/entity/docs/models/shared/userrelationattributetype.md +++ /dev/null @@ -1,8 +0,0 @@ -# UserRelationAttributeType - - -## Values - -| Name | Value | -| --------------- | --------------- | -| `RELATION_USER` | relation_user | \ No newline at end of file diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md index 16c968168..5e40848b2 100755 --- a/entity/docs/sdks/activity/README.md +++ b/entity/docs/sdks/activity/README.md @@ -30,7 +30,7 @@ s = epilot.Epilot( req = operations.AttachActivityRequest( entities=[ - 'cb739205-9293-496f-aa75-96eb10faaa23', + 'ee1dee63-2954-4671-8246-751c43fec091', ], id='01F130Q52Q6MWSNS8N2AVXV4JN', ) @@ -77,13 +77,13 @@ req = operations.CreateActivityRequest( activity=shared.Activity( message='{{caller}} did something with {{entity payload.entity.id}}.', payload={ - "corporis": 'explicabo', + "quo": 'apud', }, title='My custom activity', type='MyCustomActivity', ), entities=[ - 'c5955907-aff1-4a3a-afa9-467739251aa5', + '5acc1fe2-b8d1-4825-82f2-569c1faffc1b', ], ) @@ -123,8 +123,8 @@ s = epilot.Epilot( req = operations.GetActivityRequest( id='01F130Q52Q6MWSNS8N2AVXV4JN', - operations_from=138183, - operations_size=778346, + operations_from=826530, + operations_size=369963, ) res = s.activity.get_activity(req) @@ -164,12 +164,12 @@ s = epilot.Epilot( ) req = operations.GetEntityActivityFeedRequest( - after=dateutil.parser.isoparse('2022-01-19T09:45:27.272Z'), - before=dateutil.parser.isoparse('2022-05-04T04:15:52.352Z'), - from_=820994, - id='019da1ff-e78f-4097-b007-4f15471b5e6e', + after=dateutil.parser.isoparse('2022-01-31T23:44:31.870Z'), + before=dateutil.parser.isoparse('2022-09-19T15:43:08.281Z'), + from_=105040, + id='b83a9db1-edf0-4cb9-9bca-afe81677fcf9', include_relations=False, - size=64147, + size=41031, slug='contact', type='SyncActivity', ) diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 6ec9a1e55..22389310f 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -35,8 +35,8 @@ s = epilot.Epilot( req = operations.AutocompleteRequest( attribute='_tags', - input='ipsum', - size=692472, + input='Borders Netherlands benchmark', + size=180546, slug='contact', ) @@ -101,7 +101,7 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( request_body={ - "molestias": 'excepturi', + "qui": 'of', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, @@ -149,7 +149,7 @@ s = epilot.Epilot( req = operations.DeleteEntityRequest( activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - id='d488e1e9-1e45-40ad-aabd-44269802d502', + id='3b4a567a-853a-474f-8030-3350a9970542', slug='contact', ) @@ -252,7 +252,7 @@ s = epilot.Epilot( req = operations.GetEntityRequest( hydrate=False, - id='a94bb4f6-3c96-49e9-a3ef-a77dfb14cd66', + id='73700929-3a3f-4c9a-8a39-e5abedf44929', slug='contact', ) @@ -319,12 +319,12 @@ s = epilot.Epilot( req = operations.PatchEntityRequest( request_body={ - "laborum": 'accusamus', + "quod": 'illiterate', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, dry_run=False, - id='395efb9b-a88f-43a6-a997-074ba4469b6e', + id='dc474991-54f5-419d-9806-e999b72319d9', slug='contact', ) @@ -430,13 +430,13 @@ s = epilot.Epilot( req = shared.EntitySearchParams( aggs=shared.EntitySearchParamsAggs(), fields_=[ - 'aspernatur', + 'Web', ], - from_=102863, + from_=696536, hydrate=False, include_scores=False, q='_schema:contact AND status:active', - size=298282, + size=358975, sort='_created_at:desc', ) @@ -501,11 +501,11 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( request_body={ - "et": 'excepturi', + "sed": 'Pickup', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, - id='59890afa-563e-4251-afe4-c8b711e5b7fd', + id='17df5520-987b-4d5a-ab1d-12df74462a98', slug='contact', ) @@ -555,7 +555,7 @@ s = epilot.Epilot( req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( entity={ - "sed": 'saepe', + "et": 'optical', }, unique_key=[ 'email.0.email', diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md index c8e9f6c8e..d30e1095d 100755 --- a/entity/docs/sdks/export/README.md +++ b/entity/docs/sdks/export/README.md @@ -29,18 +29,18 @@ req = operations.ExportEntitiesRequest( entity_search_params=shared.EntitySearchParams( aggs=shared.EntitySearchParamsAggs(), fields_=[ - 'pariatur', + 'Northwest', ], - from_=37559, + from_=577630, hydrate=False, include_scores=False, q='_schema:contact AND status:active', - size=162493, + size=727282, sort='_created_at:desc', ), is_template=False, job_id='abc123', - language='praesentium', + language='Electronic', ) res = s.export.export_entities(req) diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index 1177d9fdd..f4d9aa05f 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -33,16 +33,16 @@ req = operations.AddRelationsRequest( request_body=[ shared.RelationItem( tags=[ - 'natus', + 'Forward', ], - attribute='magni', - entity_id='1cddc692-601f-4b57-ab0d-5f0d30c5fbb2', + attribute='Swedish Hatchback Luxurious', + entity_id='9248b564-99df-4660-9593-cfe3d006d87e', reverse=False, ), ], activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, - id='58705320-2c73-4d5f-a9b9-0c28909b3fe4', + id='69d98cd0-9bf6-4d30-b52c-36108777da47', slug='contact', ) @@ -83,9 +83,9 @@ s = epilot.Epilot( req = operations.DeleteRelationRequest( activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, - attribute='iste', - entity_id='dolorum', - id='8d9cbf48-6333-423f-9b77-f3a4100674eb', + attribute='whiteboard sandal', + entity_id='quasi South Southeast', + id='f5b77b85-5b9c-4585-b7ae-4d21f6044e25', slug='contact', ) @@ -130,7 +130,7 @@ s = epilot.Epilot( req = operations.GetRelationsRequest( hydrate=False, - id='f69280d1-ba77-4a89-abf7-37ae4203ce5e', + id='e642d6bf-f2f7-41f9-8aa4-db0ec78f30e6', include_reverse=False, slug='contact', ) @@ -176,14 +176,14 @@ s = epilot.Epilot( req = operations.GetRelationsV2Request( fields_=[ - 'suscipit', + 'up', ], - from_=645785, + from_=117939, hydrate=False, - id='95d8a0d4-46ce-42af-ba73-cf3be453f870', + id='2f3e8dbd-dd40-4ecc-a3e0-01b2fb330d42', include_reverse=False, - query='expedita', - size=207470, + query='THX iterate', + size=534143, slug='contact', ) @@ -224,14 +224,14 @@ s = epilot.Epilot( req = operations.UpdateRelationRequest( request_body=operations.UpdateRelationRequestBody( tags=[ - 'sed', + 'Androgyne', ], ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', async_=False, - attribute='vel', - entity_id='libero', - id='5a73429c-db1a-4842-abb6-79d2322715bf', + attribute='imperturbable female during', + entity_id='HDD Gasoline', + id='3b01c385-4f8c-44b2-a614-3d8a0d332324', slug='contact', ) diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index 0972cd3ca..9ede30910 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -42,7 +42,7 @@ req = shared.SavedView( 'contact', ], ui_config={ - "voluptatem": 'cumque', + "eos": 'Cyclocross', }, ) @@ -81,7 +81,7 @@ s = epilot.Epilot( ) req = operations.DeleteSavedViewRequest( - id='bb1e31b8-b90f-4344-ba11-08e0adcf4b92', + id='59eccd11-7c56-46ef-bb90-41cbc04178cc', ) res = s.saved_views.delete_saved_view(req) @@ -119,7 +119,7 @@ s = epilot.Epilot( ) req = operations.GetSavedViewRequest( - id='1879fce9-53f7-43ef-bfbc-7abd74dd39c0', + id='638188cd-8a1e-442e-95b2-8864469eafc5', ) res = s.saved_views.get_saved_view(req) @@ -227,10 +227,10 @@ req = operations.UpdateSavedViewRequest( 'contact', ], ui_config={ - "voluptatibus": 'exercitationem', + "aut": 'red', }, ), - id='d2cff7c7-0a45-4626-9436-813f16d9f5fc', + id='3092cd47-8166-44df-95b0-841d72e4e501', ) res = s.saved_views.update_saved_view(req) diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index 056863b0f..f00d1239c 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -70,7 +70,7 @@ s = epilot.Epilot( ) req = operations.GetSchemaRequest( - id='e6c55614-6c3e-4250-bb00-8c42e141aac3', + id='3bcef047-7721-42cd-8bca-92e24545d526', slug='contact', ) @@ -109,11 +109,11 @@ s = epilot.Epilot( ) req = operations.GetSchemaVersionsRequest( - drafts_from=4321.48, - drafts_size=4205.39, + drafts_from=8135.81, + drafts_size=8621.33, slug='contact', - versions_from=7521.35, - versions_size=5573.69, + versions_from=8101.78, + versions_size=8257.35, ) res = s.schemas.get_schema_versions(req) @@ -218,8 +218,8 @@ s = epilot.Epilot( ) req = operations.ListTaxonomyClassificationsForSchemaRequest( - query='assumenda', - size=8605.52, + query='Gasoline Torrance tesla', + size=8668.67, slug='contact', taxonomy_slug='purpose', ) @@ -264,11 +264,11 @@ req = operations.PutSchemaRequest( attributes=[ [], ], - blueprint='6b144290-7474-4778-a7bd-466d28c10ab3', + blueprint='a93c7b74-037c-43b9-94a9-6166aa0e2336', capabilities=[ shared.EntityCapability( purpose=[ - 'cdca4251-904e-4523-87e0-bc7178e4796f', + '535d6bf8-fcc1-4de0-b32d-65715210cf50', ], attributes=[ [], @@ -280,49 +280,49 @@ req = operations.PutSchemaRequest( title='Messaging', ui_hooks=[ { - "dolores": 'deserunt', + "modi": 'Home', }, ], ), ], dialog_config={ - "molestiae": 'accusantium', + "eveniet": 'Strategist', }, draft=False, enable_setting=[ '360_features', ], explicit_search_mappings={ - "porro": shared.SearchMappings( + "vel": shared.SearchMappings( fields_={ - "eum": 'quas', + "distinctio": 'warmly', }, index=False, - type=shared.SearchMappingsType.LONG, + type=shared.SearchMappingsType.TEXT, ), }, feature_flag='FF_MY_FEATURE_FLAG', group_settings=[ shared.EntitySchemaGroupSettings( purpose=[ - '282aa482-562f-4222-a981-7ee17cbe61e6', + '0dd287b6-15b3-4e0e-a8c6-d1668543e4eb', ], expanded=False, feature_flag='FF_MY_FEATURE_FLAG', - id='b7b95bc0-ab3c-420c-8f37-89fd871f99dd', + id='', info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( - default='quia', - key='eveniet', + default='Wooden', + key='', ), - label='asperiores', - order=815524, + label='deposit Pakistan XSS', + order=834474, render_condition='_is_composite_price = "false"', setting_flag='MY_SETTING', ), ], icon='person', layout_settings={ - "veritatis": 'consequuntur', + "aut": 'protocol', }, name='Contact', plural='Contacts', @@ -343,7 +343,7 @@ req = operations.PutSchemaRequest( single_view=[], table_view=[], ), - version=94458, + version=784166, ), draft=False, slug='contact', diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index d4370e4f8..cf0efc2ea 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -99,10 +99,10 @@ s = epilot.Epilot( req = operations.TaxonomiesClassificationsSearchRequest( request_body=operations.TaxonomiesClassificationsSearchRequestBody( classification_ids=[ - 'aa6f1e67-4bdb-404f-9575-6082d68ea19f', + '140d9b86-5e3a-4ede-b609-1ca17c7aaeae', ], ), - taxonomy_slug='quasi', + taxonomy_slug='Oklahoma azure illum', ) res = s.taxonomy.taxonomies_classifications_search(req) @@ -140,9 +140,9 @@ s = epilot.Epilot( ) req = operations.TaxonomyAutocompleteRequest( - query='at', - size=920.27, - taxonomy_slug='voluptate', + query='Polarised optio Hybrid', + size=7186.02, + taxonomy_slug='Ball', ) res = s.taxonomy.taxonomy_autocomplete(req) @@ -184,31 +184,31 @@ req = operations.UpdateClassificationsForTaxonomyRequest( classifications_update=shared.ClassificationsUpdate( create=[ shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2022-09-03T18:06:00.164Z'), - id='1339d080-86a1-4840-b94c-26071f93f5f0', + created_at=dateutil.parser.isoparse('2023-01-29T09:39:45.161Z'), + id='4e342f29-dee0-402b-8415-ef6fe03f06e9', name='Wallbox PV', parents=[ - '642dac7a-f515-4cc4-93aa-63aae8d67864', + '998bd322-c31e-42b7-b181-91a2c6ad60b4', ], - updated_at=dateutil.parser.isoparse('2020-11-18T07:12:59.777Z'), + updated_at=dateutil.parser.isoparse('2021-07-20T21:22:16.417Z'), ), ], delete=[ - 'b675fd5e-60b3-475e-94f6-fbee41f33317', + '062aff2d-f8b9-4512-81f6-8f95bbd35ce8', ], update=[ shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2020-04-29T18:47:01.945Z'), - id='35b60eb1-ea42-4655-9ba3-c28744ed53b8', + created_at=dateutil.parser.isoparse('2023-06-17T13:37:21.887Z'), + id='b159c7e2-9866-4889-9ce5-7236fb33115f', name='Wallbox PV', parents=[ - '8f3a8d8f-5c0b-42f2-bb7b-194a276b2691', + 'c5f1737e-932d-42ff-8b5b-7733cd73fa8c', ], - updated_at=dateutil.parser.isoparse('2022-01-15T12:09:02.064Z'), + updated_at=dateutil.parser.isoparse('2021-03-21T21:08:25.425Z'), ), ], ), - taxonomy_slug='debitis', + taxonomy_slug='flexibility Cadillac North', ) res = s.taxonomy.update_classifications_for_taxonomy(req) diff --git a/entity/files.gen b/entity/files.gen index a4765dd2a..8d5cf9abb 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -230,26 +230,19 @@ docs/models/shared/entityschemaitemuiconfigsingleview.md docs/models/shared/entityschemaitemuiconfigtableview.md docs/models/shared/entityschemaitemuiconfig.md docs/models/shared/entityschemaitem.md -docs/models/shared/entitydefaulttabledropdownitems2type.md docs/models/shared/entitydefaulttabledropdownitems2.md -docs/models/shared/entitydefaulttabledropdownitems1type.md docs/models/shared/entitydefaulttabledropdownitems1.md docs/models/shared/entitydefaulttabledropdownitems.md docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md docs/models/shared/entitydefaulttablenavbaractionsoptions.md docs/models/shared/entitydefaulttablenavbaractions.md -docs/models/shared/entitydefaulttableviewtype.md docs/models/shared/entitydefaulttable.md -docs/models/shared/redirectentityviewviewtype.md docs/models/shared/redirectentityview.md -docs/models/shared/entityviewdisabledviewtype.md docs/models/shared/entityviewdisabled.md docs/models/shared/entitydefaultedittablemenuoptions.md -docs/models/shared/entitydefaulteditviewtype.md docs/models/shared/entitydefaultedit.md docs/models/shared/summaryattribute.md docs/models/shared/entitydefaultcreatetablemenuoptions.md -docs/models/shared/entitydefaultcreateviewtype.md docs/models/shared/entitydefaultcreate.md docs/models/shared/searchmappingstype.md docs/models/shared/searchmappings.md @@ -257,11 +250,9 @@ docs/models/shared/entitycapability.md docs/models/shared/attribute.md docs/models/shared/textattributeconstraints.md docs/models/shared/textattributeinfohelpers.md -docs/models/shared/textattributetype.md docs/models/shared/textattribute.md docs/models/shared/linkattributeconstraints.md docs/models/shared/linkattributeinfohelpers.md -docs/models/shared/linkattributetype.md docs/models/shared/linkattribute.md docs/models/shared/dateattributeconstraints.md docs/models/shared/dateattributeinfohelpers.md @@ -269,11 +260,9 @@ docs/models/shared/dateattributetype.md docs/models/shared/dateattribute.md docs/models/shared/countryattributeconstraints.md docs/models/shared/countryattributeinfohelpers.md -docs/models/shared/countryattributetype.md docs/models/shared/countryattribute.md docs/models/shared/booleanattributeconstraints.md docs/models/shared/booleanattributeinfohelpers.md -docs/models/shared/booleanattributetype.md docs/models/shared/booleanattribute.md docs/models/shared/selectattributeconstraints.md docs/models/shared/selectattributeinfohelpers.md @@ -291,40 +280,32 @@ docs/models/shared/statusattributeconstraints.md docs/models/shared/statusattributeinfohelpers.md docs/models/shared/statusattributeoptions2.md docs/models/shared/statusattributeoptions.md -docs/models/shared/statusattributetype.md docs/models/shared/statusattribute.md docs/models/shared/sequenceattributeconstraints.md docs/models/shared/sequenceattributeinfohelpers.md -docs/models/shared/sequenceattributetype.md docs/models/shared/sequenceattribute.md docs/models/shared/relationattributeactionsactiontype.md docs/models/shared/relationattributeactions.md docs/models/shared/relationattributeconstraints.md docs/models/shared/relationattributedrawersize.md -docs/models/shared/relationattributeeditmode.md docs/models/shared/relationattributeinfohelpers.md docs/models/shared/relationattributerelationaffinitymode.md docs/models/shared/relationattributerelationtype.md docs/models/shared/relationattributesummaryfields.md -docs/models/shared/relationattributetype.md docs/models/shared/relationattribute.md docs/models/shared/summaryfield.md docs/models/shared/userrelationattributeconstraints.md docs/models/shared/userrelationattributeinfohelpers.md -docs/models/shared/userrelationattributetype.md docs/models/shared/userrelationattribute.md docs/models/shared/addressrelationattributeconstraints.md docs/models/shared/addressrelationattributeinfohelpers.md -docs/models/shared/addressrelationattributetype.md docs/models/shared/addressrelationattribute.md docs/models/shared/paymentmethodrelationattributeconstraints.md docs/models/shared/paymentmethodrelationattributeinfohelpers.md -docs/models/shared/paymentmethodrelationattributetype.md docs/models/shared/paymentmethodrelationattribute.md docs/models/shared/currencyattributeconstraints.md docs/models/shared/currencyattributecurrency.md docs/models/shared/currencyattributeinfohelpers.md -docs/models/shared/currencyattributetype.md docs/models/shared/currencyattribute.md docs/models/shared/repeatableattributeconstraints.md docs/models/shared/repeatableattributeinfohelpers.md @@ -333,23 +314,18 @@ docs/models/shared/repeatableattributetype.md docs/models/shared/repeatableattribute.md docs/models/shared/tagsattributeconstraints.md docs/models/shared/tagsattributeinfohelpers.md -docs/models/shared/tagsattributetype.md docs/models/shared/tagsattribute.md docs/models/shared/numberattributeconstraints.md docs/models/shared/numberattributeinfohelpers.md -docs/models/shared/numberattributetype.md docs/models/shared/numberattribute.md docs/models/shared/consentattributeconstraints.md docs/models/shared/consentattributeinfohelpers.md -docs/models/shared/consentattributetype.md docs/models/shared/consentattribute.md docs/models/shared/internalattributeconstraints.md docs/models/shared/internalattributeinfohelpers.md -docs/models/shared/internalattributetype.md docs/models/shared/internalattribute.md docs/models/shared/orderedlistattributeconstraints.md docs/models/shared/orderedlistattributeinfohelpers.md -docs/models/shared/orderedlistattributetype.md docs/models/shared/orderedlistattribute.md docs/models/shared/fileattributeconstraints.md docs/models/shared/fileattributedefaultaccesscontrol.md @@ -358,31 +334,24 @@ docs/models/shared/fileattributetype.md docs/models/shared/fileattribute.md docs/models/shared/computedattributeconstraints.md docs/models/shared/computedattributeinfohelpers.md -docs/models/shared/computedattributetype.md docs/models/shared/computedattribute.md docs/models/shared/partnerstatusattributeconstraints.md docs/models/shared/partnerstatusattributeinfohelpers.md -docs/models/shared/partnerstatusattributetype.md docs/models/shared/partnerstatusattribute.md docs/models/shared/invitationemailattributeconstraints.md docs/models/shared/invitationemailattributeinfohelpers.md -docs/models/shared/invitationemailattributetype.md docs/models/shared/invitationemailattribute.md docs/models/shared/automationattributeconstraints.md docs/models/shared/automationattributeinfohelpers.md -docs/models/shared/automationattributetype.md docs/models/shared/automationattribute.md docs/models/shared/internaluserattributeconstraints.md docs/models/shared/internaluserattributeinfohelpers.md -docs/models/shared/internaluserattributetype.md docs/models/shared/internaluserattribute.md docs/models/shared/purposeattributeconstraints.md docs/models/shared/purposeattributeinfohelpers.md -docs/models/shared/purposeattributetype.md docs/models/shared/purposeattribute.md docs/models/shared/partnerorganisationattributeconstraints.md docs/models/shared/partnerorganisationattributeinfohelpers.md -docs/models/shared/partnerorganisationattributetype.md docs/models/shared/partnerorganisationattribute.md docs/models/shared/taxonomyclassification.md docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md diff --git a/entity/gen.yaml b/entity/gen.yaml index c9e69902f..0909e6d4f 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: 285059cd6a6b4ebb4b50059166100555 docVersion: 1.0.0 - speakeasyVersion: 1.91.2 - generationVersion: 2.131.1 + speakeasyVersion: 1.91.3 + generationVersion: 2.139.1 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.86.1 + core: 2.87.0 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.24.1 + version: 1.25.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/pylintrc b/entity/pylintrc index 7dfa89ef2..ca6869cfb 100755 --- a/entity/pylintrc +++ b/entity/pylintrc @@ -116,12 +116,12 @@ argument-naming-style=snake_case #argument-rgx= # Naming style matching correct attribute names. -attr-naming-style=snake_case +#attr-naming-style=snake_case # Regular expression matching correct attribute names. Overrides attr-naming- # style. If left empty, attribute names will be checked with the set naming # style. -#attr-rgx= +attr-rgx=[^\W\d][^\W]*|__.*__$ # Bad variable names which should always be refused, separated by a comma. bad-names= diff --git a/entity/setup.py b/entity/setup.py index 8ba234d33..4ff6b7648 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.24.1", + version="1.25.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/activity.py b/entity/src/epilot/activity.py index 60a09333e..9576d649f 100755 --- a/entity/src/epilot/activity.py +++ b/entity/src/epilot/activity.py @@ -23,7 +23,7 @@ def attach_activity(self, request: operations.AttachActivityRequest) -> operatio headers = {} query_params = utils.get_query_params(operations.AttachActivityRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -53,12 +53,12 @@ def create_activity(self, request: operations.CreateActivityRequest) -> operatio url = base_url + '/v1/entity/activity' headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "activity", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "activity", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateActivityRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -87,7 +87,7 @@ def get_activity(self, request: operations.GetActivityRequest) -> operations.Get headers = {} query_params = utils.get_query_params(operations.GetActivityRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -116,7 +116,7 @@ def get_entity_activity_feed(self, request: operations.GetEntityActivityFeedRequ headers = {} query_params = utils.get_query_params(operations.GetEntityActivityFeedRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client diff --git a/entity/src/epilot/entities.py b/entity/src/epilot/entities.py index df189e55f..169466cb2 100755 --- a/entity/src/epilot/entities.py +++ b/entity/src/epilot/entities.py @@ -28,7 +28,7 @@ def autocomplete(self, request: operations.AutocompleteRequest) -> operations.Au headers = {} query_params = utils.get_query_params(operations.AutocompleteRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -79,12 +79,12 @@ def create_entity(self, request: operations.CreateEntityRequest) -> operations.C url = utils.generate_url(operations.CreateEntityRequest, base_url, '/v1/entity/{slug}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateEntityRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -117,7 +117,7 @@ def delete_entity(self, request: operations.DeleteEntityRequest) -> operations.D headers = {} query_params = utils.get_query_params(operations.DeleteEntityRequest, request) headers['Accept'] = '*/*' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -202,7 +202,7 @@ def get_entity(self, request: operations.GetEntityRequest) -> operations.GetEnti headers = {} query_params = utils.get_query_params(operations.GetEntityRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -255,14 +255,14 @@ def patch_entity(self, request: operations.PatchEntityRequest) -> operations.Pat url = utils.generate_url(operations.PatchEntityRequest, base_url, '/v1/entity/{slug}/{id}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, False, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type if data is None and form is None: raise Exception('request body is required') query_params = utils.get_query_params(operations.PatchEntityRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -355,14 +355,14 @@ def search_entities(self, request: shared.EntitySearchParams, accept_header_over url = base_url + '/v1/entity:search' headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type if accept_header_override is not None: headers['Accept'] = accept_header_override.value else: headers['Accept'] = 'application/json;q=1, text/csv;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -415,12 +415,12 @@ def update_entity(self, request: operations.UpdateEntityRequest) -> operations.U url = utils.generate_url(operations.UpdateEntityRequest, base_url, '/v1/entity/{slug}/{id}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.UpdateEntityRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -455,12 +455,12 @@ def upsert_entity(self, request: operations.UpsertEntityRequest) -> operations.U url = utils.generate_url(operations.UpsertEntityRequest, base_url, '/v1/entity/{slug}:upsert', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.UpsertEntityRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client diff --git a/entity/src/epilot/entity_import.py b/entity/src/epilot/entity_import.py index 8e7f93f30..48f5bde5a 100755 --- a/entity/src/epilot/entity_import.py +++ b/entity/src/epilot/entity_import.py @@ -21,12 +21,12 @@ def import_entities(self, request: operations.ImportEntitiesRequest) -> operatio url = base_url + '/v1/entity:import' headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "entity_import_params", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "entity_import_params", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.ImportEntitiesRequest, request) headers['Accept'] = '*/*' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client diff --git a/entity/src/epilot/export.py b/entity/src/epilot/export.py index fda5b8a66..09d39e324 100755 --- a/entity/src/epilot/export.py +++ b/entity/src/epilot/export.py @@ -20,12 +20,12 @@ def export_entities(self, request: operations.ExportEntitiesRequest) -> operatio url = base_url + '/v1/entity:export' headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "entity_search_params", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "entity_search_params", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.ExportEntitiesRequest, request) headers['Accept'] = '*/*' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client diff --git a/entity/src/epilot/models/operations/addrelations.py b/entity/src/epilot/models/operations/addrelations.py index 8d0787ea1..bd7952772 100755 --- a/entity/src/epilot/models/operations/addrelations.py +++ b/entity/src/epilot/models/operations/addrelations.py @@ -16,7 +16,7 @@ class AddRelationsRequest: r"""Entity Type""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) r"""Activity to include in event feed""" - async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) + async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" request_body: Optional[list[shared_relationitem.RelationItem]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) diff --git a/entity/src/epilot/models/operations/autocomplete.py b/entity/src/epilot/models/operations/autocomplete.py index 43692f560..b6bbdd495 100755 --- a/entity/src/epilot/models/operations/autocomplete.py +++ b/entity/src/epilot/models/operations/autocomplete.py @@ -15,7 +15,7 @@ class AutocompleteRequest: r"""Autocomplete attribute""" input: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'input', 'style': 'form', 'explode': True }}) r"""Input to autocomplete""" - size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) + size: Optional[int] = dataclasses.field(default=10, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) r"""Maximum number of results to return""" slug: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'slug', 'style': 'form', 'explode': True }}) r"""Limit results to entity schema""" diff --git a/entity/src/epilot/models/operations/createentity.py b/entity/src/epilot/models/operations/createentity.py index 2fff05f82..519a0283e 100755 --- a/entity/src/epilot/models/operations/createentity.py +++ b/entity/src/epilot/models/operations/createentity.py @@ -13,7 +13,7 @@ class CreateEntityRequest: r"""Entity Schema""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) r"""Activity to include in event feed""" - async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) + async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" request_body: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) diff --git a/entity/src/epilot/models/operations/deleterelation.py b/entity/src/epilot/models/operations/deleterelation.py index 34f2aabc5..085b7707b 100755 --- a/entity/src/epilot/models/operations/deleterelation.py +++ b/entity/src/epilot/models/operations/deleterelation.py @@ -19,7 +19,7 @@ class DeleteRelationRequest: r"""Entity Type""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) r"""Activity to include in event feed""" - async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) + async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" diff --git a/entity/src/epilot/models/operations/getactivity.py b/entity/src/epilot/models/operations/getactivity.py index 1b5cdd6cb..650c72b7e 100755 --- a/entity/src/epilot/models/operations/getactivity.py +++ b/entity/src/epilot/models/operations/getactivity.py @@ -12,9 +12,9 @@ class GetActivityRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Activity Id""" - operations_from: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'operations_from', 'style': 'form', 'explode': True }}) + operations_from: Optional[int] = dataclasses.field(default=0, metadata={'query_param': { 'field_name': 'operations_from', 'style': 'form', 'explode': True }}) r"""Pagination offset for operations""" - operations_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'operations_size', 'style': 'form', 'explode': True }}) + operations_size: Optional[int] = dataclasses.field(default=25, metadata={'query_param': { 'field_name': 'operations_size', 'style': 'form', 'explode': True }}) r"""Maximum number of operations to include in response (default: 10)""" diff --git a/entity/src/epilot/models/operations/getentity.py b/entity/src/epilot/models/operations/getentity.py index 43024d5f3..4c05c6c24 100755 --- a/entity/src/epilot/models/operations/getentity.py +++ b/entity/src/epilot/models/operations/getentity.py @@ -15,7 +15,7 @@ class GetEntityRequest: r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Type""" - hydrate: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) + hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) r"""When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.""" diff --git a/entity/src/epilot/models/operations/getentityactivityfeed.py b/entity/src/epilot/models/operations/getentityactivityfeed.py index e50ca028f..11e3133d2 100755 --- a/entity/src/epilot/models/operations/getentityactivityfeed.py +++ b/entity/src/epilot/models/operations/getentityactivityfeed.py @@ -21,11 +21,11 @@ class GetEntityActivityFeedRequest: r"""Get activities after this timestamp""" before: Optional[datetime] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'before', 'style': 'form', 'explode': True }}) r"""get activities before this timestamp""" - from_: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) + from_: Optional[int] = dataclasses.field(default=0, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) r"""start from page""" - include_relations: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'include_relations', 'style': 'form', 'explode': True }}) + include_relations: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'include_relations', 'style': 'form', 'explode': True }}) r"""Include activities from related entities""" - size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) + size: Optional[int] = dataclasses.field(default=25, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) r"""max number of results to return""" type: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'type', 'style': 'form', 'explode': True }}) r"""Filter by activity type""" diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py index 3c62fa20c..708c2a5dc 100755 --- a/entity/src/epilot/models/operations/getrelations.py +++ b/entity/src/epilot/models/operations/getrelations.py @@ -14,9 +14,9 @@ class GetRelationsRequest: r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Type""" - hydrate: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) + hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) r"""When true, expand relation items with full blown entities.""" - include_reverse: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) + include_reverse: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) r"""When true, includes reverse relations in response (other entities pointing to this entity)""" diff --git a/entity/src/epilot/models/operations/getrelationsv2.py b/entity/src/epilot/models/operations/getrelationsv2.py index 2f9c713fe..22f512084 100755 --- a/entity/src/epilot/models/operations/getrelationsv2.py +++ b/entity/src/epilot/models/operations/getrelationsv2.py @@ -16,15 +16,15 @@ class GetRelationsV2Request: r"""Entity Type""" fields_: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': True }}) r"""List of entity fields to include in results""" - from_: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) + from_: Optional[int] = dataclasses.field(default=0, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) r"""Starting page number""" - hydrate: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) + hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) r"""When true, expand relation items with full blown entities.""" - include_reverse: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) + include_reverse: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) r"""When true, includes reverse relations in response (other entities pointing to this entity)""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Input to filter search results""" - size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) + size: Optional[int] = dataclasses.field(default=50, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) r"""Number of results to return per page""" diff --git a/entity/src/epilot/models/operations/listschemas.py b/entity/src/epilot/models/operations/listschemas.py index 61fdf4566..adbc1c515 100755 --- a/entity/src/epilot/models/operations/listschemas.py +++ b/entity/src/epilot/models/operations/listschemas.py @@ -12,7 +12,7 @@ @dataclasses.dataclass class ListSchemasRequest: - unpublished: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'unpublished', 'style': 'form', 'explode': True }}) + unpublished: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'unpublished', 'style': 'form', 'explode': True }}) r"""Return unpublished draft schemas""" diff --git a/entity/src/epilot/models/operations/patchentity.py b/entity/src/epilot/models/operations/patchentity.py index 6ae20adaa..7031fb9d6 100755 --- a/entity/src/epilot/models/operations/patchentity.py +++ b/entity/src/epilot/models/operations/patchentity.py @@ -16,9 +16,9 @@ class PatchEntityRequest: r"""Entity Schema""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) r"""Activity to include in event feed""" - async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) + async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for the patch entity to become available in Search API. Useful for large migrations""" - dry_run: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'dry_run', 'style': 'form', 'explode': True }}) + dry_run: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'dry_run', 'style': 'form', 'explode': True }}) r"""Dry Run mode = returns the patch result but doesn't perform the patch.""" diff --git a/entity/src/epilot/models/operations/putschema.py b/entity/src/epilot/models/operations/putschema.py index f01e25b32..7f52ff823 100755 --- a/entity/src/epilot/models/operations/putschema.py +++ b/entity/src/epilot/models/operations/putschema.py @@ -12,7 +12,7 @@ @dataclasses.dataclass class PutSchemaRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - draft: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'draft', 'style': 'form', 'explode': True }}) + draft: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'draft', 'style': 'form', 'explode': True }}) entity_schema: Optional[shared_entityschema.EntitySchema] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) diff --git a/entity/src/epilot/models/operations/updateentity.py b/entity/src/epilot/models/operations/updateentity.py index 6492e595d..1f63f1cf0 100755 --- a/entity/src/epilot/models/operations/updateentity.py +++ b/entity/src/epilot/models/operations/updateentity.py @@ -15,7 +15,7 @@ class UpdateEntityRequest: r"""Entity Type""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) r"""Activity to include in event feed""" - async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) + async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" request_body: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) diff --git a/entity/src/epilot/models/operations/updaterelation.py b/entity/src/epilot/models/operations/updaterelation.py index 3b1a30250..4907290c7 100755 --- a/entity/src/epilot/models/operations/updaterelation.py +++ b/entity/src/epilot/models/operations/updaterelation.py @@ -31,7 +31,7 @@ class UpdateRelationRequest: r"""Entity Type""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) r"""Activity to include in event feed""" - async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) + async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" request_body: Optional[UpdateRelationRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) diff --git a/entity/src/epilot/models/operations/upsertentity.py b/entity/src/epilot/models/operations/upsertentity.py index e9722a2e9..5c999f6e6 100755 --- a/entity/src/epilot/models/operations/upsertentity.py +++ b/entity/src/epilot/models/operations/upsertentity.py @@ -25,9 +25,9 @@ class UpsertEntityRequest: r"""Entity Schema""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) r"""Activity to include in event feed""" - async_: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) + async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" - dry_run: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'dry_run', 'style': 'form', 'explode': True }}) + dry_run: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'dry_run', 'style': 'form', 'explode': True }}) r"""Dry Run mode = return matched entities but don't update them.""" request_body: Optional[UpsertEntityRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index a686402ca..de05f354b 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -54,4 +54,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] +__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeInfoHelpers","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems2","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","RedirectEntityView","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers"] diff --git a/entity/src/epilot/models/shared/addressrelationattribute.py b/entity/src/epilot/models/shared/addressrelationattribute.py index 17d57de4e..1fe3bda63 100755 --- a/entity/src/epilot/models/shared/addressrelationattribute.py +++ b/entity/src/epilot/models/shared/addressrelationattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class AddressRelationAttributeInfoHelpers: -class AddressRelationAttributeType(str, Enum): - RELATION_ADDRESS = 'relation_address' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,15 +56,15 @@ class AddressRelationAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -83,22 +79,22 @@ class AddressRelationAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[AddressRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='relation_address', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/automationattribute.py b/entity/src/epilot/models/shared/automationattribute.py index 5472119aa..5b41ea074 100755 --- a/entity/src/epilot/models/shared/automationattribute.py +++ b/entity/src/epilot/models/shared/automationattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class AutomationAttributeInfoHelpers: -class AutomationAttributeType(str, Enum): - AUTOMATION = 'automation' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class AutomationAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class AutomationAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[AutomationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='automation', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/booleanattribute.py b/entity/src/epilot/models/shared/booleanattribute.py index a65d940c8..916037ed2 100755 --- a/entity/src/epilot/models/shared/booleanattribute.py +++ b/entity/src/epilot/models/shared/booleanattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class BooleanAttributeInfoHelpers: -class BooleanAttributeType(str, Enum): - BOOLEAN = 'boolean' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class BooleanAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class BooleanAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[BooleanAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='boolean', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/computedattribute.py b/entity/src/epilot/models/shared/computedattribute.py index 9a27b6dd0..f2bf253ab 100755 --- a/entity/src/epilot/models/shared/computedattribute.py +++ b/entity/src/epilot/models/shared/computedattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class ComputedAttributeInfoHelpers: -class ComputedAttributeType(str, Enum): - COMPUTED = 'computed' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class ComputedAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class ComputedAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[ComputedAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='computed', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/consentattribute.py b/entity/src/epilot/models/shared/consentattribute.py index 7e4ab58dc..0c3d6da3a 100755 --- a/entity/src/epilot/models/shared/consentattribute.py +++ b/entity/src/epilot/models/shared/consentattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class ConsentAttributeInfoHelpers: -class ConsentAttributeType(str, Enum): - CONSENT = 'consent' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -55,21 +51,21 @@ class ConsentAttribute: label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) topic: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('topic') }}) - type: ConsentAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + TYPE: Final[str] = dataclasses.field(default='consent', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[ConsentAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -85,20 +81,20 @@ class ConsentAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/countryattribute.py b/entity/src/epilot/models/shared/countryattribute.py index 95d493287..a84be9938 100755 --- a/entity/src/epilot/models/shared/countryattribute.py +++ b/entity/src/epilot/models/shared/countryattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class CountryAttributeInfoHelpers: -class CountryAttributeType(str, Enum): - COUNTRY = 'country' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class CountryAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class CountryAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[CountryAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='country', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/currencyattribute.py b/entity/src/epilot/models/shared/currencyattribute.py index 8715bbd24..8f0686ba7 100755 --- a/entity/src/epilot/models/shared/currencyattribute.py +++ b/entity/src/epilot/models/shared/currencyattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -56,9 +55,6 @@ class CurrencyAttributeInfoHelpers: -class CurrencyAttributeType(str, Enum): - CURRENCY = 'currency' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -69,22 +65,22 @@ class CurrencyAttribute: r"""An array of currency configurations with a country code (ISO-4217)""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - type: CurrencyAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + TYPE: Final[str] = dataclasses.field(default='currency', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[CurrencyAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ - currency_selector_only: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency_selector_only'), 'exclude': lambda f: f is None }}) + currency_selector_only: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency_selector_only'), 'exclude': lambda f: f is None }}) default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -99,20 +95,20 @@ class CurrencyAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/dateattribute.py b/entity/src/epilot/models/shared/dateattribute.py index b556f3323..aa76b10e4 100755 --- a/entity/src/epilot/models/shared/dateattribute.py +++ b/entity/src/epilot/models/shared/dateattribute.py @@ -61,14 +61,14 @@ class DateAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -83,20 +83,20 @@ class DateAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[DateAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaultcreate.py b/entity/src/epilot/models/shared/entitydefaultcreate.py index 001572853..bd6d27c43 100755 --- a/entity/src/epilot/models/shared/entitydefaultcreate.py +++ b/entity/src/epilot/models/shared/entitydefaultcreate.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Optional +from typing import Final, Optional @dataclass_json(undefined=Undefined.EXCLUDE) @@ -17,9 +16,6 @@ class EntityDefaultCreateTableMenuOptions: -class EntityDefaultCreateViewType(str, Enum): - DEFAULT = 'default' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -27,6 +23,6 @@ class EntityDefaultCreateViewType(str, Enum): class EntityDefaultCreate: search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) table_menu_options: Optional[EntityDefaultCreateTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) - view_type: Optional[EntityDefaultCreateViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + VIEW_TYPE: Final[Optional[str]] = dataclasses.field(default='default', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaultedit.py b/entity/src/epilot/models/shared/entitydefaultedit.py index 0538a7bcc..402bb350b 100755 --- a/entity/src/epilot/models/shared/entitydefaultedit.py +++ b/entity/src/epilot/models/shared/entitydefaultedit.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Optional +from typing import Final, Optional @dataclass_json(undefined=Undefined.EXCLUDE) @@ -17,9 +16,6 @@ class EntityDefaultEditTableMenuOptions: -class EntityDefaultEditViewType(str, Enum): - DEFAULT = 'default' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -29,6 +25,6 @@ class EntityDefaultEdit: summary_attributes: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) r"""List of attribute names that we show in the summary header""" table_menu_options: Optional[EntityDefaultEditTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) - view_type: Optional[EntityDefaultEditViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + VIEW_TYPE: Final[Optional[str]] = dataclasses.field(default='default', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py index a53db2f75..d1fe9a16a 100755 --- a/entity/src/epilot/models/shared/entitydefaulttable.py +++ b/entity/src/epilot/models/shared/entitydefaulttable.py @@ -3,12 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Optional, Union - -class EntityDefaultTableDropdownItems2Type(str, Enum): - LINK = 'link' +from typing import Final, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) @@ -20,14 +16,11 @@ class EntityDefaultTableDropdownItems2: legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) r"""Only show item for legacy tenants (ivy)""" title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) - type: Optional[EntityDefaultTableDropdownItems2Type] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='link', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('uri'), 'exclude': lambda f: f is None }}) -class EntityDefaultTableDropdownItems1Type(str, Enum): - ENTITY = 'entity' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -39,7 +32,7 @@ class EntityDefaultTableDropdownItems1: r"""This dropdown item should only be active when the feature flag is enabled""" legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) r"""Only show item for legacy tenants (ivy)""" - type: Optional[EntityDefaultTableDropdownItems1Type] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='entity', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) @@ -75,9 +68,6 @@ class EntityDefaultTableNavbarActions: -class EntityDefaultTableViewType(str, Enum): - DEFAULT = 'default' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -85,10 +75,10 @@ class EntityDefaultTableViewType(str, Enum): class EntityDefaultTable: classic_view: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classic_view'), 'exclude': lambda f: f is None }}) dropdown_items: Optional[list[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dropdown_items'), 'exclude': lambda f: f is None }}) - enable_thumbnails: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_thumbnails'), 'exclude': lambda f: f is None }}) + enable_thumbnails: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_thumbnails'), 'exclude': lambda f: f is None }}) r"""Enable the thumbnail column""" navbar_actions: Optional[list[EntityDefaultTableNavbarActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('navbar_actions'), 'exclude': lambda f: f is None }}) row_actions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('row_actions'), 'exclude': lambda f: f is None }}) - view_type: Optional[EntityDefaultTableViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + VIEW_TYPE: Final[Optional[str]] = dataclasses.field(default='default', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entityschema.py b/entity/src/epilot/models/shared/entityschema.py index b36416b90..3535b24ee 100755 --- a/entity/src/epilot/models/shared/entityschema.py +++ b/entity/src/epilot/models/shared/entityschema.py @@ -64,7 +64,7 @@ class EntitySchemaGroupSettings: feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This group should only be active when the feature flag is enabled""" info_tooltip_title: Optional[EntitySchemaGroupSettingsInfoTooltipTitle] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_tooltip_title'), 'exclude': lambda f: f is None }}) - order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) + order: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Render order of the group""" render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entityschemaitem.py b/entity/src/epilot/models/shared/entityschemaitem.py index 419dc98e7..bcece419b 100755 --- a/entity/src/epilot/models/shared/entityschemaitem.py +++ b/entity/src/epilot/models/shared/entityschemaitem.py @@ -64,7 +64,7 @@ class EntitySchemaItemGroupSettings: feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This group should only be active when the feature flag is enabled""" info_tooltip_title: Optional[EntitySchemaItemGroupSettingsInfoTooltipTitle] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_tooltip_title'), 'exclude': lambda f: f is None }}) - order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) + order: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Render order of the group""" render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitysearchparams.py b/entity/src/epilot/models/shared/entitysearchparams.py index 71fbbc82b..b3a2193b6 100755 --- a/entity/src/epilot/models/shared/entitysearchparams.py +++ b/entity/src/epilot/models/shared/entitysearchparams.py @@ -25,12 +25,12 @@ class EntitySearchParams: r"""Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.""" fields_: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) r"""List of entity fields to include in search results""" - from_: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('from'), 'exclude': lambda f: f is None }}) - hydrate: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hydrate'), 'exclude': lambda f: f is None }}) + from_: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('from'), 'exclude': lambda f: f is None }}) + hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hydrate'), 'exclude': lambda f: f is None }}) r"""When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.""" - include_scores: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('include_scores'), 'exclude': lambda f: f is None }}) + include_scores: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('include_scores'), 'exclude': lambda f: f is None }}) r"""Adds a `_score` number field to results that can be used to rank by match score""" - size: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('size'), 'exclude': lambda f: f is None }}) + size: Optional[int] = dataclasses.field(default=10, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('size'), 'exclude': lambda f: f is None }}) r"""Max search size is 1000 with higher values defaulting to 1000""" sort: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sort'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entityviewdisabled.py b/entity/src/epilot/models/shared/entityviewdisabled.py index 062013954..eb9c848ae 100755 --- a/entity/src/epilot/models/shared/entityviewdisabled.py +++ b/entity/src/epilot/models/shared/entityviewdisabled.py @@ -3,18 +3,14 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Optional - -class EntityViewDisabledViewType(str, Enum): - DISABLED = 'disabled' +from typing import Final, Optional @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityViewDisabled: - view_type: Optional[EntityViewDisabledViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + VIEW_TYPE: Final[Optional[str]] = dataclasses.field(default='disabled', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/fileattribute.py b/entity/src/epilot/models/shared/fileattribute.py index f0024630c..cf9709fe5 100755 --- a/entity/src/epilot/models/shared/fileattribute.py +++ b/entity/src/epilot/models/shared/fileattribute.py @@ -69,20 +69,20 @@ class FileAttribute: """ default_access_control: Optional[FileAttributeDefaultAccessControl] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_access_control'), 'exclude': lambda f: f is None }}) default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) display_images_landscaped: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('display_images_landscaped'), 'exclude': lambda f: f is None }}) r"""Controls how the images are presented to the user during upload on the Entity Details view.""" enable_description: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_description'), 'exclude': lambda f: f is None }}) r"""When set to true, an i18n description will be used alongside the attribute label. This description should be set through the platform locales in the form: `file.{attribute_name}.description_text`. """ - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -98,20 +98,20 @@ class FileAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/internalattribute.py b/entity/src/epilot/models/shared/internalattribute.py index 4cba4342d..bed7d7ff9 100755 --- a/entity/src/epilot/models/shared/internalattribute.py +++ b/entity/src/epilot/models/shared/internalattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class InternalAttributeInfoHelpers: -class InternalAttributeType(str, Enum): - INTERNAL = 'internal' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class InternalAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class InternalAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[InternalAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='internal', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/internaluserattribute.py b/entity/src/epilot/models/shared/internaluserattribute.py index a313add95..7470e7cc1 100755 --- a/entity/src/epilot/models/shared/internaluserattribute.py +++ b/entity/src/epilot/models/shared/internaluserattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class InternalUserAttributeInfoHelpers: -class InternalUserAttributeType(str, Enum): - INTERNAL_USER = 'internal_user' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class InternalUserAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class InternalUserAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[InternalUserAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='internal_user', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/invitationemailattribute.py b/entity/src/epilot/models/shared/invitationemailattribute.py index 8610c531b..fb46368f4 100755 --- a/entity/src/epilot/models/shared/invitationemailattribute.py +++ b/entity/src/epilot/models/shared/invitationemailattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class InvitationEmailAttributeInfoHelpers: -class InvitationEmailAttributeType(str, Enum): - INVITATION_EMAIL = 'invitation_email' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class InvitationEmailAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class InvitationEmailAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[InvitationEmailAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='invitation_email', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/linkattribute.py b/entity/src/epilot/models/shared/linkattribute.py index e5ab78e4d..6dbbbd851 100755 --- a/entity/src/epilot/models/shared/linkattribute.py +++ b/entity/src/epilot/models/shared/linkattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class LinkAttributeInfoHelpers: -class LinkAttributeType(str, Enum): - LINK = 'link' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class LinkAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class LinkAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[LinkAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='link', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/multiselectattribute.py b/entity/src/epilot/models/shared/multiselectattribute.py index 6041610a9..ef8026c2c 100755 --- a/entity/src/epilot/models/shared/multiselectattribute.py +++ b/entity/src/epilot/models/shared/multiselectattribute.py @@ -74,23 +74,23 @@ class MultiSelectAttribute: purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) allow_any: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_any'), 'exclude': lambda f: f is None }}) r"""Allow arbitrary input values in addition to provided options""" - allow_extra_options: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_extra_options'), 'exclude': lambda f: f is None }}) + allow_extra_options: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_extra_options') }}) r"""controls if the 360 ui will allow the user to enter a value which is not defined by the options""" constraints: Optional[MultiSelectAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - disable_case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('disable_case_sensitive'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + disable_case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('disable_case_sensitive') }}) r"""controls if the matching of values against the options is case sensitive or not""" - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -106,20 +106,20 @@ class MultiSelectAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[MultiSelectAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/numberattribute.py b/entity/src/epilot/models/shared/numberattribute.py index 005066207..3e5512c6f 100755 --- a/entity/src/epilot/models/shared/numberattribute.py +++ b/entity/src/epilot/models/shared/numberattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class NumberAttributeInfoHelpers: -class NumberAttributeType(str, Enum): - NUMBER = 'number' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,15 +56,15 @@ class NumberAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" format: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('format'), 'exclude': lambda f: f is None }}) group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -83,22 +79,22 @@ class NumberAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[NumberAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='number', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/orderedlistattribute.py b/entity/src/epilot/models/shared/orderedlistattribute.py index b2b5f2e08..046ebbb65 100755 --- a/entity/src/epilot/models/shared/orderedlistattribute.py +++ b/entity/src/epilot/models/shared/orderedlistattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class OrderedListAttributeInfoHelpers: -class OrderedListAttributeType(str, Enum): - ORDERED_LIST = 'ordered_list' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class OrderedListAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class OrderedListAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[OrderedListAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='ordered_list', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/partnerorganisationattribute.py b/entity/src/epilot/models/shared/partnerorganisationattribute.py index 3adbf1b74..3f5713e5a 100755 --- a/entity/src/epilot/models/shared/partnerorganisationattribute.py +++ b/entity/src/epilot/models/shared/partnerorganisationattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class PartnerOrganisationAttributeInfoHelpers: -class PartnerOrganisationAttributeType(str, Enum): - PARTNER_ORGANISATION = 'partner_organisation' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class PartnerOrganisationAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class PartnerOrganisationAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[PartnerOrganisationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='partner_organisation', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/partnerstatusattribute.py b/entity/src/epilot/models/shared/partnerstatusattribute.py index 94cadbd03..0cc7c0a8b 100755 --- a/entity/src/epilot/models/shared/partnerstatusattribute.py +++ b/entity/src/epilot/models/shared/partnerstatusattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class PartnerStatusAttributeInfoHelpers: -class PartnerStatusAttributeType(str, Enum): - PARTNER_STATUS = 'partner_status' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class PartnerStatusAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -82,22 +78,22 @@ class PartnerStatusAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[PartnerStatusAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='partner_status', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py index 28b894d87..fb8da1dfe 100755 --- a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py +++ b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class PaymentMethodRelationAttributeInfoHelpers: -class PaymentMethodRelationAttributeType(str, Enum): - RELATION_PAYMENT_METHOD = 'relation_payment_method' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,15 +56,15 @@ class PaymentMethodRelationAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -83,22 +79,22 @@ class PaymentMethodRelationAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[PaymentMethodRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='relation_payment_method', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/purposeattribute.py b/entity/src/epilot/models/shared/purposeattribute.py index e56df6657..661c77415 100755 --- a/entity/src/epilot/models/shared/purposeattribute.py +++ b/entity/src/epilot/models/shared/purposeattribute.py @@ -5,9 +5,8 @@ import dateutil.parser from dataclasses_json import Undefined, dataclass_json from datetime import datetime -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -45,9 +44,6 @@ class PurposeAttributeInfoHelpers: -class PurposeAttributeType(str, Enum): - PURPOSE = 'purpose' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -63,14 +59,14 @@ class PurposeAttribute: """ created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -87,22 +83,22 @@ class PurposeAttribute: parents: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[PurposeAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='purpose', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/redirectentityview.py b/entity/src/epilot/models/shared/redirectentityview.py index 440d7c0cb..43471aff1 100755 --- a/entity/src/epilot/models/shared/redirectentityview.py +++ b/entity/src/epilot/models/shared/redirectentityview.py @@ -3,12 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Optional - -class RedirectEntityViewViewType(str, Enum): - REDIRECT = 'redirect' +from typing import Final, Optional @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,6 +12,6 @@ class RedirectEntityViewViewType(str, Enum): @dataclasses.dataclass class RedirectEntityView: route: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('route'), 'exclude': lambda f: f is None }}) - view_type: Optional[RedirectEntityViewViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + VIEW_TYPE: Final[Optional[str]] = dataclasses.field(default='redirect', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py index ae7ea28ca..fbed638e6 100755 --- a/entity/src/epilot/models/shared/relationattribute.py +++ b/entity/src/epilot/models/shared/relationattribute.py @@ -6,7 +6,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional, Union +from typing import Any, Final, Optional, Union class RelationAttributeActionsActionType(str, Enum): r"""The action type. Currently supported actions: @@ -62,9 +62,6 @@ class RelationAttributeDrawerSize(str, Enum): MEDIUM = 'medium' LARGE = 'large' -class RelationAttributeEditMode(str, Enum): - LIST_VIEW = 'list-view' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -106,9 +103,6 @@ class RelationAttributeRelationType(str, Enum): class RelationAttributeSummaryFields: pass -class RelationAttributeType(str, Enum): - RELATION = 'relation' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -127,23 +121,23 @@ class RelationAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - details_view_mode_enabled: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details_view_mode_enabled'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + details_view_mode_enabled: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details_view_mode_enabled'), 'exclude': lambda f: f is None }}) r"""Enables the preview, edition, and creation of relation items on a Master-Details view mode.""" drawer_size: Optional[RelationAttributeDrawerSize] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('drawer_size'), 'exclude': lambda f: f is None }}) - edit_mode: Optional[RelationAttributeEditMode] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_mode'), 'exclude': lambda f: f is None }}) - enable_relation_picker: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_picker'), 'exclude': lambda f: f is None }}) + EDIT_MODE: Final[Optional[str]] = dataclasses.field(default='list-view', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_mode'), 'exclude': lambda f: f is None }}) + enable_relation_picker: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_picker'), 'exclude': lambda f: f is None }}) r"""When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.""" - enable_relation_tags: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_tags'), 'exclude': lambda f: f is None }}) + enable_relation_tags: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_tags'), 'exclude': lambda f: f is None }}) r"""When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item.""" - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -155,9 +149,9 @@ class RelationAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) relation_affinity_mode: Optional[RelationAttributeRelationAffinityMode] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relation_affinity_mode'), 'exclude': lambda f: f is None }}) r"""Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity.""" relation_type: Optional[RelationAttributeRelationType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relation_type'), 'exclude': lambda f: f is None }}) @@ -166,7 +160,7 @@ class RelationAttribute: When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) reverse_attributes: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reverse_attributes'), 'exclude': lambda f: f is None }}) r"""Map of schema slug to target relation attribute""" search_placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_placeholder'), 'exclude': lambda f: f is None }}) @@ -175,10 +169,10 @@ class RelationAttribute: r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" summary_fields: Optional[list[Union[str, shared_summaryfield.SummaryField]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_fields'), 'exclude': lambda f: f is None }}) - type: Optional[RelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='relation', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/repeatableattribute.py b/entity/src/epilot/models/shared/repeatableattribute.py index eac414595..6a8dcad02 100755 --- a/entity/src/epilot/models/shared/repeatableattribute.py +++ b/entity/src/epilot/models/shared/repeatableattribute.py @@ -72,17 +72,17 @@ class RepeatableAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - enable_relation_picker: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_picker'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + enable_relation_picker: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_picker'), 'exclude': lambda f: f is None }}) r"""when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.""" - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" has_primary: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('has_primary'), 'exclude': lambda f: f is None }}) - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -97,9 +97,9 @@ class RepeatableAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) relation_affinity_mode: Optional[RepeatableAttributeRelationAffinityMode] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relation_affinity_mode'), 'exclude': lambda f: f is None }}) r"""Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.""" render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) @@ -108,12 +108,12 @@ class RepeatableAttribute: Note: Empty or invalid expression have no effect on the field visibility. """ repeatable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('repeatable'), 'exclude': lambda f: f is None }}) - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[RepeatableAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/searchmappings.py b/entity/src/epilot/models/shared/searchmappings.py index 6ce015cf4..6d664078c 100755 --- a/entity/src/epilot/models/shared/searchmappings.py +++ b/entity/src/epilot/models/shared/searchmappings.py @@ -24,7 +24,7 @@ class SearchMappingsType(str, Enum): @dataclasses.dataclass class SearchMappings: fields_: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) - index: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) + index: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) type: Optional[SearchMappingsType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/selectattribute.py b/entity/src/epilot/models/shared/selectattribute.py index d0b4c0e77..f8b4f71ac 100755 --- a/entity/src/epilot/models/shared/selectattribute.py +++ b/entity/src/epilot/models/shared/selectattribute.py @@ -79,14 +79,14 @@ class SelectAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -102,20 +102,20 @@ class SelectAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" type: Optional[SelectAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/sequenceattribute.py b/entity/src/epilot/models/shared/sequenceattribute.py index b78427b2e..a8d220aea 100755 --- a/entity/src/epilot/models/shared/sequenceattribute.py +++ b/entity/src/epilot/models/shared/sequenceattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class SequenceAttributeInfoHelpers: -class SequenceAttributeType(str, Enum): - SEQUENCE = 'sequence' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class SequenceAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -84,23 +80,23 @@ class SequenceAttribute: prefix: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('prefix'), 'exclude': lambda f: f is None }}) r"""Prefix added before the sequence number""" preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" start_number: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_number'), 'exclude': lambda f: f is None }}) - type: Optional[SequenceAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='sequence', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py index c10017f84..7feeeb921 100755 --- a/entity/src/epilot/models/shared/statusattribute.py +++ b/entity/src/epilot/models/shared/statusattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional, Union +from typing import Any, Final, Optional, Union @@ -61,9 +60,6 @@ class StatusAttributeOptions2: class StatusAttributeOptions: pass -class StatusAttributeType(str, Enum): - STATUS = 'status' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -78,14 +74,14 @@ class StatusAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -101,22 +97,22 @@ class StatusAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[StatusAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='status', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/tagsattribute.py b/entity/src/epilot/models/shared/tagsattribute.py index 20531c680..f23296647 100755 --- a/entity/src/epilot/models/shared/tagsattribute.py +++ b/entity/src/epilot/models/shared/tagsattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class TagsAttributeInfoHelpers: -class TagsAttributeType(str, Enum): - TAGS = 'tags' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class TagsAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -83,23 +79,23 @@ class TagsAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" suggestions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggestions'), 'exclude': lambda f: f is None }}) - type: Optional[TagsAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='tags', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/textattribute.py b/entity/src/epilot/models/shared/textattribute.py index aa5a41c21..3544df065 100755 --- a/entity/src/epilot/models/shared/textattribute.py +++ b/entity/src/epilot/models/shared/textattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class TextAttributeInfoHelpers: -class TextAttributeType(str, Enum): - STRING = 'string' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class TextAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -83,22 +79,22 @@ class TextAttribute: r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[TextAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='string', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/userrelationattribute.py b/entity/src/epilot/models/shared/userrelationattribute.py index 38bedc882..2384858ba 100755 --- a/entity/src/epilot/models/shared/userrelationattribute.py +++ b/entity/src/epilot/models/shared/userrelationattribute.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json -from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Final, Optional @@ -43,9 +42,6 @@ class UserRelationAttributeInfoHelpers: -class UserRelationAttributeType(str, Enum): - RELATION_USER = 'relation_user' - @dataclass_json(undefined=Undefined.EXCLUDE) @@ -60,14 +56,14 @@ class UserRelationAttribute: These constraints should and will be enforced by the attribute renderer. """ default_value: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default_value'), 'exclude': lambda f: f is None }}) - deprecated: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) - entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) + deprecated: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deprecated'), 'exclude': lambda f: f is None }}) + entity_builder_disable_edit: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_builder_disable_edit'), 'exclude': lambda f: f is None }}) r"""Setting to `true` disables editing the attribute on the entity builder UI""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the feature flag is enabled""" group: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group'), 'exclude': lambda f: f is None }}) r"""Which group the attribute should appear in. Accepts group ID or group name""" - hidden: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) + hidden: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hidden'), 'exclude': lambda f: f is None }}) r"""Do not render attribute in entity views""" hide_label: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hide_label'), 'exclude': lambda f: f is None }}) r"""When set to true, will hide the label of the field.""" @@ -78,27 +74,27 @@ class UserRelationAttribute: info_helpers: Optional[UserRelationAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) r"""A set of configurations meant to document and assist the user in filling the attribute.""" layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - multiple: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('multiple'), 'exclude': lambda f: f is None }}) + multiple: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('multiple'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) - protected: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) + protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) r"""Setting to `true` prevents the attribute from being modified / deleted""" - readonly: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) + readonly: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('readonly'), 'exclude': lambda f: f is None }}) render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) r"""Defines the conditional rendering expression for showing this field. When a valid expression is parsed, their evaluation defines the visibility of this attribute. Note: Empty or invalid expression have no effect on the field visibility. """ - required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""This attribute should only be active when the setting is enabled""" show_in_table: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_in_table'), 'exclude': lambda f: f is None }}) r"""Render as a column in table views. When defined, overrides `hidden`""" - sortable: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) + sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - type: Optional[UserRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='relation_user', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py index 001a57e33..690549818 100755 --- a/entity/src/epilot/relations.py +++ b/entity/src/epilot/relations.py @@ -21,12 +21,12 @@ def add_relations(self, request: operations.AddRelationsRequest) -> operations.A url = utils.generate_url(operations.AddRelationsRequest, base_url, '/v1/entity/{slug}/{id}/relations', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.AddRelationsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -55,7 +55,7 @@ def delete_relation(self, request: operations.DeleteRelationRequest) -> operatio headers = {} query_params = utils.get_query_params(operations.DeleteRelationRequest, request) headers['Accept'] = '*/*' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -82,7 +82,7 @@ def get_relations(self, request: operations.GetRelationsRequest) -> operations.G headers = {} query_params = utils.get_query_params(operations.GetRelationsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -115,7 +115,7 @@ def get_relations_v2(self, request: operations.GetRelationsV2Request) -> operati headers = {} query_params = utils.get_query_params(operations.GetRelationsV2Request, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -142,12 +142,12 @@ def update_relation(self, request: operations.UpdateRelationRequest) -> operatio url = utils.generate_url(operations.UpdateRelationRequest, base_url, '/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.UpdateRelationRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client diff --git a/entity/src/epilot/saved_views.py b/entity/src/epilot/saved_views.py index 382d3a3d0..2ba432e2f 100755 --- a/entity/src/epilot/saved_views.py +++ b/entity/src/epilot/saved_views.py @@ -21,11 +21,11 @@ def create_saved_view(self, request: shared.SavedView) -> operations.CreateSaved url = base_url + '/v1/entity/view' headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -53,7 +53,7 @@ def delete_saved_view(self, request: operations.DeleteSavedViewRequest) -> opera url = utils.generate_url(operations.DeleteSavedViewRequest, base_url, '/v1/entity/view/{id}', request) headers = {} headers['Accept'] = '*/*' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -75,7 +75,7 @@ def get_saved_view(self, request: operations.GetSavedViewRequest) -> operations. url = utils.generate_url(operations.GetSavedViewRequest, base_url, '/v1/entity/view/{id}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -103,7 +103,7 @@ def list_favorite_views_for_user(self) -> operations.ListFavoriteViewsForUserRes url = base_url + '/v1/entity/views/favorites' headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -131,7 +131,7 @@ def list_saved_views(self) -> operations.ListSavedViewsResponse: url = base_url + '/v1/entity/views' headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -158,11 +158,11 @@ def update_saved_view(self, request: operations.UpdateSavedViewRequest) -> opera url = utils.generate_url(operations.UpdateSavedViewRequest, base_url, '/v1/entity/view/{id}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "saved_view", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "saved_view", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client diff --git a/entity/src/epilot/schemas.py b/entity/src/epilot/schemas.py index f209f9f4b..0239c9d9e 100755 --- a/entity/src/epilot/schemas.py +++ b/entity/src/epilot/schemas.py @@ -22,7 +22,7 @@ def delete_schema(self, request: operations.DeleteSchemaRequest) -> operations.D url = utils.generate_url(operations.DeleteSchemaRequest, base_url, '/v1/entity/schemas/{slug}', request) headers = {} headers['Accept'] = '*/*' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -45,7 +45,7 @@ def get_schema(self, request: operations.GetSchemaRequest) -> operations.GetSche headers = {} query_params = utils.get_query_params(operations.GetSchemaRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -74,7 +74,7 @@ def get_schema_versions(self, request: operations.GetSchemaVersionsRequest) -> o headers = {} query_params = utils.get_query_params(operations.GetSchemaVersionsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -102,7 +102,7 @@ def list_schema_blueprints(self) -> operations.ListSchemaBlueprintsResponse: url = base_url + '/v1/entity/schemas/blueprints' headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -131,7 +131,7 @@ def list_schemas(self, request: operations.ListSchemasRequest) -> operations.Lis headers = {} query_params = utils.get_query_params(operations.ListSchemasRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -160,7 +160,7 @@ def list_taxonomy_classifications_for_schema(self, request: operations.ListTaxon headers = {} query_params = utils.get_query_params(operations.ListTaxonomyClassificationsForSchemaRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -187,12 +187,12 @@ def put_schema(self, request: operations.PutSchemaRequest) -> operations.PutSche url = utils.generate_url(operations.PutSchemaRequest, base_url, '/v1/entity/schemas/{slug}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "entity_schema", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "entity_schema", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.PutSchemaRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 7ced66fe0..150b1b144 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,8 +19,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.24.1' - gen_version: str = '2.131.1' + sdk_version: str = '1.25.0' + gen_version: str = '2.139.1' + user_agent: str = 'speakeasy-sdk/python 1.25.0 2.139.1 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: diff --git a/entity/src/epilot/taxonomy.py b/entity/src/epilot/taxonomy.py index 0bfc01a26..bcb445cba 100755 --- a/entity/src/epilot/taxonomy.py +++ b/entity/src/epilot/taxonomy.py @@ -22,7 +22,7 @@ def get_taxonomy(self, request: operations.GetTaxonomyRequest) -> operations.Get url = utils.generate_url(operations.GetTaxonomyRequest, base_url, '/v1/entity/taxonomies/{taxonomySlug}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -50,7 +50,7 @@ def list_taxonomies(self) -> operations.ListTaxonomiesResponse: url = base_url + '/v1/entity/listTaxonomies' headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -77,12 +77,12 @@ def taxonomies_classifications_search(self, request: operations.TaxonomiesClassi url = base_url + '/v1/entity/taxonomies/classifications:search' headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.TaxonomiesClassificationsSearchRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -111,7 +111,7 @@ def taxonomy_autocomplete(self, request: operations.TaxonomyAutocompleteRequest) headers = {} query_params = utils.get_query_params(operations.TaxonomyAutocompleteRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -138,11 +138,11 @@ def update_classifications_for_taxonomy(self, request: operations.UpdateClassifi url = utils.generate_url(operations.UpdateClassificationsForTaxonomyRequest, base_url, '/v1/entity/taxonomies/{taxonomySlug}/classifications', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "classifications_update", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "classifications_update", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client diff --git a/entity/src/epilot/utils/utils.py b/entity/src/epilot/utils/utils.py index b0aeb54de..4388f3b74 100755 --- a/entity/src/epilot/utils/utils.py +++ b/entity/src/epilot/utils/utils.py @@ -1,9 +1,9 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import sys import base64 import json import re +import sys from dataclasses import Field, dataclass, fields, is_dataclass, make_dataclass from datetime import date, datetime from decimal import Decimal @@ -393,17 +393,22 @@ def _get_delimited_query_params(metadata: dict, field_name: str, obj: any, delim } -def serialize_request_body(request: dataclass, request_field_name: str, serialization_method: str) -> Tuple[ +def serialize_request_body(request: dataclass, request_field_name: str, nullable: bool, optional: bool, serialization_method: str, encoder=None) -> Tuple[ str, any, any]: if request is None: - return None, None, None + if not nullable and optional: + return None, None, None if not is_dataclass(request) or not hasattr(request, request_field_name): return serialize_content_type(request_field_name, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], - request) + request, encoder) request_val = getattr(request, request_field_name) + if request_val is None: + if not nullable and optional: + return None, None, None + request_fields: Tuple[Field, ...] = fields(request) request_metadata = None @@ -419,9 +424,9 @@ def serialize_request_body(request: dataclass, request_field_name: str, serializ request_val) -def serialize_content_type(field_name: str, media_type: str, request: dataclass) -> Tuple[str, any, list[list[any]]]: +def serialize_content_type(field_name: str, media_type: str, request: dataclass, encoder=None) -> Tuple[str, any, list[list[any]]]: if re.match(r'(application|text)\/.*?\+*json.*', media_type) is not None: - return media_type, marshal_json(request), None + return media_type, marshal_json(request, encoder), None if re.match(r'multipart\/.*', media_type) is not None: return serialize_multipart_form(media_type, request) if re.match(r'application\/x-www-form-urlencoded.*', media_type) is not None: @@ -678,7 +683,7 @@ def _serialize_header(explode: bool, obj: any) -> str: return '' -def unmarshal_json(data, typ): +def unmarshal_json(data, typ, decoder=None): unmarshal = make_dataclass('Unmarshal', [('res', typ)], bases=(DataClassJsonMixin,)) json_dict = json.loads(data) @@ -687,15 +692,19 @@ def unmarshal_json(data, typ): except AttributeError as attr_err: raise AttributeError( f'unable to unmarshal {data} as {typ}') from attr_err - return out.res + + return out.res if decoder is None else decoder(out.res) -def marshal_json(val): +def marshal_json(val, encoder=None): marshal = make_dataclass('Marshal', [('res', type(val))], bases=(DataClassJsonMixin,)) marshaller = marshal(res=val) json_dict = marshaller.to_dict() - return json.dumps(json_dict["res"]) + + val = json_dict["res"] if encoder is None else encoder(json_dict["res"]) + + return json.dumps(val) def match_content_type(content_type: str, pattern: str) -> boolean: @@ -769,6 +778,56 @@ def decimaldecoder(val): return Decimal(str(val)) +def map_encoder(optional: bool, value_encoder: Callable): + def map_encode(val: dict): + if optional and val is None: + return None + + encoded = {} + for key, value in val.items(): + encoded[key] = value_encoder(value) + + return encoded + + return map_encode + + +def map_decoder(value_decoder: Callable): + def map_decode(val: dict): + decoded = {} + for key, value in val.items(): + decoded[key] = value_decoder(value) + + return decoded + + return map_decode + + +def list_encoder(optional: bool, value_encoder: Callable): + def list_encode(val: list): + if optional and val is None: + return None + + encoded = [] + for value in val: + encoded.append(value_encoder(value)) + + return encoded + + return list_encode + + +def list_decoder(value_decoder: Callable): + def list_decode(val: list): + decoded = [] + for value in val: + decoded.append(value_decoder(value)) + + return decoded + + return list_decode + + def get_field_name(name): def override(_, _field_name=name): return _field_name From 82e05d4978fad908a4291f852b859b62d011c8e7 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sun, 1 Oct 2023 01:23:19 +0000 Subject: [PATCH 43/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.2 --- entity/RELEASES.md | 10 ++++++- .../docs/models/shared/currencyattribute.md | 2 +- .../shared/currencyattributecurrency.md | 14 ++++----- .../shared/currencyattributecurrency1.md | 13 ++++++++ .../entitydefaulttabledropdownitems1.md | 11 ------- .../entitydefaulttabledropdownitems2.md | 12 -------- entity/files.gen | 3 +- entity/gen.yaml | 8 ++--- entity/setup.py | 2 +- entity/src/epilot/models/shared/__init__.py | 2 +- .../epilot/models/shared/currencyattribute.py | 12 ++++++-- .../models/shared/entitydefaulttable.py | 30 ------------------- entity/src/epilot/sdkconfiguration.py | 6 ++-- 13 files changed, 48 insertions(+), 77 deletions(-) create mode 100755 entity/docs/models/shared/currencyattributecurrency1.md delete mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems1.md delete mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems2.md diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 1bb16f403..2d98a1102 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -316,4 +316,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.91.3 (2.139.1) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.25.0] entity \ No newline at end of file +- [python v1.25.0] entity + +## 2023-10-01 01:22:52 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.92.2 (2.142.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.26.0] entity \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattribute.md b/entity/docs/models/shared/currencyattribute.md index e4aa821c9..21d9bed54 100755 --- a/entity/docs/models/shared/currencyattribute.md +++ b/entity/docs/models/shared/currencyattribute.md @@ -9,7 +9,7 @@ Currency input | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[shared.CurrencyAttributeConstraints]](undefined/models/shared/currencyattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | -| `currency` | list[[shared.CurrencyAttributeCurrency](undefined/models/shared/currencyattributecurrency.md)] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | +| `currency` | list[[Union[shared.CurrencyAttributeCurrency1]](undefined/models/shared/currencyattributecurrency.md)] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | | `currency_selector_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/currencyattributecurrency.md b/entity/docs/models/shared/currencyattributecurrency.md index c165e258e..7ee2bc865 100755 --- a/entity/docs/models/shared/currencyattributecurrency.md +++ b/entity/docs/models/shared/currencyattributecurrency.md @@ -1,13 +1,11 @@ # CurrencyAttributeCurrency -A currency configuration +## Supported Types -## Fields +### CurrencyAttributeCurrency1 + +```python +currencyAttributeCurrency: shared.CurrencyAttributeCurrency1 = /* values here */ +``` -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *Optional[str]* | :heavy_check_mark: | N/A | -| `description` | *Optional[str]* | :heavy_check_mark: | N/A | -| `flag` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `symbol` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattributecurrency1.md b/entity/docs/models/shared/currencyattributecurrency1.md new file mode 100755 index 000000000..f7d2526a5 --- /dev/null +++ b/entity/docs/models/shared/currencyattributecurrency1.md @@ -0,0 +1,13 @@ +# CurrencyAttributeCurrency1 + +A currency configuration + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `code` | *Optional[str]* | :heavy_check_mark: | N/A | +| `description` | *Optional[str]* | :heavy_check_mark: | N/A | +| `flag` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `symbol` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md deleted file mode 100755 index f1a67b43f..000000000 --- a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md +++ /dev/null @@ -1,11 +0,0 @@ -# EntityDefaultTableDropdownItems1 - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `entity` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md deleted file mode 100755 index 5055cfc3c..000000000 --- a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md +++ /dev/null @@ -1,12 +0,0 @@ -# EntityDefaultTableDropdownItems2 - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | -| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Opportunities | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `uri` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/files.gen b/entity/files.gen index 8d5cf9abb..137de8c4b 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -230,8 +230,6 @@ docs/models/shared/entityschemaitemuiconfigsingleview.md docs/models/shared/entityschemaitemuiconfigtableview.md docs/models/shared/entityschemaitemuiconfig.md docs/models/shared/entityschemaitem.md -docs/models/shared/entitydefaulttabledropdownitems2.md -docs/models/shared/entitydefaulttabledropdownitems1.md docs/models/shared/entitydefaulttabledropdownitems.md docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md docs/models/shared/entitydefaulttablenavbaractionsoptions.md @@ -304,6 +302,7 @@ docs/models/shared/paymentmethodrelationattributeconstraints.md docs/models/shared/paymentmethodrelationattributeinfohelpers.md docs/models/shared/paymentmethodrelationattribute.md docs/models/shared/currencyattributeconstraints.md +docs/models/shared/currencyattributecurrency1.md docs/models/shared/currencyattributecurrency.md docs/models/shared/currencyattributeinfohelpers.md docs/models/shared/currencyattribute.md diff --git a/entity/gen.yaml b/entity/gen.yaml index 0909e6d4f..beb54c794 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: 285059cd6a6b4ebb4b50059166100555 docVersion: 1.0.0 - speakeasyVersion: 1.91.3 - generationVersion: 2.139.1 + speakeasyVersion: 1.92.2 + generationVersion: 2.142.2 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.87.0 + core: 2.88.0 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.25.0 + version: 1.26.0 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index 4ff6b7648..e49bbc8bf 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.25.0", + version="1.26.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index de05f354b..f29a6d4a4 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -54,4 +54,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeInfoHelpers","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems2","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","RedirectEntityView","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers"] +__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","RedirectEntityView","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers"] diff --git a/entity/src/epilot/models/shared/currencyattribute.py b/entity/src/epilot/models/shared/currencyattribute.py index 8f0686ba7..7e170c77f 100755 --- a/entity/src/epilot/models/shared/currencyattribute.py +++ b/entity/src/epilot/models/shared/currencyattribute.py @@ -4,7 +4,7 @@ import dataclasses from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Final, Optional, Union @@ -20,7 +20,7 @@ class CurrencyAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class CurrencyAttributeCurrency: +class CurrencyAttributeCurrency1: r"""A currency configuration""" code: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('code') }}) description: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) @@ -30,6 +30,12 @@ class CurrencyAttributeCurrency: + +@dataclasses.dataclass +class CurrencyAttributeCurrency: + pass + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass @@ -61,7 +67,7 @@ class CurrencyAttributeInfoHelpers: @dataclasses.dataclass class CurrencyAttribute: r"""Currency input""" - currency: list[CurrencyAttributeCurrency] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) + currency: list[Union[CurrencyAttributeCurrency1]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) r"""An array of currency configurations with a country code (ISO-4217)""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py index d1fe9a16a..80f29d5e4 100755 --- a/entity/src/epilot/models/shared/entitydefaulttable.py +++ b/entity/src/epilot/models/shared/entitydefaulttable.py @@ -7,36 +7,6 @@ from typing import Final, Optional, Union -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class EntityDefaultTableDropdownItems2: - feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This dropdown item should only be active when the feature flag is enabled""" - legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) - r"""Only show item for legacy tenants (ivy)""" - title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) - TYPE: Final[Optional[str]] = dataclasses.field(default='link', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('uri'), 'exclude': lambda f: f is None }}) - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class EntityDefaultTableDropdownItems1: - entity: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity'), 'exclude': lambda f: f is None }}) - r"""URL-friendly identifier for the entity schema""" - feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) - r"""This dropdown item should only be active when the feature flag is enabled""" - legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) - r"""Only show item for legacy tenants (ivy)""" - TYPE: Final[Optional[str]] = dataclasses.field(default='entity', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - - - - @dataclasses.dataclass class EntityDefaultTableDropdownItems: diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 150b1b144..1f5ee4b31 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,9 +19,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.25.0' - gen_version: str = '2.139.1' - user_agent: str = 'speakeasy-sdk/python 1.25.0 2.139.1 1.0.0 epilot-entity' + sdk_version: str = '1.26.0' + gen_version: str = '2.142.2' + user_agent: str = 'speakeasy-sdk/python 1.26.0 2.142.2 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: From 5fc58d65005b47294969086eeb84be392e3f4889 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Mon, 2 Oct 2023 01:14:58 +0000 Subject: [PATCH 44/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.3 --- entity/RELEASES.md | 10 ++++++- .../entitydefaulttabledropdownitems1.md | 11 +++++++ .../entitydefaulttabledropdownitems2.md | 12 ++++++++ entity/files.gen | 2 ++ entity/gen.yaml | 8 ++--- entity/setup.py | 2 +- entity/src/epilot/models/shared/__init__.py | 2 +- .../models/shared/entitydefaulttable.py | 30 +++++++++++++++++++ entity/src/epilot/sdkconfiguration.py | 6 ++-- 9 files changed, 73 insertions(+), 10 deletions(-) create mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems1.md create mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems2.md diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 2d98a1102..53a2e9a0d 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -324,4 +324,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.92.2 (2.142.2) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.26.0] entity \ No newline at end of file +- [python v1.26.0] entity + +## 2023-10-02 01:14:30 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.92.3 (2.143.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.26.1] entity \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md new file mode 100755 index 000000000..f1a67b43f --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md @@ -0,0 +1,11 @@ +# EntityDefaultTableDropdownItems1 + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `entity` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md new file mode 100755 index 000000000..5055cfc3c --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md @@ -0,0 +1,12 @@ +# EntityDefaultTableDropdownItems2 + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Opportunities | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `uri` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/files.gen b/entity/files.gen index 137de8c4b..073d01b28 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -230,6 +230,8 @@ docs/models/shared/entityschemaitemuiconfigsingleview.md docs/models/shared/entityschemaitemuiconfigtableview.md docs/models/shared/entityschemaitemuiconfig.md docs/models/shared/entityschemaitem.md +docs/models/shared/entitydefaulttabledropdownitems2.md +docs/models/shared/entitydefaulttabledropdownitems1.md docs/models/shared/entitydefaulttabledropdownitems.md docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md docs/models/shared/entitydefaulttablenavbaractionsoptions.md diff --git a/entity/gen.yaml b/entity/gen.yaml index beb54c794..8c5617075 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: 285059cd6a6b4ebb4b50059166100555 docVersion: 1.0.0 - speakeasyVersion: 1.92.2 - generationVersion: 2.142.2 + speakeasyVersion: 1.92.3 + generationVersion: 2.143.2 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.88.0 + core: 2.88.1 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.26.0 + version: 1.26.1 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index e49bbc8bf..f4767ccd7 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.26.0", + version="1.26.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index f29a6d4a4..e65af45de 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -54,4 +54,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","RedirectEntityView","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers"] +__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems2","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","RedirectEntityView","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers"] diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py index 80f29d5e4..d1fe9a16a 100755 --- a/entity/src/epilot/models/shared/entitydefaulttable.py +++ b/entity/src/epilot/models/shared/entitydefaulttable.py @@ -7,6 +7,36 @@ from typing import Final, Optional, Union +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class EntityDefaultTableDropdownItems2: + feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) + r"""This dropdown item should only be active when the feature flag is enabled""" + legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) + r"""Only show item for legacy tenants (ivy)""" + title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) + TYPE: Final[Optional[str]] = dataclasses.field(default='link', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('uri'), 'exclude': lambda f: f is None }}) + + + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class EntityDefaultTableDropdownItems1: + entity: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity'), 'exclude': lambda f: f is None }}) + r"""URL-friendly identifier for the entity schema""" + feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) + r"""This dropdown item should only be active when the feature flag is enabled""" + legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) + r"""Only show item for legacy tenants (ivy)""" + TYPE: Final[Optional[str]] = dataclasses.field(default='entity', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + + + + @dataclasses.dataclass class EntityDefaultTableDropdownItems: diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 1f5ee4b31..22abeda03 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,9 +19,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.26.0' - gen_version: str = '2.142.2' - user_agent: str = 'speakeasy-sdk/python 1.26.0 2.142.2 1.0.0 epilot-entity' + sdk_version: str = '1.26.1' + gen_version: str = '2.143.2' + user_agent: str = 'speakeasy-sdk/python 1.26.1 2.143.2 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: From f3c9083b16b82a4b2cb2d17321a369a7cc4530f5 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Thu, 5 Oct 2023 01:14:44 +0000 Subject: [PATCH 45/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.94.0 --- entity/README.md | 1 + entity/RELEASES.md | 10 ++++- .../getrelatedentitiescountrequest.md | 9 ++++ .../getrelatedentitiescountresponse.md | 11 +++++ .../models/shared/addressrelationattribute.md | 2 +- .../shared/addressrelationattributetype.md | 8 ++++ .../docs/models/shared/automationattribute.md | 2 +- .../models/shared/automationattributetype.md | 8 ++++ entity/docs/models/shared/booleanattribute.md | 2 +- .../models/shared/booleanattributetype.md | 8 ++++ .../docs/models/shared/computedattribute.md | 2 +- .../models/shared/computedattributetype.md | 8 ++++ entity/docs/models/shared/consentattribute.md | 2 +- .../models/shared/consentattributetype.md | 8 ++++ entity/docs/models/shared/countryattribute.md | 2 +- .../models/shared/countryattributetype.md | 8 ++++ .../docs/models/shared/currencyattribute.md | 2 +- .../models/shared/currencyattributetype.md | 8 ++++ .../docs/models/shared/entitydefaultcreate.md | 2 +- .../shared/entitydefaultcreateviewtype.md | 8 ++++ .../docs/models/shared/entitydefaultedit.md | 2 +- .../shared/entitydefaulteditviewtype.md | 8 ++++ .../docs/models/shared/entitydefaulttable.md | 2 +- .../entitydefaulttabledropdownitems1.md | 12 +++--- .../entitydefaulttabledropdownitems1type.md | 8 ++++ .../entitydefaulttabledropdownitems2.md | 14 +++---- .../entitydefaulttabledropdownitems2type.md | 8 ++++ .../shared/entitydefaulttableviewtype.md | 8 ++++ .../docs/models/shared/entityviewdisabled.md | 6 +-- .../shared/entityviewdisabledviewtype.md | 8 ++++ .../models/shared/getrelatedentitiescount.md | 8 ++++ .../docs/models/shared/internalattribute.md | 2 +- .../models/shared/internalattributetype.md | 8 ++++ .../models/shared/internaluserattribute.md | 2 +- .../shared/internaluserattributetype.md | 8 ++++ .../models/shared/invitationemailattribute.md | 2 +- .../shared/invitationemailattributetype.md | 8 ++++ entity/docs/models/shared/linkattribute.md | 2 +- .../docs/models/shared/linkattributetype.md | 8 ++++ entity/docs/models/shared/numberattribute.md | 2 +- .../docs/models/shared/numberattributetype.md | 8 ++++ .../models/shared/orderedlistattribute.md | 2 +- .../models/shared/orderedlistattributetype.md | 8 ++++ .../shared/partnerorganisationattribute.md | 2 +- .../partnerorganisationattributetype.md | 8 ++++ .../models/shared/partnerstatusattribute.md | 2 +- .../shared/partnerstatusattributetype.md | 8 ++++ .../shared/paymentmethodrelationattribute.md | 2 +- .../paymentmethodrelationattributetype.md | 8 ++++ entity/docs/models/shared/purposeattribute.md | 2 +- .../models/shared/purposeattributetype.md | 8 ++++ .../docs/models/shared/redirectentityview.md | 8 ++-- .../shared/redirectentityviewviewtype.md | 8 ++++ .../docs/models/shared/relationattribute.md | 4 +- .../shared/relationattributeeditmode.md | 8 ++++ .../models/shared/relationattributetype.md | 8 ++++ .../docs/models/shared/sequenceattribute.md | 2 +- .../models/shared/sequenceattributetype.md | 8 ++++ entity/docs/models/shared/statusattribute.md | 2 +- .../docs/models/shared/statusattributetype.md | 8 ++++ entity/docs/models/shared/tagsattribute.md | 2 +- .../docs/models/shared/tagsattributetype.md | 8 ++++ entity/docs/models/shared/textattribute.md | 2 +- .../docs/models/shared/textattributetype.md | 8 ++++ .../models/shared/userrelationattribute.md | 2 +- .../shared/userrelationattributetype.md | 8 ++++ entity/docs/sdks/relations/README.md | 41 +++++++++++++++++++ entity/files.gen | 36 ++++++++++++++++ entity/gen.yaml | 10 ++--- entity/setup.py | 2 +- .../src/epilot/models/operations/__init__.py | 3 +- .../operations/getrelatedentitiescount.py | 33 +++++++++++++++ entity/src/epilot/models/shared/__init__.py | 3 +- .../models/shared/addressrelationattribute.py | 8 +++- .../models/shared/automationattribute.py | 8 +++- .../epilot/models/shared/booleanattribute.py | 8 +++- .../epilot/models/shared/computedattribute.py | 8 +++- .../epilot/models/shared/consentattribute.py | 8 +++- .../epilot/models/shared/countryattribute.py | 8 +++- .../epilot/models/shared/currencyattribute.py | 8 +++- .../models/shared/entitydefaultcreate.py | 8 +++- .../epilot/models/shared/entitydefaultedit.py | 8 +++- .../models/shared/entitydefaulttable.py | 18 ++++++-- .../models/shared/entityviewdisabled.py | 8 +++- .../models/shared/getrelatedentitiescount.py | 16 ++++++++ .../epilot/models/shared/internalattribute.py | 8 +++- .../models/shared/internaluserattribute.py | 8 +++- .../models/shared/invitationemailattribute.py | 8 +++- .../src/epilot/models/shared/linkattribute.py | 8 +++- .../epilot/models/shared/numberattribute.py | 8 +++- .../models/shared/orderedlistattribute.py | 8 +++- .../shared/partnerorganisationattribute.py | 8 +++- .../models/shared/partnerstatusattribute.py | 8 +++- .../shared/paymentmethodrelationattribute.py | 8 +++- .../epilot/models/shared/purposeattribute.py | 8 +++- .../models/shared/redirectentityview.py | 8 +++- .../epilot/models/shared/relationattribute.py | 12 ++++-- .../epilot/models/shared/sequenceattribute.py | 8 +++- .../epilot/models/shared/statusattribute.py | 8 +++- .../src/epilot/models/shared/tagsattribute.py | 8 +++- .../src/epilot/models/shared/textattribute.py | 8 +++- .../models/shared/userrelationattribute.py | 8 +++- entity/src/epilot/relations.py | 28 +++++++++++++ entity/src/epilot/sdkconfiguration.py | 6 +-- 104 files changed, 679 insertions(+), 118 deletions(-) create mode 100755 entity/docs/models/operations/getrelatedentitiescountrequest.md create mode 100755 entity/docs/models/operations/getrelatedentitiescountresponse.md create mode 100755 entity/docs/models/shared/addressrelationattributetype.md create mode 100755 entity/docs/models/shared/automationattributetype.md create mode 100755 entity/docs/models/shared/booleanattributetype.md create mode 100755 entity/docs/models/shared/computedattributetype.md create mode 100755 entity/docs/models/shared/consentattributetype.md create mode 100755 entity/docs/models/shared/countryattributetype.md create mode 100755 entity/docs/models/shared/currencyattributetype.md create mode 100755 entity/docs/models/shared/entitydefaultcreateviewtype.md create mode 100755 entity/docs/models/shared/entitydefaulteditviewtype.md create mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems1type.md create mode 100755 entity/docs/models/shared/entitydefaulttabledropdownitems2type.md create mode 100755 entity/docs/models/shared/entitydefaulttableviewtype.md create mode 100755 entity/docs/models/shared/entityviewdisabledviewtype.md create mode 100755 entity/docs/models/shared/getrelatedentitiescount.md create mode 100755 entity/docs/models/shared/internalattributetype.md create mode 100755 entity/docs/models/shared/internaluserattributetype.md create mode 100755 entity/docs/models/shared/invitationemailattributetype.md create mode 100755 entity/docs/models/shared/linkattributetype.md create mode 100755 entity/docs/models/shared/numberattributetype.md create mode 100755 entity/docs/models/shared/orderedlistattributetype.md create mode 100755 entity/docs/models/shared/partnerorganisationattributetype.md create mode 100755 entity/docs/models/shared/partnerstatusattributetype.md create mode 100755 entity/docs/models/shared/paymentmethodrelationattributetype.md create mode 100755 entity/docs/models/shared/purposeattributetype.md create mode 100755 entity/docs/models/shared/redirectentityviewviewtype.md create mode 100755 entity/docs/models/shared/relationattributeeditmode.md create mode 100755 entity/docs/models/shared/relationattributetype.md create mode 100755 entity/docs/models/shared/sequenceattributetype.md create mode 100755 entity/docs/models/shared/statusattributetype.md create mode 100755 entity/docs/models/shared/tagsattributetype.md create mode 100755 entity/docs/models/shared/textattributetype.md create mode 100755 entity/docs/models/shared/userrelationattributetype.md create mode 100755 entity/src/epilot/models/operations/getrelatedentitiescount.py create mode 100755 entity/src/epilot/models/shared/getrelatedentitiescount.py diff --git a/entity/README.md b/entity/README.md index 017659dea..3a2781ef6 100755 --- a/entity/README.md +++ b/entity/README.md @@ -68,6 +68,7 @@ if res.activity_item is not None: * [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 * [update_relation](docs/sdks/relations/README.md#update_relation) - updateRelation diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 53a2e9a0d..d0bb66ffb 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -332,4 +332,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.92.3 (2.143.2) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.26.1] entity \ No newline at end of file +- [python v1.26.1] entity + +## 2023-10-05 01:14:15 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.94.0 (2.147.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.26.2] entity \ No newline at end of file diff --git a/entity/docs/models/operations/getrelatedentitiescountrequest.md b/entity/docs/models/operations/getrelatedentitiescountrequest.md new file mode 100755 index 000000000..2d73839e3 --- /dev/null +++ b/entity/docs/models/operations/getrelatedentitiescountrequest.md @@ -0,0 +1,9 @@ +# GetRelatedEntitiesCountRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelatedentitiescountresponse.md b/entity/docs/models/operations/getrelatedentitiescountresponse.md new file mode 100755 index 000000000..66ac4874b --- /dev/null +++ b/entity/docs/models/operations/getrelatedentitiescountresponse.md @@ -0,0 +1,11 @@ +# GetRelatedEntitiesCountResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | +| `get_related_entities_count` | [Optional[shared.GetRelatedEntitiesCount]](undefined/models/shared/getrelatedentitiescount.md) | :heavy_minus_sign: | Success | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattribute.md b/entity/docs/models/shared/addressrelationattribute.md index f63361463..d7c2b8906 100755 --- a/entity/docs/models/shared/addressrelationattribute.md +++ b/entity/docs/models/shared/addressrelationattribute.md @@ -32,5 +32,5 @@ Reference to an address attribute of another entity | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.AddressRelationAttributeType]](undefined/models/shared/addressrelationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattributetype.md b/entity/docs/models/shared/addressrelationattributetype.md new file mode 100755 index 000000000..591ef24a0 --- /dev/null +++ b/entity/docs/models/shared/addressrelationattributetype.md @@ -0,0 +1,8 @@ +# AddressRelationAttributeType + + +## Values + +| Name | Value | +| ------------------ | ------------------ | +| `RELATION_ADDRESS` | relation_address | \ No newline at end of file diff --git a/entity/docs/models/shared/automationattribute.md b/entity/docs/models/shared/automationattribute.md index 0f4cb4b01..407c76b47 100755 --- a/entity/docs/models/shared/automationattribute.md +++ b/entity/docs/models/shared/automationattribute.md @@ -31,5 +31,5 @@ Automation entity | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.AutomationAttributeType]](undefined/models/shared/automationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/automationattributetype.md b/entity/docs/models/shared/automationattributetype.md new file mode 100755 index 000000000..f32481040 --- /dev/null +++ b/entity/docs/models/shared/automationattributetype.md @@ -0,0 +1,8 @@ +# AutomationAttributeType + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `AUTOMATION` | automation | \ No newline at end of file diff --git a/entity/docs/models/shared/booleanattribute.md b/entity/docs/models/shared/booleanattribute.md index efcce4015..1df93b1b6 100755 --- a/entity/docs/models/shared/booleanattribute.md +++ b/entity/docs/models/shared/booleanattribute.md @@ -31,5 +31,5 @@ Yes / No Toggle | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.BooleanAttributeType]](undefined/models/shared/booleanattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/booleanattributetype.md b/entity/docs/models/shared/booleanattributetype.md new file mode 100755 index 000000000..42e4baaee --- /dev/null +++ b/entity/docs/models/shared/booleanattributetype.md @@ -0,0 +1,8 @@ +# BooleanAttributeType + + +## Values + +| Name | Value | +| --------- | --------- | +| `BOOLEAN` | boolean | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattribute.md b/entity/docs/models/shared/computedattribute.md index bacd312b5..de4376b89 100755 --- a/entity/docs/models/shared/computedattribute.md +++ b/entity/docs/models/shared/computedattribute.md @@ -31,5 +31,5 @@ An attribute that is computed from the entity data. For more details on how to u | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.ComputedAttributeType]](undefined/models/shared/computedattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattributetype.md b/entity/docs/models/shared/computedattributetype.md new file mode 100755 index 000000000..2155a2f01 --- /dev/null +++ b/entity/docs/models/shared/computedattributetype.md @@ -0,0 +1,8 @@ +# ComputedAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `COMPUTED` | computed | \ No newline at end of file diff --git a/entity/docs/models/shared/consentattribute.md b/entity/docs/models/shared/consentattribute.md index 1b8bc865e..3c75d0284 100755 --- a/entity/docs/models/shared/consentattribute.md +++ b/entity/docs/models/shared/consentattribute.md @@ -33,5 +33,5 @@ Consent Management | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `topic` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `type` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `type` | [Optional[shared.ConsentAttributeType]](undefined/models/shared/consentattributetype.md) | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/consentattributetype.md b/entity/docs/models/shared/consentattributetype.md new file mode 100755 index 000000000..705bf9776 --- /dev/null +++ b/entity/docs/models/shared/consentattributetype.md @@ -0,0 +1,8 @@ +# ConsentAttributeType + + +## Values + +| Name | Value | +| --------- | --------- | +| `CONSENT` | consent | \ No newline at end of file diff --git a/entity/docs/models/shared/countryattribute.md b/entity/docs/models/shared/countryattribute.md index 99a12df83..2bc09598e 100755 --- a/entity/docs/models/shared/countryattribute.md +++ b/entity/docs/models/shared/countryattribute.md @@ -31,5 +31,5 @@ Country picker | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.CountryAttributeType]](undefined/models/shared/countryattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/countryattributetype.md b/entity/docs/models/shared/countryattributetype.md new file mode 100755 index 000000000..d40e0ef82 --- /dev/null +++ b/entity/docs/models/shared/countryattributetype.md @@ -0,0 +1,8 @@ +# CountryAttributeType + + +## Values + +| Name | Value | +| --------- | --------- | +| `COUNTRY` | country | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattribute.md b/entity/docs/models/shared/currencyattribute.md index 21d9bed54..78cc3e255 100755 --- a/entity/docs/models/shared/currencyattribute.md +++ b/entity/docs/models/shared/currencyattribute.md @@ -33,5 +33,5 @@ Currency input | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `type` | [Optional[shared.CurrencyAttributeType]](undefined/models/shared/currencyattributetype.md) | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattributetype.md b/entity/docs/models/shared/currencyattributetype.md new file mode 100755 index 000000000..037e5d352 --- /dev/null +++ b/entity/docs/models/shared/currencyattributetype.md @@ -0,0 +1,8 @@ +# CurrencyAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `CURRENCY` | currency | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreate.md b/entity/docs/models/shared/entitydefaultcreate.md index 93412a485..f9ff69793 100755 --- a/entity/docs/models/shared/entitydefaultcreate.md +++ b/entity/docs/models/shared/entitydefaultcreate.md @@ -7,4 +7,4 @@ | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | | `table_menu_options` | [Optional[shared.EntityDefaultCreateTableMenuOptions]](undefined/models/shared/entitydefaultcreatetablemenuoptions.md) | :heavy_minus_sign: | N/A | -| `view_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `view_type` | [Optional[shared.EntityDefaultCreateViewType]](undefined/models/shared/entitydefaultcreateviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreateviewtype.md b/entity/docs/models/shared/entitydefaultcreateviewtype.md new file mode 100755 index 000000000..387ef6ef2 --- /dev/null +++ b/entity/docs/models/shared/entitydefaultcreateviewtype.md @@ -0,0 +1,8 @@ +# EntityDefaultCreateViewType + + +## Values + +| Name | Value | +| --------- | --------- | +| `DEFAULT` | default | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultedit.md b/entity/docs/models/shared/entitydefaultedit.md index e78300c8d..002a9f1b6 100755 --- a/entity/docs/models/shared/entitydefaultedit.md +++ b/entity/docs/models/shared/entitydefaultedit.md @@ -8,4 +8,4 @@ | `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | | `summary_attributes` | list[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | | `table_menu_options` | [Optional[shared.EntityDefaultEditTableMenuOptions]](undefined/models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | -| `view_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `view_type` | [Optional[shared.EntityDefaultEditViewType]](undefined/models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulteditviewtype.md b/entity/docs/models/shared/entitydefaulteditviewtype.md new file mode 100755 index 000000000..300ea7dd7 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulteditviewtype.md @@ -0,0 +1,8 @@ +# EntityDefaultEditViewType + + +## Values + +| Name | Value | +| --------- | --------- | +| `DEFAULT` | default | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttable.md b/entity/docs/models/shared/entitydefaulttable.md index d8243fa94..5939af26b 100755 --- a/entity/docs/models/shared/entitydefaulttable.md +++ b/entity/docs/models/shared/entitydefaulttable.md @@ -10,4 +10,4 @@ | `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | | `navbar_actions` | list[[shared.EntityDefaultTableNavbarActions](undefined/models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | | `row_actions` | list[*str*] | :heavy_minus_sign: | N/A | -| `view_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `view_type` | [Optional[shared.EntityDefaultTableViewType]](undefined/models/shared/entitydefaulttableviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md index f1a67b43f..f23af8112 100755 --- a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `entity` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `entity` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | +| `type` | [Optional[shared.EntityDefaultTableDropdownItems1Type]](undefined/models/shared/entitydefaulttabledropdownitems1type.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md new file mode 100755 index 000000000..dd78cb538 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems1type.md @@ -0,0 +1,8 @@ +# EntityDefaultTableDropdownItems1Type + + +## Values + +| Name | Value | +| -------- | -------- | +| `ENTITY` | entity | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md index 5055cfc3c..57f8ebf54 100755 --- a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | -| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Opportunities | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `uri` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Opportunities | +| `type` | [Optional[shared.EntityDefaultTableDropdownItems2Type]](undefined/models/shared/entitydefaulttabledropdownitems2type.md) | :heavy_minus_sign: | N/A | | +| `uri` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md new file mode 100755 index 000000000..3e3a26e10 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems2type.md @@ -0,0 +1,8 @@ +# EntityDefaultTableDropdownItems2Type + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttableviewtype.md b/entity/docs/models/shared/entitydefaulttableviewtype.md new file mode 100755 index 000000000..e42ccf697 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttableviewtype.md @@ -0,0 +1,8 @@ +# EntityDefaultTableViewType + + +## Values + +| Name | Value | +| --------- | --------- | +| `DEFAULT` | default | \ No newline at end of file diff --git a/entity/docs/models/shared/entityviewdisabled.md b/entity/docs/models/shared/entityviewdisabled.md index db0f74b4f..3b614a38a 100755 --- a/entity/docs/models/shared/entityviewdisabled.md +++ b/entity/docs/models/shared/entityviewdisabled.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `view_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `view_type` | [Optional[shared.EntityViewDisabledViewType]](undefined/models/shared/entityviewdisabledviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityviewdisabledviewtype.md b/entity/docs/models/shared/entityviewdisabledviewtype.md new file mode 100755 index 000000000..332085008 --- /dev/null +++ b/entity/docs/models/shared/entityviewdisabledviewtype.md @@ -0,0 +1,8 @@ +# EntityViewDisabledViewType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `DISABLED` | disabled | \ No newline at end of file diff --git a/entity/docs/models/shared/getrelatedentitiescount.md b/entity/docs/models/shared/getrelatedentitiescount.md new file mode 100755 index 000000000..8aa138add --- /dev/null +++ b/entity/docs/models/shared/getrelatedentitiescount.md @@ -0,0 +1,8 @@ +# GetRelatedEntitiesCount + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `hits` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattribute.md b/entity/docs/models/shared/internalattribute.md index 48b4a9235..c2ed5d08e 100755 --- a/entity/docs/models/shared/internalattribute.md +++ b/entity/docs/models/shared/internalattribute.md @@ -31,5 +31,5 @@ No UI representation | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.InternalAttributeType]](undefined/models/shared/internalattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattributetype.md b/entity/docs/models/shared/internalattributetype.md new file mode 100755 index 000000000..ce3397a2e --- /dev/null +++ b/entity/docs/models/shared/internalattributetype.md @@ -0,0 +1,8 @@ +# InternalAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `INTERNAL` | internal | \ No newline at end of file diff --git a/entity/docs/models/shared/internaluserattribute.md b/entity/docs/models/shared/internaluserattribute.md index 11d7e4422..74cf6d848 100755 --- a/entity/docs/models/shared/internaluserattribute.md +++ b/entity/docs/models/shared/internaluserattribute.md @@ -31,5 +31,5 @@ Epilot internal user info | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.InternalUserAttributeType]](undefined/models/shared/internaluserattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internaluserattributetype.md b/entity/docs/models/shared/internaluserattributetype.md new file mode 100755 index 000000000..f6f08a50c --- /dev/null +++ b/entity/docs/models/shared/internaluserattributetype.md @@ -0,0 +1,8 @@ +# InternalUserAttributeType + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `INTERNAL_USER` | internal_user | \ No newline at end of file diff --git a/entity/docs/models/shared/invitationemailattribute.md b/entity/docs/models/shared/invitationemailattribute.md index cd4ec9cee..dd049fc58 100755 --- a/entity/docs/models/shared/invitationemailattribute.md +++ b/entity/docs/models/shared/invitationemailattribute.md @@ -31,5 +31,5 @@ Email address for send invitation | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.InvitationEmailAttributeType]](undefined/models/shared/invitationemailattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/invitationemailattributetype.md b/entity/docs/models/shared/invitationemailattributetype.md new file mode 100755 index 000000000..ddd4ae2c4 --- /dev/null +++ b/entity/docs/models/shared/invitationemailattributetype.md @@ -0,0 +1,8 @@ +# InvitationEmailAttributeType + + +## Values + +| Name | Value | +| ------------------ | ------------------ | +| `INVITATION_EMAIL` | invitation_email | \ No newline at end of file diff --git a/entity/docs/models/shared/linkattribute.md b/entity/docs/models/shared/linkattribute.md index 07c97f47a..588ec7f82 100755 --- a/entity/docs/models/shared/linkattribute.md +++ b/entity/docs/models/shared/linkattribute.md @@ -31,5 +31,5 @@ Link with title and href | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.LinkAttributeType]](undefined/models/shared/linkattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/linkattributetype.md b/entity/docs/models/shared/linkattributetype.md new file mode 100755 index 000000000..5da92ba14 --- /dev/null +++ b/entity/docs/models/shared/linkattributetype.md @@ -0,0 +1,8 @@ +# LinkAttributeType + + +## Values + +| Name | Value | +| ------ | ------ | +| `LINK` | link | \ No newline at end of file diff --git a/entity/docs/models/shared/numberattribute.md b/entity/docs/models/shared/numberattribute.md index 7886a1d2e..800feb25b 100755 --- a/entity/docs/models/shared/numberattribute.md +++ b/entity/docs/models/shared/numberattribute.md @@ -32,5 +32,5 @@ Numeric input | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.NumberAttributeType]](undefined/models/shared/numberattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/numberattributetype.md b/entity/docs/models/shared/numberattributetype.md new file mode 100755 index 000000000..a355b2afb --- /dev/null +++ b/entity/docs/models/shared/numberattributetype.md @@ -0,0 +1,8 @@ +# NumberAttributeType + + +## Values + +| Name | Value | +| -------- | -------- | +| `NUMBER` | number | \ No newline at end of file diff --git a/entity/docs/models/shared/orderedlistattribute.md b/entity/docs/models/shared/orderedlistattribute.md index 7b5b7613c..f639f7038 100755 --- a/entity/docs/models/shared/orderedlistattribute.md +++ b/entity/docs/models/shared/orderedlistattribute.md @@ -31,5 +31,5 @@ Type of attribute to render N number of ordered fields | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.OrderedListAttributeType]](undefined/models/shared/orderedlistattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/orderedlistattributetype.md b/entity/docs/models/shared/orderedlistattributetype.md new file mode 100755 index 000000000..7954fba64 --- /dev/null +++ b/entity/docs/models/shared/orderedlistattributetype.md @@ -0,0 +1,8 @@ +# OrderedListAttributeType + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `ORDERED_LIST` | ordered_list | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerorganisationattribute.md b/entity/docs/models/shared/partnerorganisationattribute.md index 9f1d3ec87..ed90a0652 100755 --- a/entity/docs/models/shared/partnerorganisationattribute.md +++ b/entity/docs/models/shared/partnerorganisationattribute.md @@ -31,5 +31,5 @@ Shared Partner Organisations | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.PartnerOrganisationAttributeType]](undefined/models/shared/partnerorganisationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerorganisationattributetype.md b/entity/docs/models/shared/partnerorganisationattributetype.md new file mode 100755 index 000000000..2ed31a1e1 --- /dev/null +++ b/entity/docs/models/shared/partnerorganisationattributetype.md @@ -0,0 +1,8 @@ +# PartnerOrganisationAttributeType + + +## Values + +| Name | Value | +| ---------------------- | ---------------------- | +| `PARTNER_ORGANISATION` | partner_organisation | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerstatusattribute.md b/entity/docs/models/shared/partnerstatusattribute.md index e30a10855..34ce2267a 100755 --- a/entity/docs/models/shared/partnerstatusattribute.md +++ b/entity/docs/models/shared/partnerstatusattribute.md @@ -31,5 +31,5 @@ Partner Status | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.PartnerStatusAttributeType]](undefined/models/shared/partnerstatusattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerstatusattributetype.md b/entity/docs/models/shared/partnerstatusattributetype.md new file mode 100755 index 000000000..f9be21824 --- /dev/null +++ b/entity/docs/models/shared/partnerstatusattributetype.md @@ -0,0 +1,8 @@ +# PartnerStatusAttributeType + + +## Values + +| Name | Value | +| ---------------- | ---------------- | +| `PARTNER_STATUS` | partner_status | \ No newline at end of file diff --git a/entity/docs/models/shared/paymentmethodrelationattribute.md b/entity/docs/models/shared/paymentmethodrelationattribute.md index 833af7952..df36af4e9 100755 --- a/entity/docs/models/shared/paymentmethodrelationattribute.md +++ b/entity/docs/models/shared/paymentmethodrelationattribute.md @@ -32,5 +32,5 @@ Reference to a payment method attribute of another entity | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.PaymentMethodRelationAttributeType]](undefined/models/shared/paymentmethodrelationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/paymentmethodrelationattributetype.md b/entity/docs/models/shared/paymentmethodrelationattributetype.md new file mode 100755 index 000000000..3a5cdf1c9 --- /dev/null +++ b/entity/docs/models/shared/paymentmethodrelationattributetype.md @@ -0,0 +1,8 @@ +# PaymentMethodRelationAttributeType + + +## Values + +| Name | Value | +| ------------------------- | ------------------------- | +| `RELATION_PAYMENT_METHOD` | relation_payment_method | \ No newline at end of file diff --git a/entity/docs/models/shared/purposeattribute.md b/entity/docs/models/shared/purposeattribute.md index 855be733e..5fbaffb8b 100755 --- a/entity/docs/models/shared/purposeattribute.md +++ b/entity/docs/models/shared/purposeattribute.md @@ -34,6 +34,6 @@ Entity Taxonomy | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.PurposeAttributeType]](undefined/models/shared/purposeattributetype.md) | :heavy_minus_sign: | N/A | | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/purposeattributetype.md b/entity/docs/models/shared/purposeattributetype.md new file mode 100755 index 000000000..a46263d3b --- /dev/null +++ b/entity/docs/models/shared/purposeattributetype.md @@ -0,0 +1,8 @@ +# PurposeAttributeType + + +## Values + +| Name | Value | +| --------- | --------- | +| `PURPOSE` | purpose | \ No newline at end of file diff --git a/entity/docs/models/shared/redirectentityview.md b/entity/docs/models/shared/redirectentityview.md index b3923f504..62b8526dc 100755 --- a/entity/docs/models/shared/redirectentityview.md +++ b/entity/docs/models/shared/redirectentityview.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `route` | *Optional[str]* | :heavy_minus_sign: | N/A | /app/pricing-hub/product/:entityId | -| `view_type` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `route` | *Optional[str]* | :heavy_minus_sign: | N/A | /app/pricing-hub/product/:entityId | +| `view_type` | [Optional[shared.RedirectEntityViewViewType]](undefined/models/shared/redirectentityviewviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/redirectentityviewviewtype.md b/entity/docs/models/shared/redirectentityviewviewtype.md new file mode 100755 index 000000000..f1f49db52 --- /dev/null +++ b/entity/docs/models/shared/redirectentityviewviewtype.md @@ -0,0 +1,8 @@ +# RedirectEntityViewViewType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `REDIRECT` | redirect | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattribute.md b/entity/docs/models/shared/relationattribute.md index 629257b6f..55f8d5709 100755 --- a/entity/docs/models/shared/relationattribute.md +++ b/entity/docs/models/shared/relationattribute.md @@ -16,7 +16,7 @@ Entity Relationship | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `details_view_mode_enabled` | *Optional[bool]* | :heavy_minus_sign: | Enables the preview, edition, and creation of relation items on a Master-Details view mode. | | | `drawer_size` | [Optional[shared.RelationAttributeDrawerSize]](undefined/models/shared/relationattributedrawersize.md) | :heavy_minus_sign: | N/A | | -| `edit_mode` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `edit_mode` | [Optional[shared.RelationAttributeEditMode]](undefined/models/shared/relationattributeeditmode.md) | :heavy_minus_sign: | N/A | | | `enable_relation_picker` | *Optional[bool]* | :heavy_minus_sign: | When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link. | | | `enable_relation_tags` | *Optional[bool]* | :heavy_minus_sign: | When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item. | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -45,5 +45,5 @@ Entity Relationship | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `summary_fields` | list[[Union[str, shared.SummaryField]](undefined/models/shared/relationattributesummaryfields.md)] | :heavy_minus_sign: | N/A | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.RelationAttributeType]](undefined/models/shared/relationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributeeditmode.md b/entity/docs/models/shared/relationattributeeditmode.md new file mode 100755 index 000000000..cc0a9a767 --- /dev/null +++ b/entity/docs/models/shared/relationattributeeditmode.md @@ -0,0 +1,8 @@ +# RelationAttributeEditMode + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `LIST_VIEW` | list-view | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributetype.md b/entity/docs/models/shared/relationattributetype.md new file mode 100755 index 000000000..233bc4c95 --- /dev/null +++ b/entity/docs/models/shared/relationattributetype.md @@ -0,0 +1,8 @@ +# RelationAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `RELATION` | relation | \ No newline at end of file diff --git a/entity/docs/models/shared/sequenceattribute.md b/entity/docs/models/shared/sequenceattribute.md index 4e3602fa1..3785aa306 100755 --- a/entity/docs/models/shared/sequenceattribute.md +++ b/entity/docs/models/shared/sequenceattribute.md @@ -33,5 +33,5 @@ Sequence of unique identifiers | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `start_number` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.SequenceAttributeType]](undefined/models/shared/sequenceattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/sequenceattributetype.md b/entity/docs/models/shared/sequenceattributetype.md new file mode 100755 index 000000000..e2592e106 --- /dev/null +++ b/entity/docs/models/shared/sequenceattributetype.md @@ -0,0 +1,8 @@ +# SequenceAttributeType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `SEQUENCE` | sequence | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattribute.md b/entity/docs/models/shared/statusattribute.md index 3d5707d14..628f08990 100755 --- a/entity/docs/models/shared/statusattribute.md +++ b/entity/docs/models/shared/statusattribute.md @@ -32,5 +32,5 @@ Status select | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.StatusAttributeType]](undefined/models/shared/statusattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattributetype.md b/entity/docs/models/shared/statusattributetype.md new file mode 100755 index 000000000..8a9b3b5f1 --- /dev/null +++ b/entity/docs/models/shared/statusattributetype.md @@ -0,0 +1,8 @@ +# StatusAttributeType + + +## Values + +| Name | Value | +| -------- | -------- | +| `STATUS` | status | \ No newline at end of file diff --git a/entity/docs/models/shared/tagsattribute.md b/entity/docs/models/shared/tagsattribute.md index 2576cfc6c..a6f8a8e53 100755 --- a/entity/docs/models/shared/tagsattribute.md +++ b/entity/docs/models/shared/tagsattribute.md @@ -33,5 +33,5 @@ Tags | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `suggestions` | list[*str*] | :heavy_minus_sign: | N/A | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.TagsAttributeType]](undefined/models/shared/tagsattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/tagsattributetype.md b/entity/docs/models/shared/tagsattributetype.md new file mode 100755 index 000000000..cf2593e33 --- /dev/null +++ b/entity/docs/models/shared/tagsattributetype.md @@ -0,0 +1,8 @@ +# TagsAttributeType + + +## Values + +| Name | Value | +| ------ | ------ | +| `TAGS` | tags | \ No newline at end of file diff --git a/entity/docs/models/shared/textattribute.md b/entity/docs/models/shared/textattribute.md index eb600ae76..dd992e892 100755 --- a/entity/docs/models/shared/textattribute.md +++ b/entity/docs/models/shared/textattribute.md @@ -32,5 +32,5 @@ Textarea or text input | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.TextAttributeType]](undefined/models/shared/textattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/textattributetype.md b/entity/docs/models/shared/textattributetype.md new file mode 100755 index 000000000..88054505a --- /dev/null +++ b/entity/docs/models/shared/textattributetype.md @@ -0,0 +1,8 @@ +# TextAttributeType + + +## Values + +| Name | Value | +| -------- | -------- | +| `STRING` | string | \ No newline at end of file diff --git a/entity/docs/models/shared/userrelationattribute.md b/entity/docs/models/shared/userrelationattribute.md index 3afc9360f..93bc4a3d5 100755 --- a/entity/docs/models/shared/userrelationattribute.md +++ b/entity/docs/models/shared/userrelationattribute.md @@ -32,5 +32,5 @@ User Relationship | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `type` | [Optional[shared.UserRelationAttributeType]](undefined/models/shared/userrelationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/userrelationattributetype.md b/entity/docs/models/shared/userrelationattributetype.md new file mode 100755 index 000000000..3cca95f1e --- /dev/null +++ b/entity/docs/models/shared/userrelationattributetype.md @@ -0,0 +1,8 @@ +# UserRelationAttributeType + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `RELATION_USER` | relation_user | \ No newline at end of file diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index f4d9aa05f..2a44cff74 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -9,6 +9,7 @@ Entity Relationships * [add_relations](#add_relations) - addRelations * [delete_relation](#delete_relation) - deleteRelation +* [get_related_entities_count](#get_related_entities_count) - getRelatedEntitiesCount * [get_relations](#get_relations) - getRelations * [get_relations_v2](#get_relations_v2) - getRelationsV2 * [update_relation](#update_relation) - updateRelation @@ -107,6 +108,46 @@ if res.status_code == 200: **[operations.DeleteRelationResponse](../../models/operations/deleterelationresponse.md)** +## get_related_entities_count + +Returns the amount of unique related entities for an entity - includes direct and reverse relations. + + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetRelatedEntitiesCountRequest( + id='3a515de5-fe13-46e4-ad0c-a57656a6a8af', + slug='contact', +) + +res = s.relations.get_related_entities_count(req) + +if res.get_related_entities_count is not None: + # handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `request` | [operations.GetRelatedEntitiesCountRequest](../../models/operations/getrelatedentitiescountrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetRelatedEntitiesCountResponse](../../models/operations/getrelatedentitiescountresponse.md)** + + ## get_relations Returns 1st level direct relations for an entity. diff --git a/entity/files.gen b/entity/files.gen index 073d01b28..1e15b56f1 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -32,6 +32,7 @@ src/epilot/models/operations/importentities.py src/epilot/models/operations/exportentities.py src/epilot/models/operations/addrelations.py src/epilot/models/operations/deleterelation.py +src/epilot/models/operations/getrelatedentitiescount.py src/epilot/models/operations/getrelations.py src/epilot/models/operations/getrelationsv2.py src/epilot/models/operations/updaterelation.py @@ -61,6 +62,7 @@ src/epilot/models/shared/entitysearchresults.py src/epilot/models/shared/entitysearchparams.py src/epilot/models/shared/entityimportparams.py src/epilot/models/shared/relationitem.py +src/epilot/models/shared/getrelatedentitiescount.py src/epilot/models/shared/getrelationsrespwithpagination.py src/epilot/models/shared/savedviewitem.py src/epilot/models/shared/savedview.py @@ -146,6 +148,8 @@ docs/models/operations/addrelationsrequest.md docs/models/operations/addrelationsresponse.md docs/models/operations/deleterelationrequest.md docs/models/operations/deleterelationresponse.md +docs/models/operations/getrelatedentitiescountrequest.md +docs/models/operations/getrelatedentitiescountresponse.md docs/models/operations/getrelationsrequest.md docs/models/operations/getrelationsresponse.md docs/models/operations/getrelationsv2request.md @@ -210,6 +214,7 @@ docs/models/shared/entitysearchparams.md docs/models/shared/entityimportparamss3reference.md docs/models/shared/entityimportparams.md docs/models/shared/relationitem.md +docs/models/shared/getrelatedentitiescount.md docs/models/shared/getrelationsresp.md docs/models/shared/getrelationsrespwithpagination.md docs/models/shared/savedviewitemcreatedby1.md @@ -230,19 +235,26 @@ docs/models/shared/entityschemaitemuiconfigsingleview.md docs/models/shared/entityschemaitemuiconfigtableview.md docs/models/shared/entityschemaitemuiconfig.md docs/models/shared/entityschemaitem.md +docs/models/shared/entitydefaulttabledropdownitems2type.md docs/models/shared/entitydefaulttabledropdownitems2.md +docs/models/shared/entitydefaulttabledropdownitems1type.md docs/models/shared/entitydefaulttabledropdownitems1.md docs/models/shared/entitydefaulttabledropdownitems.md docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md docs/models/shared/entitydefaulttablenavbaractionsoptions.md docs/models/shared/entitydefaulttablenavbaractions.md +docs/models/shared/entitydefaulttableviewtype.md docs/models/shared/entitydefaulttable.md +docs/models/shared/redirectentityviewviewtype.md docs/models/shared/redirectentityview.md +docs/models/shared/entityviewdisabledviewtype.md docs/models/shared/entityviewdisabled.md docs/models/shared/entitydefaultedittablemenuoptions.md +docs/models/shared/entitydefaulteditviewtype.md docs/models/shared/entitydefaultedit.md docs/models/shared/summaryattribute.md docs/models/shared/entitydefaultcreatetablemenuoptions.md +docs/models/shared/entitydefaultcreateviewtype.md docs/models/shared/entitydefaultcreate.md docs/models/shared/searchmappingstype.md docs/models/shared/searchmappings.md @@ -250,9 +262,11 @@ docs/models/shared/entitycapability.md docs/models/shared/attribute.md docs/models/shared/textattributeconstraints.md docs/models/shared/textattributeinfohelpers.md +docs/models/shared/textattributetype.md docs/models/shared/textattribute.md docs/models/shared/linkattributeconstraints.md docs/models/shared/linkattributeinfohelpers.md +docs/models/shared/linkattributetype.md docs/models/shared/linkattribute.md docs/models/shared/dateattributeconstraints.md docs/models/shared/dateattributeinfohelpers.md @@ -260,9 +274,11 @@ docs/models/shared/dateattributetype.md docs/models/shared/dateattribute.md docs/models/shared/countryattributeconstraints.md docs/models/shared/countryattributeinfohelpers.md +docs/models/shared/countryattributetype.md docs/models/shared/countryattribute.md docs/models/shared/booleanattributeconstraints.md docs/models/shared/booleanattributeinfohelpers.md +docs/models/shared/booleanattributetype.md docs/models/shared/booleanattribute.md docs/models/shared/selectattributeconstraints.md docs/models/shared/selectattributeinfohelpers.md @@ -280,33 +296,41 @@ docs/models/shared/statusattributeconstraints.md docs/models/shared/statusattributeinfohelpers.md docs/models/shared/statusattributeoptions2.md docs/models/shared/statusattributeoptions.md +docs/models/shared/statusattributetype.md docs/models/shared/statusattribute.md docs/models/shared/sequenceattributeconstraints.md docs/models/shared/sequenceattributeinfohelpers.md +docs/models/shared/sequenceattributetype.md docs/models/shared/sequenceattribute.md docs/models/shared/relationattributeactionsactiontype.md docs/models/shared/relationattributeactions.md docs/models/shared/relationattributeconstraints.md docs/models/shared/relationattributedrawersize.md +docs/models/shared/relationattributeeditmode.md docs/models/shared/relationattributeinfohelpers.md docs/models/shared/relationattributerelationaffinitymode.md docs/models/shared/relationattributerelationtype.md docs/models/shared/relationattributesummaryfields.md +docs/models/shared/relationattributetype.md docs/models/shared/relationattribute.md docs/models/shared/summaryfield.md docs/models/shared/userrelationattributeconstraints.md docs/models/shared/userrelationattributeinfohelpers.md +docs/models/shared/userrelationattributetype.md docs/models/shared/userrelationattribute.md docs/models/shared/addressrelationattributeconstraints.md docs/models/shared/addressrelationattributeinfohelpers.md +docs/models/shared/addressrelationattributetype.md docs/models/shared/addressrelationattribute.md docs/models/shared/paymentmethodrelationattributeconstraints.md docs/models/shared/paymentmethodrelationattributeinfohelpers.md +docs/models/shared/paymentmethodrelationattributetype.md docs/models/shared/paymentmethodrelationattribute.md docs/models/shared/currencyattributeconstraints.md docs/models/shared/currencyattributecurrency1.md docs/models/shared/currencyattributecurrency.md docs/models/shared/currencyattributeinfohelpers.md +docs/models/shared/currencyattributetype.md docs/models/shared/currencyattribute.md docs/models/shared/repeatableattributeconstraints.md docs/models/shared/repeatableattributeinfohelpers.md @@ -315,18 +339,23 @@ docs/models/shared/repeatableattributetype.md docs/models/shared/repeatableattribute.md docs/models/shared/tagsattributeconstraints.md docs/models/shared/tagsattributeinfohelpers.md +docs/models/shared/tagsattributetype.md docs/models/shared/tagsattribute.md docs/models/shared/numberattributeconstraints.md docs/models/shared/numberattributeinfohelpers.md +docs/models/shared/numberattributetype.md docs/models/shared/numberattribute.md docs/models/shared/consentattributeconstraints.md docs/models/shared/consentattributeinfohelpers.md +docs/models/shared/consentattributetype.md docs/models/shared/consentattribute.md docs/models/shared/internalattributeconstraints.md docs/models/shared/internalattributeinfohelpers.md +docs/models/shared/internalattributetype.md docs/models/shared/internalattribute.md docs/models/shared/orderedlistattributeconstraints.md docs/models/shared/orderedlistattributeinfohelpers.md +docs/models/shared/orderedlistattributetype.md docs/models/shared/orderedlistattribute.md docs/models/shared/fileattributeconstraints.md docs/models/shared/fileattributedefaultaccesscontrol.md @@ -335,24 +364,31 @@ docs/models/shared/fileattributetype.md docs/models/shared/fileattribute.md docs/models/shared/computedattributeconstraints.md docs/models/shared/computedattributeinfohelpers.md +docs/models/shared/computedattributetype.md docs/models/shared/computedattribute.md docs/models/shared/partnerstatusattributeconstraints.md docs/models/shared/partnerstatusattributeinfohelpers.md +docs/models/shared/partnerstatusattributetype.md docs/models/shared/partnerstatusattribute.md docs/models/shared/invitationemailattributeconstraints.md docs/models/shared/invitationemailattributeinfohelpers.md +docs/models/shared/invitationemailattributetype.md docs/models/shared/invitationemailattribute.md docs/models/shared/automationattributeconstraints.md docs/models/shared/automationattributeinfohelpers.md +docs/models/shared/automationattributetype.md docs/models/shared/automationattribute.md docs/models/shared/internaluserattributeconstraints.md docs/models/shared/internaluserattributeinfohelpers.md +docs/models/shared/internaluserattributetype.md docs/models/shared/internaluserattribute.md docs/models/shared/purposeattributeconstraints.md docs/models/shared/purposeattributeinfohelpers.md +docs/models/shared/purposeattributetype.md docs/models/shared/purposeattribute.md docs/models/shared/partnerorganisationattributeconstraints.md docs/models/shared/partnerorganisationattributeinfohelpers.md +docs/models/shared/partnerorganisationattributetype.md docs/models/shared/partnerorganisationattribute.md docs/models/shared/taxonomyclassification.md docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md diff --git a/entity/gen.yaml b/entity/gen.yaml index 8c5617075..4dc05c820 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,9 +1,9 @@ configVersion: 1.0.0 management: - docChecksum: 285059cd6a6b4ebb4b50059166100555 + docChecksum: 04ee18f572d4803fa7729fff6d391c34 docVersion: 1.0.0 - speakeasyVersion: 1.92.3 - generationVersion: 2.143.2 + speakeasyVersion: 1.94.0 + generationVersion: 2.147.0 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.88.1 + core: 2.88.2 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 python: - version: 1.26.1 + version: 1.26.2 author: epilot description: Python Client SDK for Epilot maxMethodParams: 0 diff --git a/entity/setup.py b/entity/setup.py index f4767ccd7..5bccf93c6 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.26.1", + version="1.26.2", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/operations/__init__.py b/entity/src/epilot/models/operations/__init__.py index 78f8b3e41..456cf7794 100755 --- a/entity/src/epilot/models/operations/__init__.py +++ b/entity/src/epilot/models/operations/__init__.py @@ -14,6 +14,7 @@ from .getactivity import * from .getentity import * from .getentityactivityfeed import * +from .getrelatedentitiescount import * from .getrelations import * from .getrelationsv2 import * from .getsavedview import * @@ -38,4 +39,4 @@ from .updatesavedview import * from .upsertentity import * -__all__ = ["AddRelationsRequest","AddRelationsResponse","AttachActivityRequest","AttachActivityResponse","Autocomplete200ApplicationJSON","Autocomplete200ApplicationJSONResults","AutocompleteRequest","AutocompleteResponse","CreateActivityRequest","CreateActivityResponse","CreateEntityRequest","CreateEntityResponse","CreateSavedViewResponse","DeleteEntityRequest","DeleteEntityResponse","DeleteRelationRequest","DeleteRelationResponse","DeleteSavedViewRequest","DeleteSavedViewResponse","DeleteSchemaRequest","DeleteSchemaResponse","ExportEntitiesRequest","ExportEntitiesResponse","GetActivityRequest","GetActivityResponse","GetEntity200ApplicationJSON","GetEntityActivityFeed200ApplicationJSON","GetEntityActivityFeedRequest","GetEntityActivityFeedResponse","GetEntityRequest","GetEntityResponse","GetRelationsRequest","GetRelationsResponse","GetRelationsV2Request","GetRelationsV2Response","GetSavedView200ApplicationJSON","GetSavedViewRequest","GetSavedViewResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaVersions200ApplicationJSON","GetSchemaVersionsRequest","GetSchemaVersionsResponse","GetTaxonomyRequest","GetTaxonomyResponse","ImportEntitiesRequest","ImportEntitiesResponse","ListFavoriteViewsForUser200ApplicationJSON","ListFavoriteViewsForUserResponse","ListSavedViews200ApplicationJSON","ListSavedViewsResponse","ListSchemaBlueprints200ApplicationJSON","ListSchemaBlueprintsResponse","ListSchemas200ApplicationJSON","ListSchemasRequest","ListSchemasResponse","ListTaxonomies200ApplicationJSON","ListTaxonomiesResponse","ListTaxonomyClassificationsForSchema200ApplicationJSON","ListTaxonomyClassificationsForSchemaRequest","ListTaxonomyClassificationsForSchemaResponse","PatchEntityRequest","PatchEntityResponse","PutSchemaRequest","PutSchemaResponse","SearchEntitiesResponse","TaxonomiesClassificationsSearch200ApplicationJSON","TaxonomiesClassificationsSearchRequest","TaxonomiesClassificationsSearchRequestBody","TaxonomiesClassificationsSearchResponse","TaxonomyAutocomplete200ApplicationJSON","TaxonomyAutocompleteRequest","TaxonomyAutocompleteResponse","UpdateClassificationsForTaxonomy200ApplicationJSON","UpdateClassificationsForTaxonomy200ApplicationJSONDeleted","UpdateClassificationsForTaxonomyRequest","UpdateClassificationsForTaxonomyResponse","UpdateEntityRequest","UpdateEntityResponse","UpdateRelationRequest","UpdateRelationRequestBody","UpdateRelationResponse","UpdateSavedViewRequest","UpdateSavedViewResponse","UpsertEntityRequest","UpsertEntityRequestBody","UpsertEntityResponse"] +__all__ = ["AddRelationsRequest","AddRelationsResponse","AttachActivityRequest","AttachActivityResponse","Autocomplete200ApplicationJSON","Autocomplete200ApplicationJSONResults","AutocompleteRequest","AutocompleteResponse","CreateActivityRequest","CreateActivityResponse","CreateEntityRequest","CreateEntityResponse","CreateSavedViewResponse","DeleteEntityRequest","DeleteEntityResponse","DeleteRelationRequest","DeleteRelationResponse","DeleteSavedViewRequest","DeleteSavedViewResponse","DeleteSchemaRequest","DeleteSchemaResponse","ExportEntitiesRequest","ExportEntitiesResponse","GetActivityRequest","GetActivityResponse","GetEntity200ApplicationJSON","GetEntityActivityFeed200ApplicationJSON","GetEntityActivityFeedRequest","GetEntityActivityFeedResponse","GetEntityRequest","GetEntityResponse","GetRelatedEntitiesCountRequest","GetRelatedEntitiesCountResponse","GetRelationsRequest","GetRelationsResponse","GetRelationsV2Request","GetRelationsV2Response","GetSavedView200ApplicationJSON","GetSavedViewRequest","GetSavedViewResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaVersions200ApplicationJSON","GetSchemaVersionsRequest","GetSchemaVersionsResponse","GetTaxonomyRequest","GetTaxonomyResponse","ImportEntitiesRequest","ImportEntitiesResponse","ListFavoriteViewsForUser200ApplicationJSON","ListFavoriteViewsForUserResponse","ListSavedViews200ApplicationJSON","ListSavedViewsResponse","ListSchemaBlueprints200ApplicationJSON","ListSchemaBlueprintsResponse","ListSchemas200ApplicationJSON","ListSchemasRequest","ListSchemasResponse","ListTaxonomies200ApplicationJSON","ListTaxonomiesResponse","ListTaxonomyClassificationsForSchema200ApplicationJSON","ListTaxonomyClassificationsForSchemaRequest","ListTaxonomyClassificationsForSchemaResponse","PatchEntityRequest","PatchEntityResponse","PutSchemaRequest","PutSchemaResponse","SearchEntitiesResponse","TaxonomiesClassificationsSearch200ApplicationJSON","TaxonomiesClassificationsSearchRequest","TaxonomiesClassificationsSearchRequestBody","TaxonomiesClassificationsSearchResponse","TaxonomyAutocomplete200ApplicationJSON","TaxonomyAutocompleteRequest","TaxonomyAutocompleteResponse","UpdateClassificationsForTaxonomy200ApplicationJSON","UpdateClassificationsForTaxonomy200ApplicationJSONDeleted","UpdateClassificationsForTaxonomyRequest","UpdateClassificationsForTaxonomyResponse","UpdateEntityRequest","UpdateEntityResponse","UpdateRelationRequest","UpdateRelationRequestBody","UpdateRelationResponse","UpdateSavedViewRequest","UpdateSavedViewResponse","UpsertEntityRequest","UpsertEntityRequestBody","UpsertEntityResponse"] diff --git a/entity/src/epilot/models/operations/getrelatedentitiescount.py b/entity/src/epilot/models/operations/getrelatedentitiescount.py new file mode 100755 index 000000000..1132df2e2 --- /dev/null +++ b/entity/src/epilot/models/operations/getrelatedentitiescount.py @@ -0,0 +1,33 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from ..shared import getrelatedentitiescount as shared_getrelatedentitiescount +from typing import Optional + + + +@dataclasses.dataclass +class GetRelatedEntitiesCountRequest: + id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) + r"""Entity id""" + slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + r"""Entity Schema""" + + + + + +@dataclasses.dataclass +class GetRelatedEntitiesCountResponse: + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" + get_related_entities_count: Optional[shared_getrelatedentitiescount.GetRelatedEntitiesCount] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" + + diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index e65af45de..1df71ee08 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -23,6 +23,7 @@ from .entitysearchresults import * from .entityviewdisabled import * from .fileattribute import * +from .getrelatedentitiescount import * from .getrelationsrespwithpagination import * from .internalattribute import * from .internaluserattribute import * @@ -54,4 +55,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems2","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","RedirectEntityView","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers"] +__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelatedEntitiesCount","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] diff --git a/entity/src/epilot/models/shared/addressrelationattribute.py b/entity/src/epilot/models/shared/addressrelationattribute.py index 1fe3bda63..e0728d4cf 100755 --- a/entity/src/epilot/models/shared/addressrelationattribute.py +++ b/entity/src/epilot/models/shared/addressrelationattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class AddressRelationAttributeInfoHelpers: +class AddressRelationAttributeType(str, Enum): + RELATION_ADDRESS = 'relation_address' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -94,7 +98,7 @@ class AddressRelationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='relation_address', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[AddressRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/automationattribute.py b/entity/src/epilot/models/shared/automationattribute.py index 5b41ea074..3389c3be7 100755 --- a/entity/src/epilot/models/shared/automationattribute.py +++ b/entity/src/epilot/models/shared/automationattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class AutomationAttributeInfoHelpers: +class AutomationAttributeType(str, Enum): + AUTOMATION = 'automation' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class AutomationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='automation', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[AutomationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/booleanattribute.py b/entity/src/epilot/models/shared/booleanattribute.py index 916037ed2..75ee5293b 100755 --- a/entity/src/epilot/models/shared/booleanattribute.py +++ b/entity/src/epilot/models/shared/booleanattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class BooleanAttributeInfoHelpers: +class BooleanAttributeType(str, Enum): + BOOLEAN = 'boolean' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class BooleanAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='boolean', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[BooleanAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/computedattribute.py b/entity/src/epilot/models/shared/computedattribute.py index f2bf253ab..6b8a94368 100755 --- a/entity/src/epilot/models/shared/computedattribute.py +++ b/entity/src/epilot/models/shared/computedattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class ComputedAttributeInfoHelpers: +class ComputedAttributeType(str, Enum): + COMPUTED = 'computed' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class ComputedAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='computed', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[ComputedAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/consentattribute.py b/entity/src/epilot/models/shared/consentattribute.py index 0c3d6da3a..acdb4857d 100755 --- a/entity/src/epilot/models/shared/consentattribute.py +++ b/entity/src/epilot/models/shared/consentattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class ConsentAttributeInfoHelpers: +class ConsentAttributeType(str, Enum): + CONSENT = 'consent' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -51,7 +55,7 @@ class ConsentAttribute: label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) topic: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('topic') }}) - TYPE: Final[str] = dataclasses.field(default='consent', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + type: ConsentAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[ConsentAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. diff --git a/entity/src/epilot/models/shared/countryattribute.py b/entity/src/epilot/models/shared/countryattribute.py index a84be9938..440ca2dfe 100755 --- a/entity/src/epilot/models/shared/countryattribute.py +++ b/entity/src/epilot/models/shared/countryattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class CountryAttributeInfoHelpers: +class CountryAttributeType(str, Enum): + COUNTRY = 'country' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class CountryAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='country', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[CountryAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/currencyattribute.py b/entity/src/epilot/models/shared/currencyattribute.py index 7e170c77f..62d416734 100755 --- a/entity/src/epilot/models/shared/currencyattribute.py +++ b/entity/src/epilot/models/shared/currencyattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional, Union +from typing import Any, Optional, Union @@ -61,6 +62,9 @@ class CurrencyAttributeInfoHelpers: +class CurrencyAttributeType(str, Enum): + CURRENCY = 'currency' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -71,7 +75,7 @@ class CurrencyAttribute: r"""An array of currency configurations with a country code (ISO-4217)""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - TYPE: Final[str] = dataclasses.field(default='currency', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + type: CurrencyAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[CurrencyAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. diff --git a/entity/src/epilot/models/shared/entitydefaultcreate.py b/entity/src/epilot/models/shared/entitydefaultcreate.py index bd6d27c43..001572853 100755 --- a/entity/src/epilot/models/shared/entitydefaultcreate.py +++ b/entity/src/epilot/models/shared/entitydefaultcreate.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Final, Optional +from typing import Optional @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,6 +17,9 @@ class EntityDefaultCreateTableMenuOptions: +class EntityDefaultCreateViewType(str, Enum): + DEFAULT = 'default' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -23,6 +27,6 @@ class EntityDefaultCreateTableMenuOptions: class EntityDefaultCreate: search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) table_menu_options: Optional[EntityDefaultCreateTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) - VIEW_TYPE: Final[Optional[str]] = dataclasses.field(default='default', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + view_type: Optional[EntityDefaultCreateViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaultedit.py b/entity/src/epilot/models/shared/entitydefaultedit.py index 402bb350b..0538a7bcc 100755 --- a/entity/src/epilot/models/shared/entitydefaultedit.py +++ b/entity/src/epilot/models/shared/entitydefaultedit.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Final, Optional +from typing import Optional @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,6 +17,9 @@ class EntityDefaultEditTableMenuOptions: +class EntityDefaultEditViewType(str, Enum): + DEFAULT = 'default' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -25,6 +29,6 @@ class EntityDefaultEdit: summary_attributes: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) r"""List of attribute names that we show in the summary header""" table_menu_options: Optional[EntityDefaultEditTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) - VIEW_TYPE: Final[Optional[str]] = dataclasses.field(default='default', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + view_type: Optional[EntityDefaultEditViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py index d1fe9a16a..e53fe88f7 100755 --- a/entity/src/epilot/models/shared/entitydefaulttable.py +++ b/entity/src/epilot/models/shared/entitydefaulttable.py @@ -3,8 +3,12 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Final, Optional, Union +from typing import Optional, Union + +class EntityDefaultTableDropdownItems2Type(str, Enum): + LINK = 'link' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -16,11 +20,14 @@ class EntityDefaultTableDropdownItems2: legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) r"""Only show item for legacy tenants (ivy)""" title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) - TYPE: Final[Optional[str]] = dataclasses.field(default='link', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[EntityDefaultTableDropdownItems2Type] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('uri'), 'exclude': lambda f: f is None }}) +class EntityDefaultTableDropdownItems1Type(str, Enum): + ENTITY = 'entity' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -32,7 +39,7 @@ class EntityDefaultTableDropdownItems1: r"""This dropdown item should only be active when the feature flag is enabled""" legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) r"""Only show item for legacy tenants (ivy)""" - TYPE: Final[Optional[str]] = dataclasses.field(default='entity', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[EntityDefaultTableDropdownItems1Type] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) @@ -68,6 +75,9 @@ class EntityDefaultTableNavbarActions: +class EntityDefaultTableViewType(str, Enum): + DEFAULT = 'default' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -79,6 +89,6 @@ class EntityDefaultTable: r"""Enable the thumbnail column""" navbar_actions: Optional[list[EntityDefaultTableNavbarActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('navbar_actions'), 'exclude': lambda f: f is None }}) row_actions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('row_actions'), 'exclude': lambda f: f is None }}) - VIEW_TYPE: Final[Optional[str]] = dataclasses.field(default='default', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + view_type: Optional[EntityDefaultTableViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entityviewdisabled.py b/entity/src/epilot/models/shared/entityviewdisabled.py index eb9c848ae..062013954 100755 --- a/entity/src/epilot/models/shared/entityviewdisabled.py +++ b/entity/src/epilot/models/shared/entityviewdisabled.py @@ -3,14 +3,18 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Final, Optional +from typing import Optional + +class EntityViewDisabledViewType(str, Enum): + DISABLED = 'disabled' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityViewDisabled: - VIEW_TYPE: Final[Optional[str]] = dataclasses.field(default='disabled', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + view_type: Optional[EntityViewDisabledViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/getrelatedentitiescount.py b/entity/src/epilot/models/shared/getrelatedentitiescount.py new file mode 100755 index 000000000..75a577a84 --- /dev/null +++ b/entity/src/epilot/models/shared/getrelatedentitiescount.py @@ -0,0 +1,16 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from dataclasses_json import Undefined, dataclass_json +from epilot import utils +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class GetRelatedEntitiesCount: + hits: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) + + diff --git a/entity/src/epilot/models/shared/internalattribute.py b/entity/src/epilot/models/shared/internalattribute.py index bed7d7ff9..0f3377982 100755 --- a/entity/src/epilot/models/shared/internalattribute.py +++ b/entity/src/epilot/models/shared/internalattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class InternalAttributeInfoHelpers: +class InternalAttributeType(str, Enum): + INTERNAL = 'internal' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class InternalAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='internal', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[InternalAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/internaluserattribute.py b/entity/src/epilot/models/shared/internaluserattribute.py index 7470e7cc1..d3b4f06f6 100755 --- a/entity/src/epilot/models/shared/internaluserattribute.py +++ b/entity/src/epilot/models/shared/internaluserattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class InternalUserAttributeInfoHelpers: +class InternalUserAttributeType(str, Enum): + INTERNAL_USER = 'internal_user' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class InternalUserAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='internal_user', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[InternalUserAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/invitationemailattribute.py b/entity/src/epilot/models/shared/invitationemailattribute.py index fb46368f4..f884c68b7 100755 --- a/entity/src/epilot/models/shared/invitationemailattribute.py +++ b/entity/src/epilot/models/shared/invitationemailattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class InvitationEmailAttributeInfoHelpers: +class InvitationEmailAttributeType(str, Enum): + INVITATION_EMAIL = 'invitation_email' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class InvitationEmailAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='invitation_email', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[InvitationEmailAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/linkattribute.py b/entity/src/epilot/models/shared/linkattribute.py index 6dbbbd851..b8e441e37 100755 --- a/entity/src/epilot/models/shared/linkattribute.py +++ b/entity/src/epilot/models/shared/linkattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class LinkAttributeInfoHelpers: +class LinkAttributeType(str, Enum): + LINK = 'link' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class LinkAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='link', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[LinkAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/numberattribute.py b/entity/src/epilot/models/shared/numberattribute.py index 3e5512c6f..b536b4ff6 100755 --- a/entity/src/epilot/models/shared/numberattribute.py +++ b/entity/src/epilot/models/shared/numberattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class NumberAttributeInfoHelpers: +class NumberAttributeType(str, Enum): + NUMBER = 'number' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -94,7 +98,7 @@ class NumberAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='number', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[NumberAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/orderedlistattribute.py b/entity/src/epilot/models/shared/orderedlistattribute.py index 046ebbb65..041f1ce8a 100755 --- a/entity/src/epilot/models/shared/orderedlistattribute.py +++ b/entity/src/epilot/models/shared/orderedlistattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class OrderedListAttributeInfoHelpers: +class OrderedListAttributeType(str, Enum): + ORDERED_LIST = 'ordered_list' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class OrderedListAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='ordered_list', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[OrderedListAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/partnerorganisationattribute.py b/entity/src/epilot/models/shared/partnerorganisationattribute.py index 3f5713e5a..81d419c3e 100755 --- a/entity/src/epilot/models/shared/partnerorganisationattribute.py +++ b/entity/src/epilot/models/shared/partnerorganisationattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class PartnerOrganisationAttributeInfoHelpers: +class PartnerOrganisationAttributeType(str, Enum): + PARTNER_ORGANISATION = 'partner_organisation' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class PartnerOrganisationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='partner_organisation', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[PartnerOrganisationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/partnerstatusattribute.py b/entity/src/epilot/models/shared/partnerstatusattribute.py index 0cc7c0a8b..0b359ac34 100755 --- a/entity/src/epilot/models/shared/partnerstatusattribute.py +++ b/entity/src/epilot/models/shared/partnerstatusattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class PartnerStatusAttributeInfoHelpers: +class PartnerStatusAttributeType(str, Enum): + PARTNER_STATUS = 'partner_status' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -93,7 +97,7 @@ class PartnerStatusAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='partner_status', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[PartnerStatusAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py index fb8da1dfe..7e4cd1682 100755 --- a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py +++ b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class PaymentMethodRelationAttributeInfoHelpers: +class PaymentMethodRelationAttributeType(str, Enum): + RELATION_PAYMENT_METHOD = 'relation_payment_method' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -94,7 +98,7 @@ class PaymentMethodRelationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='relation_payment_method', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[PaymentMethodRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/purposeattribute.py b/entity/src/epilot/models/shared/purposeattribute.py index 661c77415..81e036b8f 100755 --- a/entity/src/epilot/models/shared/purposeattribute.py +++ b/entity/src/epilot/models/shared/purposeattribute.py @@ -5,8 +5,9 @@ import dateutil.parser from dataclasses_json import Undefined, dataclass_json from datetime import datetime +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -44,6 +45,9 @@ class PurposeAttributeInfoHelpers: +class PurposeAttributeType(str, Enum): + PURPOSE = 'purpose' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -98,7 +102,7 @@ class PurposeAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='purpose', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[PurposeAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/redirectentityview.py b/entity/src/epilot/models/shared/redirectentityview.py index 43471aff1..440d7c0cb 100755 --- a/entity/src/epilot/models/shared/redirectentityview.py +++ b/entity/src/epilot/models/shared/redirectentityview.py @@ -3,8 +3,12 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Final, Optional +from typing import Optional + +class RedirectEntityViewViewType(str, Enum): + REDIRECT = 'redirect' @dataclass_json(undefined=Undefined.EXCLUDE) @@ -12,6 +16,6 @@ @dataclasses.dataclass class RedirectEntityView: route: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('route'), 'exclude': lambda f: f is None }}) - VIEW_TYPE: Final[Optional[str]] = dataclasses.field(default='redirect', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) + view_type: Optional[RedirectEntityViewViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py index fbed638e6..9989c6b50 100755 --- a/entity/src/epilot/models/shared/relationattribute.py +++ b/entity/src/epilot/models/shared/relationattribute.py @@ -6,7 +6,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Final, Optional, Union +from typing import Any, Optional, Union class RelationAttributeActionsActionType(str, Enum): r"""The action type. Currently supported actions: @@ -62,6 +62,9 @@ class RelationAttributeDrawerSize(str, Enum): MEDIUM = 'medium' LARGE = 'large' +class RelationAttributeEditMode(str, Enum): + LIST_VIEW = 'list-view' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -103,6 +106,9 @@ class RelationAttributeRelationType(str, Enum): class RelationAttributeSummaryFields: pass +class RelationAttributeType(str, Enum): + RELATION = 'relation' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -125,7 +131,7 @@ class RelationAttribute: details_view_mode_enabled: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details_view_mode_enabled'), 'exclude': lambda f: f is None }}) r"""Enables the preview, edition, and creation of relation items on a Master-Details view mode.""" drawer_size: Optional[RelationAttributeDrawerSize] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('drawer_size'), 'exclude': lambda f: f is None }}) - EDIT_MODE: Final[Optional[str]] = dataclasses.field(default='list-view', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_mode'), 'exclude': lambda f: f is None }}) + edit_mode: Optional[RelationAttributeEditMode] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit_mode'), 'exclude': lambda f: f is None }}) enable_relation_picker: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_picker'), 'exclude': lambda f: f is None }}) r"""When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.""" enable_relation_tags: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_relation_tags'), 'exclude': lambda f: f is None }}) @@ -172,7 +178,7 @@ class RelationAttribute: sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" summary_fields: Optional[list[Union[str, shared_summaryfield.SummaryField]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_fields'), 'exclude': lambda f: f is None }}) - TYPE: Final[Optional[str]] = dataclasses.field(default='relation', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[RelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/sequenceattribute.py b/entity/src/epilot/models/shared/sequenceattribute.py index a8d220aea..c2d067f4e 100755 --- a/entity/src/epilot/models/shared/sequenceattribute.py +++ b/entity/src/epilot/models/shared/sequenceattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class SequenceAttributeInfoHelpers: +class SequenceAttributeType(str, Enum): + SEQUENCE = 'sequence' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -96,7 +100,7 @@ class SequenceAttribute: sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" start_number: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_number'), 'exclude': lambda f: f is None }}) - TYPE: Final[Optional[str]] = dataclasses.field(default='sequence', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[SequenceAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py index 7feeeb921..6ca7ab746 100755 --- a/entity/src/epilot/models/shared/statusattribute.py +++ b/entity/src/epilot/models/shared/statusattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional, Union +from typing import Any, Optional, Union @@ -60,6 +61,9 @@ class StatusAttributeOptions2: class StatusAttributeOptions: pass +class StatusAttributeType(str, Enum): + STATUS = 'status' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -112,7 +116,7 @@ class StatusAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='status', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[StatusAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/tagsattribute.py b/entity/src/epilot/models/shared/tagsattribute.py index f23296647..34b590adf 100755 --- a/entity/src/epilot/models/shared/tagsattribute.py +++ b/entity/src/epilot/models/shared/tagsattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class TagsAttributeInfoHelpers: +class TagsAttributeType(str, Enum): + TAGS = 'tags' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -95,7 +99,7 @@ class TagsAttribute: sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" suggestions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggestions'), 'exclude': lambda f: f is None }}) - TYPE: Final[Optional[str]] = dataclasses.field(default='tags', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[TagsAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/textattribute.py b/entity/src/epilot/models/shared/textattribute.py index 3544df065..9e317ed64 100755 --- a/entity/src/epilot/models/shared/textattribute.py +++ b/entity/src/epilot/models/shared/textattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class TextAttributeInfoHelpers: +class TextAttributeType(str, Enum): + STRING = 'string' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -94,7 +98,7 @@ class TextAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='string', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[TextAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/userrelationattribute.py b/entity/src/epilot/models/shared/userrelationattribute.py index 2384858ba..9a678593e 100755 --- a/entity/src/epilot/models/shared/userrelationattribute.py +++ b/entity/src/epilot/models/shared/userrelationattribute.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Final, Optional +from typing import Any, Optional @@ -42,6 +43,9 @@ class UserRelationAttributeInfoHelpers: +class UserRelationAttributeType(str, Enum): + RELATION_USER = 'relation_user' + @dataclass_json(undefined=Undefined.EXCLUDE) @@ -94,7 +98,7 @@ class UserRelationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - TYPE: Final[Optional[str]] = dataclasses.field(default='relation_user', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[UserRelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py index 690549818..f11837545 100755 --- a/entity/src/epilot/relations.py +++ b/entity/src/epilot/relations.py @@ -68,6 +68,34 @@ def delete_relation(self, request: operations.DeleteRelationRequest) -> operatio return res + def get_related_entities_count(self, request: operations.GetRelatedEntitiesCountRequest) -> operations.GetRelatedEntitiesCountResponse: + r"""getRelatedEntitiesCount + Returns the amount of unique related entities for an entity - includes direct and reverse relations. + """ + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(operations.GetRelatedEntitiesCountRequest, base_url, '/v2/entity/{slug}/{id}/relations/count', request) + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + + client = self.sdk_configuration.security_client + + http_res = client.request('GET', url, headers=headers) + content_type = http_res.headers.get('Content-Type') + + res = operations.GetRelatedEntitiesCountResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[shared.GetRelatedEntitiesCount]) + res.get_related_entities_count = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + + return res + + def get_relations(self, request: operations.GetRelationsRequest) -> operations.GetRelationsResponse: r"""getRelations Returns 1st level direct relations for an entity. diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 22abeda03..bc248983e 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,9 +19,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.26.1' - gen_version: str = '2.143.2' - user_agent: str = 'speakeasy-sdk/python 1.26.1 2.143.2 1.0.0 epilot-entity' + sdk_version: str = '1.26.2' + gen_version: str = '2.147.0' + user_agent: str = 'speakeasy-sdk/python 1.26.2 2.147.0 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: From 76ada4cd604f8cf32700981651964f97c689c230 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 7 Oct 2023 01:13:23 +0000 Subject: [PATCH 46/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.96.1 --- entity/RELEASES.md | 10 +- .../autocomplete200applicationjson.md | 2 +- .../models/operations/createentityrequest.md | 2 +- .../models/operations/createentityresponse.md | 12 +- .../operations/getentity200applicationjson.md | 8 +- .../getrelatedentitiescountrequest.md | 9 +- .../operations/getrelationsv2request.md | 2 +- .../models/operations/patchentityrequest.md | 2 +- .../models/operations/patchentityresponse.md | 12 +- .../models/operations/updateentityrequest.md | 2 +- .../models/operations/updateentityresponse.md | 12 +- .../operations/upsertentityrequestbody.md | 8 +- .../models/operations/upsertentityresponse.md | 12 +- entity/docs/models/shared/activity.md | 2 +- entity/docs/models/shared/activityitem.md | 2 +- .../docs/models/shared/entitydefaultedit.md | 12 +- entity/docs/models/shared/entityoperation.md | 2 +- .../docs/models/shared/entityoperationdiff.md | 10 +- entity/docs/models/shared/entityschema.md | 8 +- entity/docs/models/shared/entityschemaitem.md | 8 +- .../docs/models/shared/entitysearchparams.md | 2 +- entity/docs/models/shared/fileattribute.md | 2 +- .../docs/models/shared/relationattribute.md | 4 +- .../models/shared/relationattributeactions.md | 16 +- entity/docs/models/shared/savedview.md | 4 +- entity/docs/models/shared/savedviewitem.md | 4 +- entity/docs/sdks/activity/README.md | 13 +- entity/docs/sdks/entities/README.md | 59 +++-- entity/docs/sdks/export/README.md | 10 +- entity/docs/sdks/relations/README.md | 22 +- entity/docs/sdks/savedviews/README.md | 16 +- entity/docs/sdks/schemas/README.md | 210 ++++++++++++++---- entity/docs/sdks/taxonomy/README.md | 18 +- entity/gen.yaml | 13 +- entity/setup.py | 2 +- entity/src/epilot/models/__init__.py | 1 + .../operations/getrelatedentitiescount.py | 2 + .../epilot/models/operations/getrelations.py | 3 +- .../shared/getrelationsrespwithpagination.py | 3 +- entity/src/epilot/relations.py | 5 +- entity/src/epilot/sdk.py | 8 +- entity/src/epilot/sdkconfiguration.py | 6 +- 42 files changed, 355 insertions(+), 205 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index d0bb66ffb..d4e78548a 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -340,4 +340,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.94.0 (2.147.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.26.2] entity \ No newline at end of file +- [python v1.26.2] entity + +## 2023-10-07 01:12:55 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.96.1 (2.150.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.27.0] entity \ No newline at end of file diff --git a/entity/docs/models/operations/autocomplete200applicationjson.md b/entity/docs/models/operations/autocomplete200applicationjson.md index 14c36f0c7..f9064063f 100755 --- a/entity/docs/models/operations/autocomplete200applicationjson.md +++ b/entity/docs/models/operations/autocomplete200applicationjson.md @@ -8,4 +8,4 @@ Success | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `results` | list[[Union[str, bool, dict[str, Any]]](undefined/models/operations/autocomplete200applicationjsonresults.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `results` | list[[Union[str, bool, dict[str, Any]]](undefined/models/operations/autocomplete200applicationjsonresults.md)] | :heavy_minus_sign: | N/A | value | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityrequest.md b/entity/docs/models/operations/createentityrequest.md index f9efa87a3..254df7400 100755 --- a/entity/docs/models/operations/createentityrequest.md +++ b/entity/docs/models/operations/createentityrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | | `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityresponse.md b/entity/docs/models/operations/createentityresponse.md index cd30cdfae..93057ee30 100755 --- a/entity/docs/models/operations/createentityresponse.md +++ b/entity/docs/models/operations/createentityresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | +| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | [object Object] | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/entity/docs/models/operations/getentity200applicationjson.md b/entity/docs/models/operations/getentity200applicationjson.md index 57b8c20e7..487a62bbc 100755 --- a/entity/docs/models/operations/getentity200applicationjson.md +++ b/entity/docs/models/operations/getentity200applicationjson.md @@ -5,7 +5,7 @@ Success ## Fields -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `entity` | dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `relations` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- | +| `entity` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `relations` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelatedentitiescountrequest.md b/entity/docs/models/operations/getrelatedentitiescountrequest.md index 2d73839e3..702f679fa 100755 --- a/entity/docs/models/operations/getrelatedentitiescountrequest.md +++ b/entity/docs/models/operations/getrelatedentitiescountrequest.md @@ -3,7 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `exclude_schemas` | list[*str*] | :heavy_minus_sign: | To be excluded from the count by given schemas | | +| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | +| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv2request.md b/entity/docs/models/operations/getrelationsv2request.md index ae769fa23..289f3e1a2 100755 --- a/entity/docs/models/operations/getrelationsv2request.md +++ b/entity/docs/models/operations/getrelationsv2request.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in results | | +| `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in results | _id,_schema,_title | | `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | | `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | diff --git a/entity/docs/models/operations/patchentityrequest.md b/entity/docs/models/operations/patchentityrequest.md index aad56728b..3b932dc13 100755 --- a/entity/docs/models/operations/patchentityrequest.md +++ b/entity/docs/models/operations/patchentityrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `request_body` | dict[str, *Any*] | :heavy_check_mark: | N/A | | +| `request_body` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for the patch entity to become available in Search API. Useful for large migrations | | | `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = returns the patch result but doesn't perform the patch. | | diff --git a/entity/docs/models/operations/patchentityresponse.md b/entity/docs/models/operations/patchentityresponse.md index 435c05811..d22bfd47e 100755 --- a/entity/docs/models/operations/patchentityresponse.md +++ b/entity/docs/models/operations/patchentityresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | +| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | [object Object] | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/entity/docs/models/operations/updateentityrequest.md b/entity/docs/models/operations/updateentityrequest.md index 5fc57f80f..edee3da30 100755 --- a/entity/docs/models/operations/updateentityrequest.md +++ b/entity/docs/models/operations/updateentityrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | | `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | diff --git a/entity/docs/models/operations/updateentityresponse.md b/entity/docs/models/operations/updateentityresponse.md index 36f99db17..0389562f9 100755 --- a/entity/docs/models/operations/updateentityresponse.md +++ b/entity/docs/models/operations/updateentityresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | +| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | [object Object] | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityrequestbody.md b/entity/docs/models/operations/upsertentityrequestbody.md index f70f81fc7..d1ae2ddf5 100755 --- a/entity/docs/models/operations/upsertentityrequestbody.md +++ b/entity/docs/models/operations/upsertentityrequestbody.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `entity` | dict[str, *Any*] | :heavy_check_mark: | N/A | -| `unique_key` | list[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `entity` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | +| `unique_key` | list[*str*] | :heavy_check_mark: | N/A | _id | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityresponse.md b/entity/docs/models/operations/upsertentityresponse.md index 26ccfa898..60c3de8fc 100755 --- a/entity/docs/models/operations/upsertentityresponse.md +++ b/entity/docs/models/operations/upsertentityresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | +| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | [object Object] | +| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/entity/docs/models/shared/activity.md b/entity/docs/models/shared/activity.md index 1daebfb91..6c42333cd 100755 --- a/entity/docs/models/shared/activity.md +++ b/entity/docs/models/shared/activity.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | `message` | *Optional[str]* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | -| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | | `title` | *Optional[str]* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | | `type` | *Optional[str]* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file diff --git a/entity/docs/models/shared/activityitem.md b/entity/docs/models/shared/activityitem.md index 0b0c43653..0d48abd94 100755 --- a/entity/docs/models/shared/activityitem.md +++ b/entity/docs/models/shared/activityitem.md @@ -10,7 +10,7 @@ | `message` | *Optional[str]* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | | `operations` | list[[shared.EntityOperation](undefined/models/shared/entityoperation.md)] | :heavy_minus_sign: | N/A | | | `operations_total` | *Optional[int]* | :heavy_minus_sign: | Count of total operations attached to this activity | 1 | -| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | | `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `title` | *Optional[str]* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | | `type` | *Optional[str]* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultedit.md b/entity/docs/models/shared/entitydefaultedit.md index 002a9f1b6..1001c8aa0 100755 --- a/entity/docs/models/shared/entitydefaultedit.md +++ b/entity/docs/models/shared/entitydefaultedit.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | -| `summary_attributes` | list[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | -| `table_menu_options` | [Optional[shared.EntityDefaultEditTableMenuOptions]](undefined/models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | -| `view_type` | [Optional[shared.EntityDefaultEditViewType]](undefined/models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | | +| `summary_attributes` | list[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | email | +| `table_menu_options` | [Optional[shared.EntityDefaultEditTableMenuOptions]](undefined/models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | | +| `view_type` | [Optional[shared.EntityDefaultEditViewType]](undefined/models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperation.md b/entity/docs/models/shared/entityoperation.md index da006a1fa..e5bfbb2d9 100755 --- a/entity/docs/models/shared/entityoperation.md +++ b/entity/docs/models/shared/entityoperation.md @@ -11,4 +11,4 @@ | `operation` | [Optional[shared.EntityOperationOperation]](undefined/models/shared/entityoperationoperation.md) | :heavy_check_mark: | N/A | | | `org` | *Optional[str]* | :heavy_check_mark: | N/A | 123 | | `params` | [Optional[shared.EntityOperationParams]](undefined/models/shared/entityoperationparams.md) | :heavy_minus_sign: | N/A | | -| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperationdiff.md b/entity/docs/models/shared/entityoperationdiff.md index 5fffbf6d4..f2a5760c2 100755 --- a/entity/docs/models/shared/entityoperationdiff.md +++ b/entity/docs/models/shared/entityoperationdiff.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `added` | dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `deleted` | dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `updated` | dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `added` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `deleted` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `updated` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschema.md b/entity/docs/models/shared/entityschema.md index 8a207ecf8..764bea018 100755 --- a/entity/docs/models/shared/entityschema.md +++ b/entity/docs/models/shared/entityschema.md @@ -7,15 +7,15 @@ The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relati | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `attributes` | list[[Union[shared.TextAttribute, shared.LinkAttribute, shared.DateAttribute, shared.CountryAttribute, shared.BooleanAttribute, shared.SelectAttribute, shared.MultiSelectAttribute, shared.StatusAttribute, shared.SequenceAttribute, shared.RelationAttribute, shared.UserRelationAttribute, shared.AddressRelationAttribute, shared.PaymentMethodRelationAttribute, shared.CurrencyAttribute, shared.RepeatableAttribute, shared.TagsAttribute, shared.NumberAttribute, shared.ConsentAttribute, shared.InternalAttribute, shared.OrderedListAttribute, shared.FileAttribute, shared.ComputedAttribute, shared.PartnerStatusAttribute, shared.InvitationEmailAttribute, shared.AutomationAttribute, shared.InternalUserAttribute, shared.PurposeAttribute, shared.PartnerOrganisationAttribute]](undefined/models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | | +| `attributes` | list[[Union[shared.TextAttribute, shared.LinkAttribute, shared.DateAttribute, shared.CountryAttribute, shared.BooleanAttribute, shared.SelectAttribute, shared.MultiSelectAttribute, shared.StatusAttribute, shared.SequenceAttribute, shared.RelationAttribute, shared.UserRelationAttribute, shared.AddressRelationAttribute, shared.PaymentMethodRelationAttribute, shared.CurrencyAttribute, shared.RepeatableAttribute, shared.TagsAttribute, shared.NumberAttribute, shared.ConsentAttribute, shared.InternalAttribute, shared.OrderedListAttribute, shared.FileAttribute, shared.ComputedAttribute, shared.PartnerStatusAttribute, shared.InvitationEmailAttribute, shared.AutomationAttribute, shared.InternalUserAttribute, shared.PurposeAttribute, shared.PartnerOrganisationAttribute]](undefined/models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] | | `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | | `capabilities` | list[[shared.EntityCapability](undefined/models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | | `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | | `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | -| `explicit_search_mappings` | dict[str, [shared.SearchMappings](undefined/models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | +| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | 360_features | +| `explicit_search_mappings` | dict[str, [shared.SearchMappings](undefined/models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| [object Object] | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `group_settings` | list[[shared.EntitySchemaGroupSettings](undefined/models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | +| `group_settings` | list[[shared.EntitySchemaGroupSettings](undefined/models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | [object Object],[object Object] | | `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | | `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | | `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | diff --git a/entity/docs/models/shared/entityschemaitem.md b/entity/docs/models/shared/entityschemaitem.md index 3da754319..7baa52385 100755 --- a/entity/docs/models/shared/entityschemaitem.md +++ b/entity/docs/models/shared/entityschemaitem.md @@ -7,17 +7,17 @@ The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relati | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `attributes` | list[[Union[shared.TextAttribute, shared.LinkAttribute, shared.DateAttribute, shared.CountryAttribute, shared.BooleanAttribute, shared.SelectAttribute, shared.MultiSelectAttribute, shared.StatusAttribute, shared.SequenceAttribute, shared.RelationAttribute, shared.UserRelationAttribute, shared.AddressRelationAttribute, shared.PaymentMethodRelationAttribute, shared.CurrencyAttribute, shared.RepeatableAttribute, shared.TagsAttribute, shared.NumberAttribute, shared.ConsentAttribute, shared.InternalAttribute, shared.OrderedListAttribute, shared.FileAttribute, shared.ComputedAttribute, shared.PartnerStatusAttribute, shared.InvitationEmailAttribute, shared.AutomationAttribute, shared.InternalUserAttribute, shared.PurposeAttribute, shared.PartnerOrganisationAttribute]](undefined/models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | | +| `attributes` | list[[Union[shared.TextAttribute, shared.LinkAttribute, shared.DateAttribute, shared.CountryAttribute, shared.BooleanAttribute, shared.SelectAttribute, shared.MultiSelectAttribute, shared.StatusAttribute, shared.SequenceAttribute, shared.RelationAttribute, shared.UserRelationAttribute, shared.AddressRelationAttribute, shared.PaymentMethodRelationAttribute, shared.CurrencyAttribute, shared.RepeatableAttribute, shared.TagsAttribute, shared.NumberAttribute, shared.ConsentAttribute, shared.InternalAttribute, shared.OrderedListAttribute, shared.FileAttribute, shared.ComputedAttribute, shared.PartnerStatusAttribute, shared.InvitationEmailAttribute, shared.AutomationAttribute, shared.InternalUserAttribute, shared.PurposeAttribute, shared.PartnerOrganisationAttribute]](undefined/models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] | | `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | | `capabilities` | list[[shared.EntityCapability](undefined/models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | | `comment` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | | `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | | -| `explicit_search_mappings` | dict[str, [shared.SearchMappings](undefined/models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| | +| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | 360_features | +| `explicit_search_mappings` | dict[str, [shared.SearchMappings](undefined/models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| [object Object] | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `group_settings` | list[[shared.EntitySchemaItemGroupSettings](undefined/models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | | +| `group_settings` | list[[shared.EntitySchemaItemGroupSettings](undefined/models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | [object Object],[object Object] | | `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | | `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for schema | | | `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | diff --git a/entity/docs/models/shared/entitysearchparams.md b/entity/docs/models/shared/entitysearchparams.md index ebcf74b3c..1a259b27b 100755 --- a/entity/docs/models/shared/entitysearchparams.md +++ b/entity/docs/models/shared/entitysearchparams.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `aggs` | [Optional[shared.EntitySearchParamsAggs]](undefined/models/shared/entitysearchparamsaggs.md) | :heavy_minus_sign: | Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics. | | -| `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in search results | | +| `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in search results | _id,_title,first_name | | `from_` | *Optional[int]* | :heavy_minus_sign: | N/A | | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | | `include_scores` | *Optional[bool]* | :heavy_minus_sign: | Adds a `_score` number field to results that can be used to rank by match score | | diff --git a/entity/docs/models/shared/fileattribute.md b/entity/docs/models/shared/fileattribute.md index 19cbbbbb9..d69a52399 100755 --- a/entity/docs/models/shared/fileattribute.md +++ b/entity/docs/models/shared/fileattribute.md @@ -8,7 +8,7 @@ File or Image Attachment | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `allowed_extensions` | list[*str*] | :heavy_minus_sign: | List of file extensions (without the dot suffix) | | +| `allowed_extensions` | list[*str*] | :heavy_minus_sign: | List of file extensions (without the dot suffix) | csv | | `constraints` | [Optional[shared.FileAttributeConstraints]](undefined/models/shared/fileattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_access_control` | [Optional[shared.FileAttributeDefaultAccessControl]](undefined/models/shared/fileattributedefaultaccesscontrol.md) | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/relationattribute.md b/entity/docs/models/shared/relationattribute.md index 55f8d5709..ee5e610c3 100755 --- a/entity/docs/models/shared/relationattribute.md +++ b/entity/docs/models/shared/relationattribute.md @@ -8,7 +8,7 @@ Entity Relationship | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `actions` | list[[shared.RelationAttributeActions](undefined/models/shared/relationattributeactions.md)] | :heavy_minus_sign: | N/A | | +| `actions` | list[[shared.RelationAttributeActions](undefined/models/shared/relationattributeactions.md)] | :heavy_minus_sign: | N/A | [object Object] | | `add_button_label` | *Optional[str]* | :heavy_minus_sign: | Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is. | | | `allowed_schemas` | list[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[shared.RelationAttributeConstraints]](undefined/models/shared/relationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | @@ -39,7 +39,7 @@ Entity Relationship | `relation_type` | [Optional[shared.RelationAttributeRelationType]](undefined/models/shared/relationattributerelationtype.md) | :heavy_minus_sign: | N/A | | | `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `reverse_attributes` | dict[str, *str*] | :heavy_minus_sign: | Map of schema slug to target relation attribute | | +| `reverse_attributes` | dict[str, *str*] | :heavy_minus_sign: | Map of schema slug to target relation attribute | [object Object] | | `search_placeholder` | *Optional[str]* | :heavy_minus_sign: | Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is. | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | diff --git a/entity/docs/models/shared/relationattributeactions.md b/entity/docs/models/shared/relationattributeactions.md index 856efc2ab..f778523e5 100755 --- a/entity/docs/models/shared/relationattributeactions.md +++ b/entity/docs/models/shared/relationattributeactions.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action_type` | [Optional[shared.RelationAttributeActionsActionType]](undefined/models/shared/relationattributeactionsactiontype.md) | :heavy_minus_sign: | The action type. Currently supported actions:

\| action \| description \|
\|--------\|-------------\|
\| add_existing \| Enables the user to pick an existing entity to link as relation \|
\| create_new \| Enables the user to create a new entity using the first/main `allowed_schemas` schema
\| create_from_existing \| Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation \|
| -| `default` | *Optional[bool]* | :heavy_minus_sign: | Sets the action as the default action, visible as the main action button. | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the feature flag that enables this action | -| `label` | *Optional[str]* | :heavy_minus_sign: | The action label or action translation key (i18n) | -| `new_entity_item` | dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the setting flag that enables this action | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `action_type` | [Optional[shared.RelationAttributeActionsActionType]](undefined/models/shared/relationattributeactionsactiontype.md) | :heavy_minus_sign: | The action type. Currently supported actions:

\| action \| description \|
\|--------\|-------------\|
\| add_existing \| Enables the user to pick an existing entity to link as relation \|
\| create_new \| Enables the user to create a new entity using the first/main `allowed_schemas` schema
\| create_from_existing \| Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation \|
| | +| `default` | *Optional[bool]* | :heavy_minus_sign: | Sets the action as the default action, visible as the main action button. | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the feature flag that enables this action | | +| `label` | *Optional[str]* | :heavy_minus_sign: | The action label or action translation key (i18n) | | +| `new_entity_item` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the setting flag that enables this action | | \ No newline at end of file diff --git a/entity/docs/models/shared/savedview.md b/entity/docs/models/shared/savedview.md index 53eaa5dbe..9ab3d25f8 100755 --- a/entity/docs/models/shared/savedview.md +++ b/entity/docs/models/shared/savedview.md @@ -8,9 +8,9 @@ A saved entity view | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `created_by` | [Optional[Union[shared.SavedViewCreatedBy1, dict[str, Any]]]](undefined/models/shared/savedviewcreatedby.md) | :heavy_check_mark: | N/A | | -| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | +| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | 11701 | | `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | | `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | | `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | | `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | -| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewitem.md b/entity/docs/models/shared/savedviewitem.md index 3172591dd..12b31560c 100755 --- a/entity/docs/models/shared/savedviewitem.md +++ b/entity/docs/models/shared/savedviewitem.md @@ -10,10 +10,10 @@ A saved entity view | `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `created_by` | [Optional[Union[shared.SavedViewItemCreatedBy1, dict[str, Any]]]](undefined/models/shared/savedviewitemcreatedby.md) | :heavy_check_mark: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | -| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | | +| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | 11701 | | `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | | `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | | `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | | `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | -| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | | +| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | | `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md index 5e40848b2..663989873 100755 --- a/entity/docs/sdks/activity/README.md +++ b/entity/docs/sdks/activity/README.md @@ -77,13 +77,13 @@ req = operations.CreateActivityRequest( activity=shared.Activity( message='{{caller}} did something with {{entity payload.entity.id}}.', payload={ - "quo": 'apud', + "entity": 'Tricycle', }, title='My custom activity', type='MyCustomActivity', ), entities=[ - '5acc1fe2-b8d1-4825-82f2-569c1faffc1b', + '25acc1fe-2b8d-4182-9c2f-2569c1faffc1', ], ) @@ -123,8 +123,6 @@ s = epilot.Epilot( req = operations.GetActivityRequest( id='01F130Q52Q6MWSNS8N2AVXV4JN', - operations_from=826530, - operations_size=369963, ) res = s.activity.get_activity(req) @@ -164,12 +162,7 @@ s = epilot.Epilot( ) req = operations.GetEntityActivityFeedRequest( - after=dateutil.parser.isoparse('2022-01-31T23:44:31.870Z'), - before=dateutil.parser.isoparse('2022-09-19T15:43:08.281Z'), - from_=105040, - id='b83a9db1-edf0-4cb9-9bca-afe81677fcf9', - include_relations=False, - size=41031, + id='591b83a9-db1e-4df0-8b99-bcaafe81677f', slug='contact', type='SyncActivity', ) diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 22389310f..86c2c86b2 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -35,8 +35,6 @@ s = epilot.Epilot( req = operations.AutocompleteRequest( attribute='_tags', - input='Borders Netherlands benchmark', - size=180546, slug='contact', ) @@ -101,10 +99,16 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( request_body={ - "qui": 'of', + "_updated_at": 'Industrial', + "_acl": 'Implementation', + "_id": 'Future', + "_org": 'Southeast', + "_owners": 'Tandem', + "_schema": 'male', + "_tags": 'North', + "_created_at": 'Beach', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - async_=False, slug='contact', ) @@ -251,7 +255,6 @@ s = epilot.Epilot( ) req = operations.GetEntityRequest( - hydrate=False, id='73700929-3a3f-4c9a-8a39-e5abedf44929', slug='contact', ) @@ -319,12 +322,17 @@ s = epilot.Epilot( req = operations.PatchEntityRequest( request_body={ - "quod": 'illiterate', + "_tags": 'fuchsia', + "_created_at": 'Account', + "_updated_at": 'engage', + "_acl": 'Cis', + "_id": 'solutions', + "_org": 'founder', + "_owners": 'Southeast', + "_schema": 'Cab', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - async_=False, - dry_run=False, - id='dc474991-54f5-419d-9806-e999b72319d9', + id='06e999b7-2319-4d9e-8290-d19da9e1f40d', slug='contact', ) @@ -430,13 +438,11 @@ s = epilot.Epilot( req = shared.EntitySearchParams( aggs=shared.EntitySearchParamsAggs(), fields_=[ - 'Web', + '_id', + '_title', + 'first_name', ], - from_=696536, - hydrate=False, - include_scores=False, q='_schema:contact AND status:active', - size=358975, sort='_created_at:desc', ) @@ -501,11 +507,17 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( request_body={ - "sed": 'Pickup', + "_updated_at": 'Hartmann', + "_acl": 'invoice', + "_id": 'fathom', + "_org": 'Nepal', + "_owners": 'indexing', + "_schema": 'male', + "_tags": 'Profound', + "_created_at": 'policy', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - async_=False, - id='17df5520-987b-4d5a-ab1d-12df74462a98', + id='1d12df74-462a-498e-a7ff-ce36a4e49616', slug='contact', ) @@ -555,15 +567,20 @@ s = epilot.Epilot( req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( entity={ - "et": 'optical', + "_created_at": 'West', + "_updated_at": 'close', + "_acl": 'Infrastructure', + "_id": 'music', + "_org": 'astride', + "_owners": 'Designer', + "_schema": 'strategic', + "_tags": 'along', }, unique_key=[ - 'email.0.email', + '_id', ], ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - async_=False, - dry_run=False, slug='contact', ) diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md index d30e1095d..321140a27 100755 --- a/entity/docs/sdks/export/README.md +++ b/entity/docs/sdks/export/README.md @@ -29,18 +29,14 @@ req = operations.ExportEntitiesRequest( entity_search_params=shared.EntitySearchParams( aggs=shared.EntitySearchParamsAggs(), fields_=[ - 'Northwest', + '_id', + '_title', + 'first_name', ], - from_=577630, - hydrate=False, - include_scores=False, q='_schema:contact AND status:active', - size=727282, sort='_created_at:desc', ), - is_template=False, job_id='abc123', - language='Electronic', ) res = s.export.export_entities(req) diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index 2a44cff74..4f50ee5e8 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -38,11 +38,9 @@ req = operations.AddRelationsRequest( ], attribute='Swedish Hatchback Luxurious', entity_id='9248b564-99df-4660-9593-cfe3d006d87e', - reverse=False, ), ], activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - async_=False, id='69d98cd0-9bf6-4d30-b52c-36108777da47', slug='contact', ) @@ -83,7 +81,6 @@ s = epilot.Epilot( req = operations.DeleteRelationRequest( activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - async_=False, attribute='whiteboard sandal', entity_id='quasi South Southeast', id='f5b77b85-5b9c-4585-b7ae-4d21f6044e25', @@ -126,7 +123,10 @@ s = epilot.Epilot( ) req = operations.GetRelatedEntitiesCountRequest( - id='3a515de5-fe13-46e4-ad0c-a57656a6a8af', + exclude_schemas=[ + 'Tuna', + ], + id='515de5fe-136e-44ad-8ca5-7656a6a8afba', slug='contact', ) @@ -170,9 +170,7 @@ s = epilot.Epilot( ) req = operations.GetRelationsRequest( - hydrate=False, id='e642d6bf-f2f7-41f9-8aa4-db0ec78f30e6', - include_reverse=False, slug='contact', ) @@ -217,14 +215,11 @@ s = epilot.Epilot( req = operations.GetRelationsV2Request( fields_=[ - 'up', + '_id', + '_schema', + '_title', ], - from_=117939, - hydrate=False, - id='2f3e8dbd-dd40-4ecc-a3e0-01b2fb330d42', - include_reverse=False, - query='THX iterate', - size=534143, + id='80912f3e-8dbd-4dd4-8ecc-63e001b2fb33', slug='contact', ) @@ -269,7 +264,6 @@ req = operations.UpdateRelationRequest( ], ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - async_=False, attribute='imperturbable female during', entity_id='HDD Gasoline', id='3b01c385-4f8c-44b2-a614-3d8a0d332324', diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index 9ede30910..81a81cd98 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -31,7 +31,9 @@ s = epilot.Epilot( ) req = shared.SavedView( - created_by=[], + shared.SavedViewCreatedBy1( + user_id='10598', + ), is_favorited_by=[ '11701', ], @@ -42,7 +44,8 @@ req = shared.SavedView( 'contact', ], ui_config={ - "eos": 'Cyclocross', + "filters": 'Cyclocross', + "table_layout": 'Plastic', }, ) @@ -216,7 +219,9 @@ s = epilot.Epilot( req = operations.UpdateSavedViewRequest( saved_view=shared.SavedView( - created_by=[], + shared.SavedViewCreatedBy1( + user_id='10598', + ), is_favorited_by=[ '11701', ], @@ -227,10 +232,11 @@ req = operations.UpdateSavedViewRequest( 'contact', ], ui_config={ - "aut": 'red', + "filters": 'red', + "table_layout": 'Car', }, ), - id='3092cd47-8166-44df-95b0-841d72e4e501', + id='92cd4781-664d-4f55-b084-1d72e4e501ca', ) res = s.saved_views.update_saved_view(req) diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index f00d1239c..b101ae1dc 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -70,7 +70,6 @@ s = epilot.Epilot( ) req = operations.GetSchemaRequest( - id='3bcef047-7721-42cd-8bca-92e24545d526', slug='contact', ) @@ -109,11 +108,7 @@ s = epilot.Epilot( ) req = operations.GetSchemaVersionsRequest( - drafts_from=8135.81, - drafts_size=8621.33, slug='contact', - versions_from=8101.78, - versions_size=8257.35, ) res = s.schemas.get_schema_versions(req) @@ -179,9 +174,7 @@ s = epilot.Epilot( ), ) -req = operations.ListSchemasRequest( - unpublished=False, -) +req = operations.ListSchemasRequest() res = s.schemas.list_schemas(req) @@ -218,8 +211,6 @@ s = epilot.Epilot( ) req = operations.ListTaxonomyClassificationsForSchemaRequest( - query='Gasoline Torrance tesla', - size=8668.67, slug='contact', taxonomy_slug='purpose', ) @@ -262,67 +253,206 @@ s = epilot.Epilot( req = operations.PutSchemaRequest( entity_schema=shared.EntitySchema( attributes=[ - [], + shared.TextAttribute( + purpose=[ + 'a93c7b74-037c-43b9-94a9-6166aa0e2336', + ], + constraints=shared.TextAttributeConstraints(), + feature_flag='FF_MY_FEATURE_FLAG', + info_helpers=shared.TextAttributeInfoHelpers( + hint_tooltip_placement='top', + ), + label='Home', + layout='full_width', + name='Account parse Hybrid', + order=0, + setting_flag='MY_SETTING', + ), + shared.TextAttribute( + purpose=[ + '1de0f32d-6571-4521-8cf5-04680eaf6fd6', + ], + constraints=shared.TextAttributeConstraints(), + feature_flag='FF_MY_FEATURE_FLAG', + info_helpers=shared.TextAttributeInfoHelpers( + hint_tooltip_placement='top', + ), + label='warmly green Rolls', + layout='full_width', + name='payment archive', + order=0, + setting_flag='MY_SETTING', + ), + shared.TextAttribute( + purpose=[ + '5b3e0e28-c6d1-4668-943e-4eb242b720a7', + ], + constraints=shared.TextAttributeConstraints(), + feature_flag='FF_MY_FEATURE_FLAG', + info_helpers=shared.TextAttributeInfoHelpers( + hint_tooltip_placement='top', + ), + label='Martin Buckinghamshire second', + layout='full_width', + name='East', + order=0, + setting_flag='MY_SETTING', + ), + shared.TextAttribute( + purpose=[ + '66bc3807-5c84-437b-9710-c2601905e25f', + ], + constraints=shared.TextAttributeConstraints(), + feature_flag='FF_MY_FEATURE_FLAG', + info_helpers=shared.TextAttributeInfoHelpers( + hint_tooltip_placement='top', + ), + label='female payment Gloves', + layout='full_width', + name='redundant grow', + order=0, + setting_flag='MY_SETTING', + ), + shared.TextAttribute( + purpose=[ + '647c7479-d9c5-460e-a796-9366d774fa49', + ], + constraints=shared.TextAttributeConstraints(), + feature_flag='FF_MY_FEATURE_FLAG', + info_helpers=shared.TextAttributeInfoHelpers( + hint_tooltip_placement='top', + ), + label='voluptatem withdrawal Jersey', + layout='full_width', + name='Latin Massachusetts', + order=0, + setting_flag='MY_SETTING', + ), + shared.TextAttribute( + purpose=[ + '82a9ba9c-c095-4367-8af5-3c32a28a3faa', + ], + constraints=shared.TextAttributeConstraints(), + feature_flag='FF_MY_FEATURE_FLAG', + info_helpers=shared.TextAttributeInfoHelpers( + hint_tooltip_placement='top', + ), + label='parse Legacy', + layout='full_width', + name='killer', + order=0, + setting_flag='MY_SETTING', + ), + shared.TextAttribute( + purpose=[ + '3c780e75-fefd-44fb-b09f-43acc8e6b933', + ], + constraints=shared.TextAttributeConstraints(), + feature_flag='FF_MY_FEATURE_FLAG', + info_helpers=shared.TextAttributeInfoHelpers( + hint_tooltip_placement='top', + ), + label='likely Synchronised', + layout='full_width', + name='inundate invoice', + order=0, + setting_flag='MY_SETTING', + ), ], - blueprint='a93c7b74-037c-43b9-94a9-6166aa0e2336', capabilities=[ shared.EntityCapability( purpose=[ - '535d6bf8-fcc1-4de0-b32d-65715210cf50', + '76391618-2360-49a0-98c5-8211d87549e8', ], attributes=[ - [], + shared.CurrencyAttribute( + purpose=[ + 'e05451ea-976b-47aa-8556-cbb2f4955baf', + ], + constraints=shared.CurrencyAttributeConstraints(), + currency=[ + shared.CurrencyAttributeCurrency1( + code='Road', + description='Operative bi-directional extranet', + symbol='concerning', + ), + ], + feature_flag='FF_MY_FEATURE_FLAG', + info_helpers=shared.CurrencyAttributeInfoHelpers( + hint_tooltip_placement='top', + ), + label='optimizing', + layout='full_width', + name='sievert', + order=0, + setting_flag='MY_SETTING', + type=shared.CurrencyAttributeType.CURRENCY, + ), ], feature_flag='FF_MY_FEATURE_FLAG', - legacy=False, name='customer_messaging', setting_flag='MY_SETTING', title='Messaging', ui_hooks=[ { - "modi": 'Home', + "Berkshire": 'Hybrid', }, ], ), ], dialog_config={ - "eveniet": 'Strategist', + "harden": 'Practical', }, draft=False, enable_setting=[ - '360_features', + '3', + '6', + '0', + '_', + 'f', + 'e', + 'a', + 't', + 'u', + 'r', + 'e', + 's', ], explicit_search_mappings={ - "vel": shared.SearchMappings( + "image": shared.SearchMappings( fields_={ - "distinctio": 'warmly', + "Classical": 'Distributed', }, - index=False, - type=shared.SearchMappingsType.TEXT, ), }, feature_flag='FF_MY_FEATURE_FLAG', group_settings=[ shared.EntitySchemaGroupSettings( purpose=[ - '0dd287b6-15b3-4e0e-a8c6-d1668543e4eb', + '9a93bb27-212d-48fe-b517-f7f32d0d1a32', ], - expanded=False, feature_flag='FF_MY_FEATURE_FLAG', id='', - info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle( - default='Wooden', - key='', - ), - label='deposit Pakistan XSS', - order=834474, + info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle(), + label='Koruna Zimbabwe', + render_condition='_is_composite_price = "false"', + setting_flag='MY_SETTING', + ), + shared.EntitySchemaGroupSettings( + purpose=[ + '65b8f4f0-c08e-4211-8d68-3456c3d852ff', + ], + feature_flag='FF_MY_FEATURE_FLAG', + id='', + info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle(), + label='mint 4th', render_condition='_is_composite_price = "false"', setting_flag='MY_SETTING', ), ], icon='person', layout_settings={ - "aut": 'protocol', + "surmise": 'Direct', }, name='Contact', plural='Contacts', @@ -330,22 +460,26 @@ req = operations.PutSchemaRequest( slug='contact', title_template='{{first_name}} {{last_name}}', ui_config=shared.EntitySchemaUIConfig( - create_view=[], - edit_view=[], + shared.RedirectEntityView( + route='/app/pricing-hub/product/:entityId', + ), + shared.EntityViewDisabled(), list_item=shared.EntitySchemaUIConfigListItem( summary_attributes=[ - [], + 'email', ], ), sharing=shared.EntitySchemaUIConfigSharing( show_sharing_button=True, ), - single_view=[], - table_view=[], + shared.RedirectEntityView( + route='/app/pricing-hub/product/:entityId', + ), + shared.RedirectEntityView( + route='/app/pricing-hub/product/:entityId', + ), ), - version=784166, ), - draft=False, slug='contact', ) diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index cf0efc2ea..a3a4e7446 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -140,9 +140,7 @@ s = epilot.Epilot( ) req = operations.TaxonomyAutocompleteRequest( - query='Polarised optio Hybrid', - size=7186.02, - taxonomy_slug='Ball', + taxonomy_slug='Polarised optio Hybrid', ) res = s.taxonomy.taxonomy_autocomplete(req) @@ -184,31 +182,25 @@ req = operations.UpdateClassificationsForTaxonomyRequest( classifications_update=shared.ClassificationsUpdate( create=[ shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2023-01-29T09:39:45.161Z'), - id='4e342f29-dee0-402b-8415-ef6fe03f06e9', name='Wallbox PV', parents=[ - '998bd322-c31e-42b7-b181-91a2c6ad60b4', + 'b4e342f2-9dee-4002-bc41-5ef6fe03f06e', ], - updated_at=dateutil.parser.isoparse('2021-07-20T21:22:16.417Z'), ), ], delete=[ - '062aff2d-f8b9-4512-81f6-8f95bbd35ce8', + '9998bd32-2c31-4e2b-b318-191a2c6ad60b', ], update=[ shared.TaxonomyClassification( - created_at=dateutil.parser.isoparse('2023-06-17T13:37:21.887Z'), - id='b159c7e2-9866-4889-9ce5-7236fb33115f', name='Wallbox PV', parents=[ - 'c5f1737e-932d-42ff-8b5b-7733cd73fa8c', + '42062aff-2df8-4b95-9241-f68f95bbd35c', ], - updated_at=dateutil.parser.isoparse('2021-03-21T21:08:25.425Z'), ), ], ), - taxonomy_slug='flexibility Cadillac North', + taxonomy_slug='transmitting female Polarised', ) res = s.taxonomy.update_classifications_for_taxonomy(req) diff --git a/entity/gen.yaml b/entity/gen.yaml index 4dc05c820..59635a341 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,9 +1,9 @@ configVersion: 1.0.0 management: - docChecksum: 04ee18f572d4803fa7729fff6d391c34 + docChecksum: f8fda659e78397d7d3ffdf366a682493 docVersion: 1.0.0 - speakeasyVersion: 1.94.0 - generationVersion: 2.147.0 + speakeasyVersion: 1.96.1 + generationVersion: 2.150.0 generation: sdkClassName: epilot sdkFlattening: true @@ -11,12 +11,13 @@ generation: telemetryEnabled: false features: python: - core: 2.88.2 - globalSecurity: 2.81.1 + core: 2.88.4 + globalSecurity: 2.82.0 globalServerURLs: 2.82.0 python: - version: 1.26.2 + version: 1.27.0 author: epilot description: Python Client SDK for Epilot + flattenGlobalSecurity: false maxMethodParams: 0 packageName: epilot-entity diff --git a/entity/setup.py b/entity/setup.py index 5bccf93c6..b9ff9ebc8 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.26.2", + version="1.27.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/__init__.py b/entity/src/epilot/models/__init__.py index 889f8adcf..36628d6cc 100755 --- a/entity/src/epilot/models/__init__.py +++ b/entity/src/epilot/models/__init__.py @@ -1,2 +1,3 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" +# __init__.py diff --git a/entity/src/epilot/models/operations/getrelatedentitiescount.py b/entity/src/epilot/models/operations/getrelatedentitiescount.py index 1132df2e2..7a508f30b 100755 --- a/entity/src/epilot/models/operations/getrelatedentitiescount.py +++ b/entity/src/epilot/models/operations/getrelatedentitiescount.py @@ -14,6 +14,8 @@ class GetRelatedEntitiesCountRequest: r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Schema""" + exclude_schemas: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'exclude_schemas', 'style': 'form', 'explode': False }}) + r"""To be excluded from the count by given schemas""" diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py index 708c2a5dc..7dd835213 100755 --- a/entity/src/epilot/models/operations/getrelations.py +++ b/entity/src/epilot/models/operations/getrelations.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import getrelationsresp as shared_getrelationsresp from ..shared import relationitem as shared_relationitem -from typing import Any, Optional, Union +from typing import Optional, Union diff --git a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py index e0f082009..e2c60ff0f 100755 --- a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py +++ b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py @@ -2,10 +2,11 @@ from __future__ import annotations import dataclasses +from ..shared import getrelationsresp as shared_getrelationsresp from ..shared import relationitem as shared_relationitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional, Union +from typing import Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py index f11837545..ecbedde5d 100755 --- a/entity/src/epilot/relations.py +++ b/entity/src/epilot/relations.py @@ -3,7 +3,7 @@ from .sdkconfiguration import SDKConfiguration from epilot import utils from epilot.models import errors, operations, shared -from typing import Any, Optional, Union +from typing import Optional, Union class Relations: r"""Entity Relationships""" @@ -76,12 +76,13 @@ def get_related_entities_count(self, request: operations.GetRelatedEntitiesCount url = utils.generate_url(operations.GetRelatedEntitiesCountRequest, base_url, '/v2/entity/{slug}/{id}/relations/count', request) headers = {} + query_params = utils.get_query_params(operations.GetRelatedEntitiesCountRequest, request) headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client - http_res = client.request('GET', url, headers=headers) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetRelatedEntitiesCountResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) diff --git a/entity/src/epilot/sdk.py b/entity/src/epilot/sdk.py index 5e8e22ac2..e403e04dd 100755 --- a/entity/src/epilot/sdk.py +++ b/entity/src/epilot/sdk.py @@ -39,7 +39,7 @@ class Epilot: sdk_configuration: SDKConfiguration def __init__(self, - security: shared.Security = None, + epilot_auth: str, server_idx: int = None, server_url: str = None, url_params: dict[str, str] = None, @@ -48,8 +48,8 @@ def __init__(self, ) -> None: """Instantiates the SDK configuring it with the provided parameters. - :param security: The security details required for authentication - :type security: shared.Security + :param epilot_auth: The epilot_auth required for authentication + :type epilot_auth: str :param server_idx: The index of the server to use for all operations :type server_idx: int :param server_url: The server URL to use for all operations @@ -64,8 +64,10 @@ def __init__(self, if client is None: client = requests_http.Session() + security_client = utils.configure_security_client(client, security) + if server_url is not None: if url_params is not None: server_url = utils.template_url(server_url, url_params) diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index bc248983e..01cd84281 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,9 +19,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.26.2' - gen_version: str = '2.147.0' - user_agent: str = 'speakeasy-sdk/python 1.26.2 2.147.0 1.0.0 epilot-entity' + sdk_version: str = '1.27.0' + gen_version: str = '2.150.0' + user_agent: str = 'speakeasy-sdk/python 1.27.0 2.150.0 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: From f076d9f2bcfdf111c5fbbbc26eaee0231cff9f1c Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 13 Oct 2023 01:16:27 +0000 Subject: [PATCH 47/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.99.1 --- entity/README.md | 1 + entity/RELEASES.md | 10 +++- entity/USAGE.md | 1 + .../models/operations/addrelationsrequest.md | 6 +- .../models/operations/addrelationsresponse.md | 6 +- .../operations/attachactivityrequest.md | 2 +- .../operations/attachactivityresponse.md | 6 +- .../autocomplete200applicationjson.md | 8 +-- .../models/operations/autocompleterequest.md | 2 +- .../models/operations/autocompleteresponse.md | 12 ++-- .../operations/createactivityrequest.md | 2 +- .../operations/createactivityresponse.md | 6 +- .../models/operations/createentityrequest.md | 2 +- .../models/operations/createentityresponse.md | 4 +- .../operations/createsavedviewresponse.md | 6 +- .../models/operations/deleteentityrequest.md | 4 +- .../models/operations/deleteentityresponse.md | 4 +- .../operations/deleterelationrequest.md | 8 +-- .../operations/deleterelationresponse.md | 4 +- .../operations/deletesavedviewrequest.md | 2 +- .../operations/deletesavedviewresponse.md | 4 +- .../models/operations/deleteschemarequest.md | 2 +- .../models/operations/deleteschemaresponse.md | 4 +- .../operations/exportentitiesrequest.md | 12 ++-- .../operations/exportentitiesresponse.md | 4 +- .../models/operations/getactivityrequest.md | 2 +- .../models/operations/getactivityresponse.md | 6 +- ...getentityactivityfeed200applicationjson.md | 8 +-- .../getentityactivityfeedrequest.md | 4 +- .../getentityactivityfeedresponse.md | 12 ++-- .../models/operations/getentityrequest.md | 4 +- .../models/operations/getentityresponse.md | 12 ++-- .../getrelatedentitiescountrequest.md | 4 +- .../getrelatedentitiescountresponse.md | 12 ++-- .../models/operations/getrelationsrequest.md | 4 +- .../models/operations/getrelationsresponse.md | 12 ++-- .../operations/getrelationsv2request.md | 4 +- .../operations/getrelationsv2response.md | 12 ++-- .../getsavedview200applicationjson.md | 6 +- .../models/operations/getsavedviewrequest.md | 2 +- .../models/operations/getsavedviewresponse.md | 12 ++-- .../models/operations/getschemarequest.md | 2 +- .../models/operations/getschemaresponse.md | 6 +- .../getschemaversions200applicationjson.md | 8 +-- .../operations/getschemaversionsrequest.md | 2 +- .../operations/getschemaversionsresponse.md | 12 ++-- .../models/operations/gettaxonomyrequest.md | 2 +- .../models/operations/gettaxonomyresponse.md | 6 +- .../operations/importentitiesrequest.md | 2 +- .../operations/importentitiesresponse.md | 4 +- ...tfavoriteviewsforuser200applicationjson.md | 6 +- .../listfavoriteviewsforuserresponse.md | 12 ++-- .../listsavedviews200applicationjson.md | 6 +- .../operations/listsavedviewsresponse.md | 12 ++-- .../listschemablueprints200applicationjson.md | 6 +- .../listschemablueprintsresponse.md | 12 ++-- .../listschemas200applicationjson.md | 6 +- .../models/operations/listschemasresponse.md | 12 ++-- .../listtaxonomies200applicationjson.md | 6 +- .../operations/listtaxonomiesresponse.md | 12 ++-- ...ssificationsforschema200applicationjson.md | 6 +- ...taxonomyclassificationsforschemarequest.md | 4 +- ...axonomyclassificationsforschemaresponse.md | 12 ++-- .../models/operations/patchentityrequest.md | 4 +- .../models/operations/patchentityresponse.md | 4 +- .../models/operations/putschemarequest.md | 10 ++-- .../models/operations/putschemaresponse.md | 6 +- .../operations/searchentitiesresponse.md | 14 ++--- ...classificationssearch200applicationjson.md | 6 +- .../taxonomiesclassificationssearchrequest.md | 8 +-- ...taxonomiesclassificationssearchresponse.md | 12 ++-- .../taxonomyautocomplete200applicationjson.md | 6 +- .../operations/taxonomyautocompleterequest.md | 2 +- .../taxonomyautocompleteresponse.md | 12 ++-- ...ificationsfortaxonomy200applicationjson.md | 10 ++-- ...updateclassificationsfortaxonomyrequest.md | 8 +-- ...pdateclassificationsfortaxonomyresponse.md | 12 ++-- .../models/operations/updateentityrequest.md | 4 +- .../models/operations/updateentityresponse.md | 4 +- .../operations/updaterelationrequest.md | 18 +++--- .../operations/updaterelationresponse.md | 6 +- .../operations/updatesavedviewrequest.md | 8 +-- .../operations/updatesavedviewresponse.md | 6 +- .../models/operations/upsertentityrequest.md | 14 ++--- .../models/operations/upsertentityresponse.md | 4 +- entity/docs/models/shared/activity.md | 6 +- entity/docs/models/shared/activityitem.md | 22 ++++---- .../models/shared/addressrelationattribute.md | 10 ++-- .../docs/models/shared/automationattribute.md | 10 ++-- entity/docs/models/shared/booleanattribute.md | 10 ++-- .../models/shared/classificationsupdate.md | 10 ++-- .../docs/models/shared/computedattribute.md | 10 ++-- entity/docs/models/shared/consentattribute.md | 12 ++-- entity/docs/models/shared/countryattribute.md | 10 ++-- .../docs/models/shared/currencyattribute.md | 12 ++-- .../shared/currencyattributecurrency1.md | 6 +- entity/docs/models/shared/dateattribute.md | 10 ++-- entity/docs/models/shared/entitycapability.md | 20 +++---- .../docs/models/shared/entitydefaultcreate.md | 10 ++-- .../docs/models/shared/entitydefaultedit.md | 12 ++-- .../docs/models/shared/entitydefaulttable.md | 16 +++--- .../entitydefaulttabledropdownitems1.md | 12 ++-- .../entitydefaulttabledropdownitems2.md | 14 ++--- .../shared/entitydefaulttablenavbaractions.md | 8 +-- .../entitydefaulttablenavbaractionsoptions.md | 8 +-- .../docs/models/shared/entityimportparams.md | 8 +-- .../shared/entityimportparamss3reference.md | 4 +- entity/docs/models/shared/entityoperation.md | 18 +++--- entity/docs/models/shared/entityschema.md | 40 ++++++------- .../shared/entityschemagroupsettings.md | 22 ++++---- entity/docs/models/shared/entityschemaitem.md | 50 ++++++++--------- .../shared/entityschemaitemgroupsettings.md | 22 ++++---- .../models/shared/entityschemaitemuiconfig.md | 16 +++--- .../entityschemaitemuiconfiglistitem.md | 6 +- .../models/shared/entityschemauiconfig.md | 16 +++--- .../shared/entityschemauiconfiglistitem.md | 6 +- .../docs/models/shared/entitysearchparams.md | 4 +- .../docs/models/shared/entitysearchresults.md | 10 ++-- .../docs/models/shared/entityviewdisabled.md | 6 +- entity/docs/models/shared/fileattribute.md | 12 ++-- .../shared/getrelationsrespwithpagination.md | 8 +-- .../docs/models/shared/internalattribute.md | 10 ++-- .../models/shared/internaluserattribute.md | 10 ++-- .../models/shared/invitationemailattribute.md | 10 ++-- entity/docs/models/shared/linkattribute.md | 10 ++-- .../models/shared/multiselectattribute.md | 12 ++-- .../shared/multiselectattributeoptions2.md | 2 +- entity/docs/models/shared/numberattribute.md | 10 ++-- .../models/shared/orderedlistattribute.md | 10 ++-- .../shared/partnerorganisationattribute.md | 10 ++-- .../models/shared/partnerstatusattribute.md | 10 ++-- .../shared/paymentmethodrelationattribute.md | 10 ++-- entity/docs/models/shared/purposeattribute.md | 10 ++-- .../docs/models/shared/redirectentityview.md | 8 +-- .../docs/models/shared/relationattribute.md | 22 ++++---- .../models/shared/relationattributeactions.md | 2 +- entity/docs/models/shared/relationitem.md | 4 +- .../docs/models/shared/repeatableattribute.md | 12 ++-- entity/docs/models/shared/savedview.md | 18 +++--- entity/docs/models/shared/savedviewitem.md | 24 ++++---- entity/docs/models/shared/searchmappings.md | 10 ++-- entity/docs/models/shared/selectattribute.md | 12 ++-- .../models/shared/selectattributeoptions1.md | 2 +- .../docs/models/shared/sequenceattribute.md | 10 ++-- entity/docs/models/shared/statusattribute.md | 12 ++-- .../models/shared/statusattributeoptions2.md | 2 +- entity/docs/models/shared/summaryattribute.md | 4 +- entity/docs/models/shared/tagsattribute.md | 10 ++-- entity/docs/models/shared/taxonomy.md | 4 +- .../models/shared/taxonomyclassification.md | 2 +- entity/docs/models/shared/textattribute.md | 10 ++-- .../models/shared/userrelationattribute.md | 10 ++-- entity/docs/sdks/activity/README.md | 4 ++ entity/docs/sdks/entities/README.md | 56 +++++++++++-------- entity/docs/sdks/entityimport/README.md | 1 + entity/docs/sdks/export/README.md | 1 + entity/docs/sdks/relations/README.md | 6 ++ entity/docs/sdks/savedviews/README.md | 6 ++ entity/docs/sdks/schemas/README.md | 7 +++ entity/docs/sdks/taxonomy/README.md | 5 ++ entity/gen.yaml | 8 +-- entity/setup.py | 2 +- entity/src/epilot/sdk.py | 6 +- entity/src/epilot/sdkconfiguration.py | 6 +- 164 files changed, 748 insertions(+), 700 deletions(-) diff --git a/entity/README.md b/entity/README.md index 3a2781ef6..748d57418 100755 --- a/entity/README.md +++ b/entity/README.md @@ -31,6 +31,7 @@ res = s.activity.attach_activity(req) if res.activity_item is not None: # handle response + pass ``` diff --git a/entity/RELEASES.md b/entity/RELEASES.md index d4e78548a..5dca99917 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -348,4 +348,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.96.1 (2.150.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.27.0] entity \ No newline at end of file +- [python v1.27.0] entity + +## 2023-10-13 01:15:59 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.99.1 (2.154.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.27.1] entity \ No newline at end of file diff --git a/entity/USAGE.md b/entity/USAGE.md index bfd2656de..24193e39b 100755 --- a/entity/USAGE.md +++ b/entity/USAGE.md @@ -22,5 +22,6 @@ res = s.activity.attach_activity(req) if res.activity_item is not None: # handle response + pass ``` \ No newline at end of file diff --git a/entity/docs/models/operations/addrelationsrequest.md b/entity/docs/models/operations/addrelationsrequest.md index 510a3cf42..62a5f2a79 100755 --- a/entity/docs/models/operations/addrelationsrequest.md +++ b/entity/docs/models/operations/addrelationsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `request_body` | list[[shared.RelationItem](undefined/models/shared/relationitem.md)] | :heavy_minus_sign: | N/A | | +| `request_body` | list[[shared.RelationItem](../../models/shared/relationitem.md)] | :heavy_minus_sign: | N/A | | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/addrelationsresponse.md b/entity/docs/models/operations/addrelationsresponse.md index f76081ed8..6001b8933 100755 --- a/entity/docs/models/operations/addrelationsresponse.md +++ b/entity/docs/models/operations/addrelationsresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `relation_item` | [Optional[shared.RelationItem]](undefined/models/shared/relationitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `relation_item` | [Optional[shared.RelationItem]](../../models/shared/relationitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/attachactivityrequest.md b/entity/docs/models/operations/attachactivityrequest.md index 865fab626..871cb14d9 100755 --- a/entity/docs/models/operations/attachactivityrequest.md +++ b/entity/docs/models/operations/attachactivityrequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | | `entities` | list[*str*] | :heavy_minus_sign: | Comma-separated list of entities which the activity primarily concerns | | -| `id` | *Optional[str]* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | \ No newline at end of file diff --git a/entity/docs/models/operations/attachactivityresponse.md b/entity/docs/models/operations/attachactivityresponse.md index a30861e02..78ed39dc2 100755 --- a/entity/docs/models/operations/attachactivityresponse.md +++ b/entity/docs/models/operations/attachactivityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `activity_item` | [Optional[shared.ActivityItem]](undefined/models/shared/activityitem.md) | :heavy_minus_sign: | Success | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/autocomplete200applicationjson.md b/entity/docs/models/operations/autocomplete200applicationjson.md index f9064063f..a897a266e 100755 --- a/entity/docs/models/operations/autocomplete200applicationjson.md +++ b/entity/docs/models/operations/autocomplete200applicationjson.md @@ -5,7 +5,7 @@ Success ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `results` | list[[Union[str, bool, dict[str, Any]]](undefined/models/operations/autocomplete200applicationjsonresults.md)] | :heavy_minus_sign: | N/A | value | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `results` | list[[Union[str, bool, dict[str, Any]]](../../models/operations/autocomplete200applicationjsonresults.md)] | :heavy_minus_sign: | N/A | value | \ No newline at end of file diff --git a/entity/docs/models/operations/autocompleterequest.md b/entity/docs/models/operations/autocompleterequest.md index a349ef863..788da2934 100755 --- a/entity/docs/models/operations/autocompleterequest.md +++ b/entity/docs/models/operations/autocompleterequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `attribute` | *Optional[str]* | :heavy_check_mark: | Autocomplete attribute | _tags | +| `attribute` | *str* | :heavy_check_mark: | Autocomplete attribute | _tags | | `input` | *Optional[str]* | :heavy_minus_sign: | Input to autocomplete | | | `size` | *Optional[int]* | :heavy_minus_sign: | Maximum number of results to return | | | `slug` | *Optional[str]* | :heavy_minus_sign: | Limit results to entity schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/autocompleteresponse.md b/entity/docs/models/operations/autocompleteresponse.md index d3fa102a4..8f820dff9 100755 --- a/entity/docs/models/operations/autocompleteresponse.md +++ b/entity/docs/models/operations/autocompleteresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `autocomplete_200_application_json_object` | [Optional[operations.Autocomplete200ApplicationJSON]](undefined/models/operations/autocomplete200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `autocomplete_200_application_json_object` | [Optional[Autocomplete200ApplicationJSON]](../../models/operations/autocomplete200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/createactivityrequest.md b/entity/docs/models/operations/createactivityrequest.md index f573d69cc..eaf600128 100755 --- a/entity/docs/models/operations/createactivityrequest.md +++ b/entity/docs/models/operations/createactivityrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `activity` | [Optional[shared.Activity]](undefined/models/shared/activity.md) | :heavy_minus_sign: | N/A | +| `activity` | [Optional[shared.Activity]](../../models/shared/activity.md) | :heavy_minus_sign: | N/A | | `entities` | list[*str*] | :heavy_minus_sign: | Comma-separated list of entities which the activity primarily concerns | \ No newline at end of file diff --git a/entity/docs/models/operations/createactivityresponse.md b/entity/docs/models/operations/createactivityresponse.md index 7f865e4b4..81bd58bde 100755 --- a/entity/docs/models/operations/createactivityresponse.md +++ b/entity/docs/models/operations/createactivityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `activity_item` | [Optional[shared.ActivityItem]](undefined/models/shared/activityitem.md) | :heavy_minus_sign: | Success | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityrequest.md b/entity/docs/models/operations/createentityrequest.md index 254df7400..d305f3547 100755 --- a/entity/docs/models/operations/createentityrequest.md +++ b/entity/docs/models/operations/createentityrequest.md @@ -8,4 +8,4 @@ | `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityresponse.md b/entity/docs/models/operations/createentityresponse.md index 93057ee30..fc7d204a7 100755 --- a/entity/docs/models/operations/createentityresponse.md +++ b/entity/docs/models/operations/createentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | [object Object] | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/entity/docs/models/operations/createsavedviewresponse.md b/entity/docs/models/operations/createsavedviewresponse.md index aa4a3373a..c40e1dc1e 100755 --- a/entity/docs/models/operations/createsavedviewresponse.md +++ b/entity/docs/models/operations/createsavedviewresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `saved_view_item` | [Optional[shared.SavedViewItem]](undefined/models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `saved_view_item` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteentityrequest.md b/entity/docs/models/operations/deleteentityrequest.md index bf61df601..2d034cf52 100755 --- a/entity/docs/models/operations/deleteentityrequest.md +++ b/entity/docs/models/operations/deleteentityrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `id` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | N/A | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteentityresponse.md b/entity/docs/models/operations/deleteentityresponse.md index b1dfc7456..1ff556201 100755 --- a/entity/docs/models/operations/deleteentityresponse.md +++ b/entity/docs/models/operations/deleteentityresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deleterelationrequest.md b/entity/docs/models/operations/deleterelationrequest.md index d84a3467a..e20e7c9a2 100755 --- a/entity/docs/models/operations/deleterelationrequest.md +++ b/entity/docs/models/operations/deleterelationrequest.md @@ -7,7 +7,7 @@ | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `attribute` | *Optional[str]* | :heavy_check_mark: | The attribute that express meaning | | -| `entity_id` | *Optional[str]* | :heavy_check_mark: | The attribute that express meaning | | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `attribute` | *str* | :heavy_check_mark: | The attribute that express meaning | | +| `entity_id` | *str* | :heavy_check_mark: | The attribute that express meaning | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleterelationresponse.md b/entity/docs/models/operations/deleterelationresponse.md index d32bf6719..1c6ddb31d 100755 --- a/entity/docs/models/operations/deleterelationresponse.md +++ b/entity/docs/models/operations/deleterelationresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deletesavedviewrequest.md b/entity/docs/models/operations/deletesavedviewrequest.md index 1d3561a75..2d3befa8e 100755 --- a/entity/docs/models/operations/deletesavedviewrequest.md +++ b/entity/docs/models/operations/deletesavedviewrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *Optional[str]* | :heavy_check_mark: | View id | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | View id | \ No newline at end of file diff --git a/entity/docs/models/operations/deletesavedviewresponse.md b/entity/docs/models/operations/deletesavedviewresponse.md index af2d5652b..1be59ea6d 100755 --- a/entity/docs/models/operations/deletesavedviewresponse.md +++ b/entity/docs/models/operations/deletesavedviewresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteschemarequest.md b/entity/docs/models/operations/deleteschemarequest.md index f10f3f9e6..6de6bc920 100755 --- a/entity/docs/models/operations/deleteschemarequest.md +++ b/entity/docs/models/operations/deleteschemarequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `slug` | *Optional[str]* | :heavy_check_mark: | N/A | contact | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteschemaresponse.md b/entity/docs/models/operations/deleteschemaresponse.md index 5cf6b25f3..9c6e1c201 100755 --- a/entity/docs/models/operations/deleteschemaresponse.md +++ b/entity/docs/models/operations/deleteschemaresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/exportentitiesrequest.md b/entity/docs/models/operations/exportentitiesrequest.md index 8992b8c65..7143d4571 100755 --- a/entity/docs/models/operations/exportentitiesrequest.md +++ b/entity/docs/models/operations/exportentitiesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `entity_search_params` | [Optional[shared.EntitySearchParams]](undefined/models/shared/entitysearchparams.md) | :heavy_minus_sign: | N/A | | -| `is_template` | *Optional[bool]* | :heavy_minus_sign: | Pass 'true' to generate import template | | -| `job_id` | *Optional[str]* | :heavy_minus_sign: | Export Job Id to get the result | abc123 | -| `language` | *Optional[str]* | :heavy_minus_sign: | Export headers translation language | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `entity_search_params` | [Optional[shared.EntitySearchParams]](../../models/shared/entitysearchparams.md) | :heavy_minus_sign: | N/A | | +| `is_template` | *Optional[bool]* | :heavy_minus_sign: | Pass 'true' to generate import template | | +| `job_id` | *Optional[str]* | :heavy_minus_sign: | Export Job Id to get the result | abc123 | +| `language` | *Optional[str]* | :heavy_minus_sign: | Export headers translation language | | \ No newline at end of file diff --git a/entity/docs/models/operations/exportentitiesresponse.md b/entity/docs/models/operations/exportentitiesresponse.md index 029251b45..f5039e620 100755 --- a/entity/docs/models/operations/exportentitiesresponse.md +++ b/entity/docs/models/operations/exportentitiesresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getactivityrequest.md b/entity/docs/models/operations/getactivityrequest.md index 98bc760da..b0e3dff9a 100755 --- a/entity/docs/models/operations/getactivityrequest.md +++ b/entity/docs/models/operations/getactivityrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `id` | *Optional[str]* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `id` | *str* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | | `operations_from` | *Optional[int]* | :heavy_minus_sign: | Pagination offset for operations
| | | `operations_size` | *Optional[int]* | :heavy_minus_sign: | Maximum number of operations to include in response (default: 10)
| | \ No newline at end of file diff --git a/entity/docs/models/operations/getactivityresponse.md b/entity/docs/models/operations/getactivityresponse.md index ec2307279..98ce41384 100755 --- a/entity/docs/models/operations/getactivityresponse.md +++ b/entity/docs/models/operations/getactivityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `activity_item` | [Optional[shared.ActivityItem]](undefined/models/shared/activityitem.md) | :heavy_minus_sign: | Success | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `activity_item` | [Optional[shared.ActivityItem]](../../models/shared/activityitem.md) | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeed200applicationjson.md b/entity/docs/models/operations/getentityactivityfeed200applicationjson.md index cf21468ea..607e07ad4 100755 --- a/entity/docs/models/operations/getentityactivityfeed200applicationjson.md +++ b/entity/docs/models/operations/getentityactivityfeed200applicationjson.md @@ -5,7 +5,7 @@ Success ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `results` | list[[shared.ActivityItem](undefined/models/shared/activityitem.md)] | :heavy_minus_sign: | N/A | | -| `total` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `results` | list[[shared.ActivityItem](../../models/shared/activityitem.md)] | :heavy_minus_sign: | N/A | | +| `total` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeedrequest.md b/entity/docs/models/operations/getentityactivityfeedrequest.md index 402e8b244..f60f393f5 100755 --- a/entity/docs/models/operations/getentityactivityfeedrequest.md +++ b/entity/docs/models/operations/getentityactivityfeedrequest.md @@ -8,8 +8,8 @@ | `after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Get activities after this timestamp | | | `before` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | get activities before this timestamp | | | `from_` | *Optional[int]* | :heavy_minus_sign: | start from page | | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | +| `id` | *str* | :heavy_check_mark: | Entity id | | | `include_relations` | *Optional[bool]* | :heavy_minus_sign: | Include activities from related entities | | | `size` | *Optional[int]* | :heavy_minus_sign: | max number of results to return | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | | `type` | *Optional[str]* | :heavy_minus_sign: | Filter by activity type | SyncActivity | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeedresponse.md b/entity/docs/models/operations/getentityactivityfeedresponse.md index 21bf4c76c..79a167013 100755 --- a/entity/docs/models/operations/getentityactivityfeedresponse.md +++ b/entity/docs/models/operations/getentityactivityfeedresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `get_entity_activity_feed_200_application_json_object` | [Optional[operations.GetEntityActivityFeed200ApplicationJSON]](undefined/models/operations/getentityactivityfeed200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_entity_activity_feed_200_application_json_object` | [Optional[GetEntityActivityFeed200ApplicationJSON]](../../models/operations/getentityactivityfeed200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityrequest.md b/entity/docs/models/operations/getentityrequest.md index 7f1b2917e..3b1f862d1 100755 --- a/entity/docs/models/operations/getentityrequest.md +++ b/entity/docs/models/operations/getentityrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityresponse.md b/entity/docs/models/operations/getentityresponse.md index f02495a3d..51acec577 100755 --- a/entity/docs/models/operations/getentityresponse.md +++ b/entity/docs/models/operations/getentityresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `get_entity_200_application_json_object` | [Optional[operations.GetEntity200ApplicationJSON]](undefined/models/operations/getentity200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_entity_200_application_json_object` | [Optional[GetEntity200ApplicationJSON]](../../models/operations/getentity200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelatedentitiescountrequest.md b/entity/docs/models/operations/getrelatedentitiescountrequest.md index 702f679fa..eedab1bf4 100755 --- a/entity/docs/models/operations/getrelatedentitiescountrequest.md +++ b/entity/docs/models/operations/getrelatedentitiescountrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | | `exclude_schemas` | list[*str*] | :heavy_minus_sign: | To be excluded from the count by given schemas | | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelatedentitiescountresponse.md b/entity/docs/models/operations/getrelatedentitiescountresponse.md index 66ac4874b..a930915f4 100755 --- a/entity/docs/models/operations/getrelatedentitiescountresponse.md +++ b/entity/docs/models/operations/getrelatedentitiescountresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `get_related_entities_count` | [Optional[shared.GetRelatedEntitiesCount]](undefined/models/shared/getrelatedentitiescount.md) | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `get_related_entities_count` | [Optional[shared.GetRelatedEntitiesCount]](../../models/shared/getrelatedentitiescount.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsrequest.md b/entity/docs/models/operations/getrelationsrequest.md index 18b8140ea..b0b69507e 100755 --- a/entity/docs/models/operations/getrelationsrequest.md +++ b/entity/docs/models/operations/getrelationsrequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | +| `id` | *str* | :heavy_check_mark: | Entity id | | | `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsresponse.md b/entity/docs/models/operations/getrelationsresponse.md index ae2352419..148425e2d 100755 --- a/entity/docs/models/operations/getrelationsresponse.md +++ b/entity/docs/models/operations/getrelationsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `get_relations_resp` | list[[Union[shared.RelationItem, dict[str, Any]]](undefined/models/shared/getrelationsresp.md)] | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `get_relations_resp` | list[[Union[shared.RelationItem, dict[str, Any]]](../../models/shared/getrelationsresp.md)] | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv2request.md b/entity/docs/models/operations/getrelationsv2request.md index 289f3e1a2..6f87b432c 100755 --- a/entity/docs/models/operations/getrelationsv2request.md +++ b/entity/docs/models/operations/getrelationsv2request.md @@ -8,8 +8,8 @@ | `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in results | _id,_schema,_title | | `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | +| `id` | *str* | :heavy_check_mark: | Entity id | | | `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | | `query` | *Optional[str]* | :heavy_minus_sign: | Input to filter search results | | | `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv2response.md b/entity/docs/models/operations/getrelationsv2response.md index 0c79d5668..1f3d24b91 100755 --- a/entity/docs/models/operations/getrelationsv2response.md +++ b/entity/docs/models/operations/getrelationsv2response.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `get_relations_resp_with_pagination` | [Optional[shared.GetRelationsRespWithPagination]](undefined/models/shared/getrelationsrespwithpagination.md) | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `get_relations_resp_with_pagination` | [Optional[shared.GetRelationsRespWithPagination]](../../models/shared/getrelationsrespwithpagination.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getsavedview200applicationjson.md b/entity/docs/models/operations/getsavedview200applicationjson.md index c15701787..882160635 100755 --- a/entity/docs/models/operations/getsavedview200applicationjson.md +++ b/entity/docs/models/operations/getsavedview200applicationjson.md @@ -5,6 +5,6 @@ Success ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `view` | [Optional[shared.SavedViewItem]](undefined/models/shared/savedviewitem.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `view` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getsavedviewrequest.md b/entity/docs/models/operations/getsavedviewrequest.md index 65b452d43..926155d37 100755 --- a/entity/docs/models/operations/getsavedviewrequest.md +++ b/entity/docs/models/operations/getsavedviewrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *Optional[str]* | :heavy_check_mark: | View id | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | View id | \ No newline at end of file diff --git a/entity/docs/models/operations/getsavedviewresponse.md b/entity/docs/models/operations/getsavedviewresponse.md index db006a0d1..84207c031 100755 --- a/entity/docs/models/operations/getsavedviewresponse.md +++ b/entity/docs/models/operations/getsavedviewresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `get_saved_view_200_application_json_object` | [Optional[operations.GetSavedView200ApplicationJSON]](undefined/models/operations/getsavedview200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_saved_view_200_application_json_object` | [Optional[GetSavedView200ApplicationJSON]](../../models/operations/getsavedview200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemarequest.md b/entity/docs/models/operations/getschemarequest.md index 6bbc61c91..8c26cdd5c 100755 --- a/entity/docs/models/operations/getschemarequest.md +++ b/entity/docs/models/operations/getschemarequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `slug` | *Optional[str]* | :heavy_check_mark: | N/A | contact | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaresponse.md b/entity/docs/models/operations/getschemaresponse.md index 6d9464322..7c661e329 100755 --- a/entity/docs/models/operations/getschemaresponse.md +++ b/entity/docs/models/operations/getschemaresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `entity_schema_item` | [Optional[shared.EntitySchemaItem]](undefined/models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `entity_schema_item` | [Optional[shared.EntitySchemaItem]](../../models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversions200applicationjson.md b/entity/docs/models/operations/getschemaversions200applicationjson.md index 3198da5ab..c04fd28b3 100755 --- a/entity/docs/models/operations/getschemaversions200applicationjson.md +++ b/entity/docs/models/operations/getschemaversions200applicationjson.md @@ -5,7 +5,7 @@ Success ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `drafts` | list[[shared.EntitySchemaItem](undefined/models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | -| `versions` | list[[shared.EntitySchemaItem](undefined/models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `drafts` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | +| `versions` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversionsrequest.md b/entity/docs/models/operations/getschemaversionsrequest.md index f8b163844..64d754a5d 100755 --- a/entity/docs/models/operations/getschemaversionsrequest.md +++ b/entity/docs/models/operations/getschemaversionsrequest.md @@ -7,6 +7,6 @@ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | `drafts_from` | *Optional[float]* | :heavy_minus_sign: | N/A | | | `drafts_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `slug` | *Optional[str]* | :heavy_check_mark: | N/A | contact | +| `slug` | *str* | :heavy_check_mark: | N/A | contact | | `versions_from` | *Optional[float]* | :heavy_minus_sign: | N/A | | | `versions_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversionsresponse.md b/entity/docs/models/operations/getschemaversionsresponse.md index cea3fdfbe..16df859a3 100755 --- a/entity/docs/models/operations/getschemaversionsresponse.md +++ b/entity/docs/models/operations/getschemaversionsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `get_schema_versions_200_application_json_object` | [Optional[operations.GetSchemaVersions200ApplicationJSON]](undefined/models/operations/getschemaversions200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_schema_versions_200_application_json_object` | [Optional[GetSchemaVersions200ApplicationJSON]](../../models/operations/getschemaversions200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/gettaxonomyrequest.md b/entity/docs/models/operations/gettaxonomyrequest.md index a9b3bb19e..32f13f4e2 100755 --- a/entity/docs/models/operations/gettaxonomyrequest.md +++ b/entity/docs/models/operations/gettaxonomyrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `taxonomy_slug` | *Optional[str]* | :heavy_check_mark: | Taxonomy slug to return taxonomy for | purpose | \ No newline at end of file +| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug to return taxonomy for | purpose | \ No newline at end of file diff --git a/entity/docs/models/operations/gettaxonomyresponse.md b/entity/docs/models/operations/gettaxonomyresponse.md index c30704d86..c4407cd22 100755 --- a/entity/docs/models/operations/gettaxonomyresponse.md +++ b/entity/docs/models/operations/gettaxonomyresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `taxonomy` | [Optional[shared.Taxonomy]](undefined/models/shared/taxonomy.md) | :heavy_minus_sign: | Taxonomy | \ No newline at end of file +| `taxonomy` | [Optional[shared.Taxonomy]](../../models/shared/taxonomy.md) | :heavy_minus_sign: | Taxonomy | \ No newline at end of file diff --git a/entity/docs/models/operations/importentitiesrequest.md b/entity/docs/models/operations/importentitiesrequest.md index 252acfba1..29780c4c1 100755 --- a/entity/docs/models/operations/importentitiesrequest.md +++ b/entity/docs/models/operations/importentitiesrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `entity_import_params` | [Optional[shared.EntityImportParams]](undefined/models/shared/entityimportparams.md) | :heavy_minus_sign: | N/A | | +| `entity_import_params` | [Optional[shared.EntityImportParams]](../../models/shared/entityimportparams.md) | :heavy_minus_sign: | N/A | | | `job_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the import job. This ID is used to track the progress and fetch the result of the import operation. | abc123 | \ No newline at end of file diff --git a/entity/docs/models/operations/importentitiesresponse.md b/entity/docs/models/operations/importentitiesresponse.md index c42fdd72c..39f37b821 100755 --- a/entity/docs/models/operations/importentitiesresponse.md +++ b/entity/docs/models/operations/importentitiesresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md b/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md index 348ffd044..c0ef2ddef 100755 --- a/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md +++ b/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md @@ -5,6 +5,6 @@ Success ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `results` | list[[shared.SavedViewItem](undefined/models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `results` | list[[shared.SavedViewItem](../../models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listfavoriteviewsforuserresponse.md b/entity/docs/models/operations/listfavoriteviewsforuserresponse.md index 746ba5ed3..b857e12ff 100755 --- a/entity/docs/models/operations/listfavoriteviewsforuserresponse.md +++ b/entity/docs/models/operations/listfavoriteviewsforuserresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_favorite_views_for_user_200_application_json_object` | [Optional[operations.ListFavoriteViewsForUser200ApplicationJSON]](undefined/models/operations/listfavoriteviewsforuser200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_favorite_views_for_user_200_application_json_object` | [Optional[ListFavoriteViewsForUser200ApplicationJSON]](../../models/operations/listfavoriteviewsforuser200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listsavedviews200applicationjson.md b/entity/docs/models/operations/listsavedviews200applicationjson.md index 0ee868680..1b3bd47f5 100755 --- a/entity/docs/models/operations/listsavedviews200applicationjson.md +++ b/entity/docs/models/operations/listsavedviews200applicationjson.md @@ -5,6 +5,6 @@ Success ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `results` | list[[shared.SavedViewItem](undefined/models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `results` | list[[shared.SavedViewItem](../../models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listsavedviewsresponse.md b/entity/docs/models/operations/listsavedviewsresponse.md index 832a17d60..89fb9157e 100755 --- a/entity/docs/models/operations/listsavedviewsresponse.md +++ b/entity/docs/models/operations/listsavedviewsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_saved_views_200_application_json_object` | [Optional[operations.ListSavedViews200ApplicationJSON]](undefined/models/operations/listsavedviews200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_saved_views_200_application_json_object` | [Optional[ListSavedViews200ApplicationJSON]](../../models/operations/listsavedviews200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemablueprints200applicationjson.md b/entity/docs/models/operations/listschemablueprints200applicationjson.md index f530ec086..57d194fdb 100755 --- a/entity/docs/models/operations/listschemablueprints200applicationjson.md +++ b/entity/docs/models/operations/listschemablueprints200applicationjson.md @@ -5,6 +5,6 @@ Success ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `results` | list[[shared.EntitySchemaItem](undefined/models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `results` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemablueprintsresponse.md b/entity/docs/models/operations/listschemablueprintsresponse.md index 80802dea3..779aa958f 100755 --- a/entity/docs/models/operations/listschemablueprintsresponse.md +++ b/entity/docs/models/operations/listschemablueprintsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_schema_blueprints_200_application_json_object` | [Optional[operations.ListSchemaBlueprints200ApplicationJSON]](undefined/models/operations/listschemablueprints200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_schema_blueprints_200_application_json_object` | [Optional[ListSchemaBlueprints200ApplicationJSON]](../../models/operations/listschemablueprints200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemas200applicationjson.md b/entity/docs/models/operations/listschemas200applicationjson.md index 8fe7da9dc..fd7595402 100755 --- a/entity/docs/models/operations/listschemas200applicationjson.md +++ b/entity/docs/models/operations/listschemas200applicationjson.md @@ -5,6 +5,6 @@ Success ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `results` | list[[shared.EntitySchemaItem](undefined/models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `results` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemasresponse.md b/entity/docs/models/operations/listschemasresponse.md index 75a8e6bd0..000d9c8e2 100755 --- a/entity/docs/models/operations/listschemasresponse.md +++ b/entity/docs/models/operations/listschemasresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_schemas_200_application_json_object` | [Optional[operations.ListSchemas200ApplicationJSON]](undefined/models/operations/listschemas200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_schemas_200_application_json_object` | [Optional[ListSchemas200ApplicationJSON]](../../models/operations/listschemas200applicationjson.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomies200applicationjson.md b/entity/docs/models/operations/listtaxonomies200applicationjson.md index 6d82508e2..57b6fab4c 100755 --- a/entity/docs/models/operations/listtaxonomies200applicationjson.md +++ b/entity/docs/models/operations/listtaxonomies200applicationjson.md @@ -5,6 +5,6 @@ Returns list of taxonomies in an organisation ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `results` | list[[shared.Taxonomy](undefined/models/shared/taxonomy.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `results` | list[[shared.Taxonomy](../../models/shared/taxonomy.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomiesresponse.md b/entity/docs/models/operations/listtaxonomiesresponse.md index 2e5c00523..781676fee 100755 --- a/entity/docs/models/operations/listtaxonomiesresponse.md +++ b/entity/docs/models/operations/listtaxonomiesresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_taxonomies_200_application_json_object` | [Optional[operations.ListTaxonomies200ApplicationJSON]](undefined/models/operations/listtaxonomies200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomies in an organisation | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_taxonomies_200_application_json_object` | [Optional[ListTaxonomies200ApplicationJSON]](../../models/operations/listtaxonomies200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomies in an organisation | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md b/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md index 42e6ae878..9bee2d403 100755 --- a/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md @@ -5,6 +5,6 @@ List of taxonomy classifications ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `results` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md index 828968736..9e1d16f97 100755 --- a/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md @@ -7,5 +7,5 @@ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | `query` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `size` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `slug` | *Optional[str]* | :heavy_check_mark: | N/A | contact | -| `taxonomy_slug` | *Optional[str]* | :heavy_check_mark: | N/A | purpose | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | N/A | contact | +| `taxonomy_slug` | *str* | :heavy_check_mark: | N/A | purpose | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md index a48dff834..c31eb9a54 100755 --- a/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschemaresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `list_taxonomy_classifications_for_schema_200_application_json_object` | [Optional[operations.ListTaxonomyClassificationsForSchema200ApplicationJSON]](undefined/models/operations/listtaxonomyclassificationsforschema200applicationjson.md) | :heavy_minus_sign: | List of taxonomy classifications | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `list_taxonomy_classifications_for_schema_200_application_json_object` | [Optional[ListTaxonomyClassificationsForSchema200ApplicationJSON]](../../models/operations/listtaxonomyclassificationsforschema200applicationjson.md) | :heavy_minus_sign: | List of taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/patchentityrequest.md b/entity/docs/models/operations/patchentityrequest.md index 3b932dc13..61815599d 100755 --- a/entity/docs/models/operations/patchentityrequest.md +++ b/entity/docs/models/operations/patchentityrequest.md @@ -9,5 +9,5 @@ | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for the patch entity to become available in Search API. Useful for large migrations | | | `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = returns the patch result but doesn't perform the patch. | | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity Id | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | Entity Id | | +| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/patchentityresponse.md b/entity/docs/models/operations/patchentityresponse.md index d22bfd47e..467382ce7 100755 --- a/entity/docs/models/operations/patchentityresponse.md +++ b/entity/docs/models/operations/patchentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | [object Object] | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/entity/docs/models/operations/putschemarequest.md b/entity/docs/models/operations/putschemarequest.md index 2b2102ed8..c9a028b63 100755 --- a/entity/docs/models/operations/putschemarequest.md +++ b/entity/docs/models/operations/putschemarequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `entity_schema` | [Optional[shared.EntitySchema]](undefined/models/shared/entityschema.md) | :heavy_minus_sign: | N/A | | -| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `slug` | *Optional[str]* | :heavy_check_mark: | N/A | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `entity_schema` | [Optional[shared.EntitySchema]](../../models/shared/entityschema.md) | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/putschemaresponse.md b/entity/docs/models/operations/putschemaresponse.md index 0e1de68dd..1a7de73be 100755 --- a/entity/docs/models/operations/putschemaresponse.md +++ b/entity/docs/models/operations/putschemaresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `entity_schema_item` | [Optional[shared.EntitySchemaItem]](undefined/models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `entity_schema_item` | [Optional[shared.EntitySchemaItem]](../../models/shared/entityschemaitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/searchentitiesresponse.md b/entity/docs/models/operations/searchentitiesresponse.md index 0b5135c92..99f85991b 100755 --- a/entity/docs/models/operations/searchentitiesresponse.md +++ b/entity/docs/models/operations/searchentitiesresponse.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `entity_search_results` | [Optional[shared.EntitySearchResults]](undefined/models/shared/entitysearchresults.md) | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `search_entities_200_text_csv_string` | *Optional[str]* | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `entity_search_results` | [Optional[shared.EntitySearchResults]](../../models/shared/entitysearchresults.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `search_entities_200_text_csv_string` | *Optional[str]* | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md b/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md index 690c86d9d..5338757ad 100755 --- a/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md +++ b/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md @@ -5,6 +5,6 @@ Returns list of taxonomy classifications ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `results` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md b/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md index 12dd4bd6b..72c3d46d5 100755 --- a/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md +++ b/entity/docs/models/operations/taxonomiesclassificationssearchrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `request_body` | [Optional[operations.TaxonomiesClassificationsSearchRequestBody]](undefined/models/operations/taxonomiesclassificationssearchrequestbody.md) | :heavy_minus_sign: | N/A | -| `taxonomy_slug` | *Optional[str]* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[TaxonomiesClassificationsSearchRequestBody]](../../models/operations/taxonomiesclassificationssearchrequestbody.md) | :heavy_minus_sign: | N/A | +| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md b/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md index 05462f09f..90328113f 100755 --- a/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md +++ b/entity/docs/models/operations/taxonomiesclassificationssearchresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `taxonomies_classifications_search_200_application_json_object` | [Optional[operations.TaxonomiesClassificationsSearch200ApplicationJSON]](undefined/models/operations/taxonomiesclassificationssearch200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomy classifications | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `taxonomies_classifications_search_200_application_json_object` | [Optional[TaxonomiesClassificationsSearch200ApplicationJSON]](../../models/operations/taxonomiesclassificationssearch200applicationjson.md) | :heavy_minus_sign: | Returns list of taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md b/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md index bb9f710a8..697d86e3b 100755 --- a/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md +++ b/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md @@ -5,6 +5,6 @@ Taxonomy classifications ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `results` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocompleterequest.md b/entity/docs/models/operations/taxonomyautocompleterequest.md index b0ccee272..5a8b57d23 100755 --- a/entity/docs/models/operations/taxonomyautocompleterequest.md +++ b/entity/docs/models/operations/taxonomyautocompleterequest.md @@ -7,4 +7,4 @@ | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | | `query` | *Optional[str]* | :heavy_minus_sign: | Input to autocomplete | | `size` | *Optional[float]* | :heavy_minus_sign: | Minimum number of results to return | -| `taxonomy_slug` | *Optional[str]* | :heavy_check_mark: | Limit results to slug | \ No newline at end of file +| `taxonomy_slug` | *str* | :heavy_check_mark: | Limit results to slug | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocompleteresponse.md b/entity/docs/models/operations/taxonomyautocompleteresponse.md index 73f9f929b..fb8e9b28c 100755 --- a/entity/docs/models/operations/taxonomyautocompleteresponse.md +++ b/entity/docs/models/operations/taxonomyautocompleteresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `taxonomy_autocomplete_200_application_json_object` | [Optional[operations.TaxonomyAutocomplete200ApplicationJSON]](undefined/models/operations/taxonomyautocomplete200applicationjson.md) | :heavy_minus_sign: | Taxonomy classifications | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `taxonomy_autocomplete_200_application_json_object` | [Optional[TaxonomyAutocomplete200ApplicationJSON]](../../models/operations/taxonomyautocomplete200applicationjson.md) | :heavy_minus_sign: | Taxonomy classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md index 11d503bf4..4518623a3 100755 --- a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md +++ b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md @@ -5,8 +5,8 @@ Taxonomies classifications ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | -| `deleted` | [Optional[operations.UpdateClassificationsForTaxonomy200ApplicationJSONDeleted]](undefined/models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md) | :heavy_minus_sign: | N/A | -| `updated` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `created` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | +| `deleted` | [Optional[UpdateClassificationsForTaxonomy200ApplicationJSONDeleted]](../../models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md) | :heavy_minus_sign: | N/A | +| `updated` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md b/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md index bf89060b3..900518fe5 100755 --- a/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md +++ b/entity/docs/models/operations/updateclassificationsfortaxonomyrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `classifications_update` | [Optional[shared.ClassificationsUpdate]](undefined/models/shared/classificationsupdate.md) | :heavy_minus_sign: | N/A | -| `taxonomy_slug` | *Optional[str]* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `classifications_update` | [Optional[shared.ClassificationsUpdate]](../../models/shared/classificationsupdate.md) | :heavy_minus_sign: | N/A | +| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md b/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md index 689b6da6b..7bde6558d 100755 --- a/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md +++ b/entity/docs/models/operations/updateclassificationsfortaxonomyresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | -| `update_classifications_for_taxonomy_200_application_json_object` | [Optional[operations.UpdateClassificationsForTaxonomy200ApplicationJSON]](undefined/models/operations/updateclassificationsfortaxonomy200applicationjson.md) | :heavy_minus_sign: | Taxonomies classifications | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `update_classifications_for_taxonomy_200_application_json_object` | [Optional[UpdateClassificationsForTaxonomy200ApplicationJSON]](../../models/operations/updateclassificationsfortaxonomy200applicationjson.md) | :heavy_minus_sign: | Taxonomies classifications | \ No newline at end of file diff --git a/entity/docs/models/operations/updateentityrequest.md b/entity/docs/models/operations/updateentityrequest.md index edee3da30..5ef553cce 100755 --- a/entity/docs/models/operations/updateentityrequest.md +++ b/entity/docs/models/operations/updateentityrequest.md @@ -8,5 +8,5 @@ | `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/updateentityresponse.md b/entity/docs/models/operations/updateentityresponse.md index 0389562f9..57160b4e0 100755 --- a/entity/docs/models/operations/updateentityresponse.md +++ b/entity/docs/models/operations/updateentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | [object Object] | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/entity/docs/models/operations/updaterelationrequest.md b/entity/docs/models/operations/updaterelationrequest.md index 3a90f4f27..f7302c10e 100755 --- a/entity/docs/models/operations/updaterelationrequest.md +++ b/entity/docs/models/operations/updaterelationrequest.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `request_body` | [Optional[operations.UpdateRelationRequestBody]](undefined/models/operations/updaterelationrequestbody.md) | :heavy_minus_sign: | N/A | | -| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `attribute` | *Optional[str]* | :heavy_check_mark: | The attribute that express meaning | | -| `entity_id` | *Optional[str]* | :heavy_check_mark: | The attribute that express meaning | | -| `id` | *Optional[str]* | :heavy_check_mark: | Entity id | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[UpdateRelationRequestBody]](../../models/operations/updaterelationrequestbody.md) | :heavy_minus_sign: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `attribute` | *str* | :heavy_check_mark: | The attribute that express meaning | | +| `entity_id` | *str* | :heavy_check_mark: | The attribute that express meaning | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/updaterelationresponse.md b/entity/docs/models/operations/updaterelationresponse.md index c98fc1049..5d2853163 100755 --- a/entity/docs/models/operations/updaterelationresponse.md +++ b/entity/docs/models/operations/updaterelationresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `relation_item` | [Optional[shared.RelationItem]](undefined/models/shared/relationitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `relation_item` | [Optional[shared.RelationItem]](../../models/shared/relationitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/updatesavedviewrequest.md b/entity/docs/models/operations/updatesavedviewrequest.md index 2ef3070b0..6ffa26a00 100755 --- a/entity/docs/models/operations/updatesavedviewrequest.md +++ b/entity/docs/models/operations/updatesavedviewrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `saved_view` | [Optional[shared.SavedView]](undefined/models/shared/savedview.md) | :heavy_minus_sign: | N/A | -| `id` | *Optional[str]* | :heavy_check_mark: | View id | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `saved_view` | [Optional[shared.SavedView]](../../models/shared/savedview.md) | :heavy_minus_sign: | N/A | +| `id` | *str* | :heavy_check_mark: | View id | \ No newline at end of file diff --git a/entity/docs/models/operations/updatesavedviewresponse.md b/entity/docs/models/operations/updatesavedviewresponse.md index 2fa831d23..583681685 100755 --- a/entity/docs/models/operations/updatesavedviewresponse.md +++ b/entity/docs/models/operations/updatesavedviewresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | -| `saved_view_item` | [Optional[shared.SavedViewItem]](undefined/models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `saved_view_item` | [Optional[shared.SavedViewItem]](../../models/shared/savedviewitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityrequest.md b/entity/docs/models/operations/upsertentityrequest.md index 83137b212..b531e76f2 100755 --- a/entity/docs/models/operations/upsertentityrequest.md +++ b/entity/docs/models/operations/upsertentityrequest.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `request_body` | [Optional[operations.UpsertEntityRequestBody]](undefined/models/operations/upsertentityrequestbody.md) | :heavy_minus_sign: | N/A | | -| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = return matched entities but don't update them. | | -| `slug` | *Optional[str]* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[UpsertEntityRequestBody]](../../models/operations/upsertentityrequestbody.md) | :heavy_minus_sign: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = return matched entities but don't update them. | | +| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityresponse.md b/entity/docs/models/operations/upsertentityresponse.md index 60c3de8fc..54b3556e9 100755 --- a/entity/docs/models/operations/upsertentityresponse.md +++ b/entity/docs/models/operations/upsertentityresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *Optional[str]* | :heavy_check_mark: | HTTP response content type for this operation | | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | | `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | [object Object] | -| `status_code` | *Optional[int]* | :heavy_check_mark: | HTTP response status code for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/entity/docs/models/shared/activity.md b/entity/docs/models/shared/activity.md index 6c42333cd..7265c71e2 100755 --- a/entity/docs/models/shared/activity.md +++ b/entity/docs/models/shared/activity.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `message` | *Optional[str]* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | +| `message` | *str* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | | `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | -| `title` | *Optional[str]* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | -| `type` | *Optional[str]* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file +| `title` | *str* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | +| `type` | *str* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file diff --git a/entity/docs/models/shared/activityitem.md b/entity/docs/models/shared/activityitem.md index 0d48abd94..8e541d6b5 100755 --- a/entity/docs/models/shared/activityitem.md +++ b/entity/docs/models/shared/activityitem.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `caller` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `message` | *Optional[str]* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | -| `operations` | list[[shared.EntityOperation](undefined/models/shared/entityoperation.md)] | :heavy_minus_sign: | N/A | | -| `operations_total` | *Optional[int]* | :heavy_minus_sign: | Count of total operations attached to this activity | 1 | -| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | -| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | -| `title` | *Optional[str]* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | -| `type` | *Optional[str]* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `caller` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `message` | *str* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | +| `operations` | list[[EntityOperation](../../models/shared/entityoperation.md)] | :heavy_minus_sign: | N/A | | +| `operations_total` | *Optional[int]* | :heavy_minus_sign: | Count of total operations attached to this activity | 1 | +| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | +| `title` | *str* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | +| `type` | *str* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattribute.md b/entity/docs/models/shared/addressrelationattribute.md index d7c2b8906..a7b8382bd 100755 --- a/entity/docs/models/shared/addressrelationattribute.md +++ b/entity/docs/models/shared/addressrelationattribute.md @@ -8,7 +8,7 @@ Reference to an address attribute of another entity | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.AddressRelationAttributeConstraints]](undefined/models/shared/addressrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[AddressRelationAttributeConstraints]](../../models/shared/addressrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -18,10 +18,10 @@ Reference to an address attribute of another entity | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.AddressRelationAttributeInfoHelpers]](undefined/models/shared/addressrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[AddressRelationAttributeInfoHelpers]](../../models/shared/addressrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ Reference to an address attribute of another entity | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.AddressRelationAttributeType]](undefined/models/shared/addressrelationattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[AddressRelationAttributeType]](../../models/shared/addressrelationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/automationattribute.md b/entity/docs/models/shared/automationattribute.md index 407c76b47..f0806752c 100755 --- a/entity/docs/models/shared/automationattribute.md +++ b/entity/docs/models/shared/automationattribute.md @@ -8,7 +8,7 @@ Automation entity | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.AutomationAttributeConstraints]](undefined/models/shared/automationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[AutomationAttributeConstraints]](../../models/shared/automationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Automation entity | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.AutomationAttributeInfoHelpers]](undefined/models/shared/automationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[AutomationAttributeInfoHelpers]](../../models/shared/automationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Automation entity | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.AutomationAttributeType]](undefined/models/shared/automationattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[AutomationAttributeType]](../../models/shared/automationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/booleanattribute.md b/entity/docs/models/shared/booleanattribute.md index 1df93b1b6..83a502ad8 100755 --- a/entity/docs/models/shared/booleanattribute.md +++ b/entity/docs/models/shared/booleanattribute.md @@ -8,7 +8,7 @@ Yes / No Toggle | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.BooleanAttributeConstraints]](undefined/models/shared/booleanattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[BooleanAttributeConstraints]](../../models/shared/booleanattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Yes / No Toggle | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.BooleanAttributeInfoHelpers]](undefined/models/shared/booleanattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[BooleanAttributeInfoHelpers]](../../models/shared/booleanattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Yes / No Toggle | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.BooleanAttributeType]](undefined/models/shared/booleanattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[BooleanAttributeType]](../../models/shared/booleanattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/classificationsupdate.md b/entity/docs/models/shared/classificationsupdate.md index dfdb2ba28..b54b24277 100755 --- a/entity/docs/models/shared/classificationsupdate.md +++ b/entity/docs/models/shared/classificationsupdate.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `create` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | -| `delete` | list[*str*] | :heavy_minus_sign: | N/A | -| `update` | list[[shared.TaxonomyClassification](undefined/models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `create` | list[[TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | +| `delete` | list[*str*] | :heavy_minus_sign: | N/A | +| `update` | list[[TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattribute.md b/entity/docs/models/shared/computedattribute.md index de4376b89..ea4891fac 100755 --- a/entity/docs/models/shared/computedattribute.md +++ b/entity/docs/models/shared/computedattribute.md @@ -8,7 +8,7 @@ An attribute that is computed from the entity data. For more details on how to u | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.ComputedAttributeConstraints]](undefined/models/shared/computedattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[ComputedAttributeConstraints]](../../models/shared/computedattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ An attribute that is computed from the entity data. For more details on how to u | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.ComputedAttributeInfoHelpers]](undefined/models/shared/computedattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[ComputedAttributeInfoHelpers]](../../models/shared/computedattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ An attribute that is computed from the entity data. For more details on how to u | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.ComputedAttributeType]](undefined/models/shared/computedattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[ComputedAttributeType]](../../models/shared/computedattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/consentattribute.md b/entity/docs/models/shared/consentattribute.md index 3c75d0284..375da754a 100755 --- a/entity/docs/models/shared/consentattribute.md +++ b/entity/docs/models/shared/consentattribute.md @@ -8,7 +8,7 @@ Consent Management | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.ConsentAttributeConstraints]](undefined/models/shared/consentattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[ConsentAttributeConstraints]](../../models/shared/consentattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -18,10 +18,10 @@ Consent Management | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | | `identifiers` | list[*str*] | :heavy_minus_sign: | N/A | | -| `info_helpers` | [Optional[shared.ConsentAttributeInfoHelpers]](undefined/models/shared/consentattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[ConsentAttributeInfoHelpers]](../../models/shared/consentattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,6 +32,6 @@ Consent Management | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `topic` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `type` | [Optional[shared.ConsentAttributeType]](undefined/models/shared/consentattributetype.md) | :heavy_check_mark: | N/A | | +| `topic` | *str* | :heavy_check_mark: | N/A | | +| `type` | [ConsentAttributeType](../../models/shared/consentattributetype.md) | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/countryattribute.md b/entity/docs/models/shared/countryattribute.md index 2bc09598e..d734f6d41 100755 --- a/entity/docs/models/shared/countryattribute.md +++ b/entity/docs/models/shared/countryattribute.md @@ -8,7 +8,7 @@ Country picker | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.CountryAttributeConstraints]](undefined/models/shared/countryattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[CountryAttributeConstraints]](../../models/shared/countryattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Country picker | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.CountryAttributeInfoHelpers]](undefined/models/shared/countryattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[CountryAttributeInfoHelpers]](../../models/shared/countryattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Country picker | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.CountryAttributeType]](undefined/models/shared/countryattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[CountryAttributeType]](../../models/shared/countryattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattribute.md b/entity/docs/models/shared/currencyattribute.md index 78cc3e255..566e91a01 100755 --- a/entity/docs/models/shared/currencyattribute.md +++ b/entity/docs/models/shared/currencyattribute.md @@ -8,8 +8,8 @@ Currency input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.CurrencyAttributeConstraints]](undefined/models/shared/currencyattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | -| `currency` | list[[Union[shared.CurrencyAttributeCurrency1]](undefined/models/shared/currencyattributecurrency.md)] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | +| `constraints` | [Optional[CurrencyAttributeConstraints]](../../models/shared/currencyattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `currency` | list[[Union[CurrencyAttributeCurrency1]](../../models/shared/currencyattributecurrency.md)] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | | `currency_selector_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | @@ -19,10 +19,10 @@ Currency input | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.CurrencyAttributeInfoHelpers]](undefined/models/shared/currencyattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[CurrencyAttributeInfoHelpers]](../../models/shared/currencyattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -33,5 +33,5 @@ Currency input | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.CurrencyAttributeType]](undefined/models/shared/currencyattributetype.md) | :heavy_check_mark: | N/A | | +| `type` | [CurrencyAttributeType](../../models/shared/currencyattributetype.md) | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/currencyattributecurrency1.md b/entity/docs/models/shared/currencyattributecurrency1.md index f7d2526a5..8a470028f 100755 --- a/entity/docs/models/shared/currencyattributecurrency1.md +++ b/entity/docs/models/shared/currencyattributecurrency1.md @@ -7,7 +7,7 @@ A currency configuration | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *Optional[str]* | :heavy_check_mark: | N/A | -| `description` | *Optional[str]* | :heavy_check_mark: | N/A | +| `code` | *str* | :heavy_check_mark: | N/A | +| `description` | *str* | :heavy_check_mark: | N/A | | `flag` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `symbol` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `symbol` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/dateattribute.md b/entity/docs/models/shared/dateattribute.md index 218fd7ddc..43649e651 100755 --- a/entity/docs/models/shared/dateattribute.md +++ b/entity/docs/models/shared/dateattribute.md @@ -8,7 +8,7 @@ Date or Datetime picker | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.DateAttributeConstraints]](undefined/models/shared/dateattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[DateAttributeConstraints]](../../models/shared/dateattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Date or Datetime picker | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.DateAttributeInfoHelpers]](undefined/models/shared/dateattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[DateAttributeInfoHelpers]](../../models/shared/dateattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Date or Datetime picker | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.DateAttributeType]](undefined/models/shared/dateattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[DateAttributeType]](../../models/shared/dateattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitycapability.md b/entity/docs/models/shared/entitycapability.md index 7017f2881..0c39a607d 100755 --- a/entity/docs/models/shared/entitycapability.md +++ b/entity/docs/models/shared/entitycapability.md @@ -5,13 +5,13 @@ Capabilities the Entity has. Turn features on/off for entities. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `attributes` | list[[Union[shared.TextAttribute, shared.LinkAttribute, shared.DateAttribute, shared.CountryAttribute, shared.BooleanAttribute, shared.SelectAttribute, shared.MultiSelectAttribute, shared.StatusAttribute, shared.SequenceAttribute, shared.RelationAttribute, shared.UserRelationAttribute, shared.AddressRelationAttribute, shared.PaymentMethodRelationAttribute, shared.CurrencyAttribute, shared.RepeatableAttribute, shared.TagsAttribute, shared.NumberAttribute, shared.ConsentAttribute, shared.InternalAttribute, shared.OrderedListAttribute, shared.FileAttribute, shared.ComputedAttribute, shared.PartnerStatusAttribute, shared.InvitationEmailAttribute, shared.AutomationAttribute, shared.InternalUserAttribute, shared.PurposeAttribute, shared.PartnerOrganisationAttribute]](undefined/models/shared/attribute.md)] | :heavy_minus_sign: | N/A | | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show capability for legacy tenants (ivy) | | -| `name` | *Optional[str]* | :heavy_check_mark: | Unique name for the capability | customer_messaging | -| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the setting is enabled | MY_SETTING | -| `title` | *Optional[str]* | :heavy_minus_sign: | Human readable title of the capability | Messaging | -| `ui_hooks` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_minus_sign: | N/A | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show capability for legacy tenants (ivy) | | +| `name` | *str* | :heavy_check_mark: | Unique name for the capability | customer_messaging | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the setting is enabled | MY_SETTING | +| `title` | *Optional[str]* | :heavy_minus_sign: | Human readable title of the capability | Messaging | +| `ui_hooks` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreate.md b/entity/docs/models/shared/entitydefaultcreate.md index f9ff69793..d4699a2db 100755 --- a/entity/docs/models/shared/entitydefaultcreate.md +++ b/entity/docs/models/shared/entitydefaultcreate.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | -| `table_menu_options` | [Optional[shared.EntityDefaultCreateTableMenuOptions]](undefined/models/shared/entitydefaultcreatetablemenuoptions.md) | :heavy_minus_sign: | N/A | -| `view_type` | [Optional[shared.EntityDefaultCreateViewType]](undefined/models/shared/entitydefaultcreateviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | +| `table_menu_options` | [Optional[EntityDefaultCreateTableMenuOptions]](../../models/shared/entitydefaultcreatetablemenuoptions.md) | :heavy_minus_sign: | N/A | +| `view_type` | [Optional[EntityDefaultCreateViewType]](../../models/shared/entitydefaultcreateviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultedit.md b/entity/docs/models/shared/entitydefaultedit.md index 1001c8aa0..8fa4dcea9 100755 --- a/entity/docs/models/shared/entitydefaultedit.md +++ b/entity/docs/models/shared/entitydefaultedit.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | | -| `summary_attributes` | list[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | email | -| `table_menu_options` | [Optional[shared.EntityDefaultEditTableMenuOptions]](undefined/models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | | -| `view_type` | [Optional[shared.EntityDefaultEditViewType]](undefined/models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | | +| `summary_attributes` | list[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | email | +| `table_menu_options` | [Optional[EntityDefaultEditTableMenuOptions]](../../models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | | +| `view_type` | [Optional[EntityDefaultEditViewType]](../../models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttable.md b/entity/docs/models/shared/entitydefaulttable.md index 5939af26b..4fd442fe1 100755 --- a/entity/docs/models/shared/entitydefaulttable.md +++ b/entity/docs/models/shared/entitydefaulttable.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `classic_view` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `dropdown_items` | list[[Union[shared.EntityDefaultTableDropdownItems1, shared.EntityDefaultTableDropdownItems2]](undefined/models/shared/entitydefaulttabledropdownitems.md)] | :heavy_minus_sign: | N/A | -| `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | -| `navbar_actions` | list[[shared.EntityDefaultTableNavbarActions](undefined/models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | -| `row_actions` | list[*str*] | :heavy_minus_sign: | N/A | -| `view_type` | [Optional[shared.EntityDefaultTableViewType]](undefined/models/shared/entitydefaulttableviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `classic_view` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `dropdown_items` | list[[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]](../../models/shared/entitydefaulttabledropdownitems.md)] | :heavy_minus_sign: | N/A | +| `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | +| `navbar_actions` | list[[EntityDefaultTableNavbarActions](../../models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | +| `row_actions` | list[*str*] | :heavy_minus_sign: | N/A | +| `view_type` | [Optional[EntityDefaultTableViewType]](../../models/shared/entitydefaulttableviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md index f23af8112..1627f2b02 100755 --- a/entity/docs/models/shared/entitydefaulttabledropdownitems1.md +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems1.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `entity` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | -| `type` | [Optional[shared.EntityDefaultTableDropdownItems1Type]](undefined/models/shared/entitydefaulttabledropdownitems1type.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `entity` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | +| `type` | [Optional[EntityDefaultTableDropdownItems1Type]](../../models/shared/entitydefaulttabledropdownitems1type.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md index 57f8ebf54..0dab288f3 100755 --- a/entity/docs/models/shared/entitydefaulttabledropdownitems2.md +++ b/entity/docs/models/shared/entitydefaulttabledropdownitems2.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | -| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Opportunities | -| `type` | [Optional[shared.EntityDefaultTableDropdownItems2Type]](undefined/models/shared/entitydefaulttabledropdownitems2type.md) | :heavy_minus_sign: | N/A | | -| `uri` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This dropdown item should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show item for legacy tenants (ivy) | | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Opportunities | +| `type` | [Optional[EntityDefaultTableDropdownItems2Type]](../../models/shared/entitydefaulttabledropdownitems2type.md) | :heavy_minus_sign: | N/A | | +| `uri` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractions.md b/entity/docs/models/shared/entitydefaulttablenavbaractions.md index 9858f0d20..0d1db344c 100755 --- a/entity/docs/models/shared/entitydefaulttablenavbaractions.md +++ b/entity/docs/models/shared/entitydefaulttablenavbaractions.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `options` | list[[shared.EntityDefaultTableNavbarActionsOptions](undefined/models/shared/entitydefaulttablenavbaractionsoptions.md)] | :heavy_minus_sign: | N/A | -| `type` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `options` | list[[EntityDefaultTableNavbarActionsOptions](../../models/shared/entitydefaulttablenavbaractionsoptions.md)] | :heavy_minus_sign: | N/A | +| `type` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md index 9b00b17b0..31a355818 100755 --- a/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md +++ b/entity/docs/models/shared/entitydefaulttablenavbaractionsoptions.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | -| `params` | [Optional[shared.EntityDefaultTableNavbarActionsOptionsParams]](undefined/models/shared/entitydefaulttablenavbaractionsoptionsparams.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `label` | *str* | :heavy_check_mark: | N/A | +| `params` | [Optional[EntityDefaultTableNavbarActionsOptionsParams]](../../models/shared/entitydefaulttablenavbaractionsoptionsparams.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityimportparams.md b/entity/docs/models/shared/entityimportparams.md index 0b21c75df..c61968d20 100755 --- a/entity/docs/models/shared/entityimportparams.md +++ b/entity/docs/models/shared/entityimportparams.md @@ -5,7 +5,7 @@ The parameters for importing entities. ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `s3_reference` | [Optional[shared.EntityImportParamsS3Reference]](undefined/models/shared/entityimportparamss3reference.md) | :heavy_check_mark: | The S3 bucket and key where the JSON file for import is located. | | -| `schema` | *Optional[str]* | :heavy_check_mark: | The schema of the entities being imported. This must match the schema of the entities on the platform. | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `s3_reference` | [EntityImportParamsS3Reference](../../models/shared/entityimportparamss3reference.md) | :heavy_check_mark: | The S3 bucket and key where the JSON file for import is located. | | +| `schema` | *str* | :heavy_check_mark: | The schema of the entities being imported. This must match the schema of the entities on the platform. | contact | \ No newline at end of file diff --git a/entity/docs/models/shared/entityimportparamss3reference.md b/entity/docs/models/shared/entityimportparamss3reference.md index c45c62831..20d56e6ca 100755 --- a/entity/docs/models/shared/entityimportparamss3reference.md +++ b/entity/docs/models/shared/entityimportparamss3reference.md @@ -7,5 +7,5 @@ The S3 bucket and key where the JSON file for import is located. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `bucket` | *Optional[str]* | :heavy_check_mark: | The name of the S3 bucket where the JSON file for import is stored. | my-bucket | -| `key` | *Optional[str]* | :heavy_check_mark: | The key or path to the JSON file within the S3 bucket. | imports/my-import.json | \ No newline at end of file +| `bucket` | *str* | :heavy_check_mark: | The name of the S3 bucket where the JSON file for import is stored. | my-bucket | +| `key` | *str* | :heavy_check_mark: | The key or path to the JSON file within the S3 bucket. | imports/my-import.json | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperation.md b/entity/docs/models/shared/entityoperation.md index e5bfbb2d9..401354a6f 100755 --- a/entity/docs/models/shared/entityoperation.md +++ b/entity/docs/models/shared/entityoperation.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `activity_id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `diff` | [Optional[shared.EntityOperationDiff]](undefined/models/shared/entityoperationdiff.md) | :heavy_minus_sign: | N/A | | -| `entity` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `operation` | [Optional[shared.EntityOperationOperation]](undefined/models/shared/entityoperationoperation.md) | :heavy_check_mark: | N/A | | -| `org` | *Optional[str]* | :heavy_check_mark: | N/A | 123 | -| `params` | [Optional[shared.EntityOperationParams]](undefined/models/shared/entityoperationparams.md) | :heavy_minus_sign: | N/A | | -| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `diff` | [Optional[EntityOperationDiff]](../../models/shared/entityoperationdiff.md) | :heavy_minus_sign: | N/A | | +| `entity` | *str* | :heavy_check_mark: | N/A | | +| `operation` | [EntityOperationOperation](../../models/shared/entityoperationoperation.md) | :heavy_check_mark: | N/A | | +| `org` | *str* | :heavy_check_mark: | N/A | 123 | +| `params` | [Optional[EntityOperationParams]](../../models/shared/entityoperationparams.md) | :heavy_minus_sign: | N/A | | +| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschema.md b/entity/docs/models/shared/entityschema.md index 764bea018..1b9572f24 100755 --- a/entity/docs/models/shared/entityschema.md +++ b/entity/docs/models/shared/entityschema.md @@ -5,23 +5,23 @@ The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relati ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `attributes` | list[[Union[shared.TextAttribute, shared.LinkAttribute, shared.DateAttribute, shared.CountryAttribute, shared.BooleanAttribute, shared.SelectAttribute, shared.MultiSelectAttribute, shared.StatusAttribute, shared.SequenceAttribute, shared.RelationAttribute, shared.UserRelationAttribute, shared.AddressRelationAttribute, shared.PaymentMethodRelationAttribute, shared.CurrencyAttribute, shared.RepeatableAttribute, shared.TagsAttribute, shared.NumberAttribute, shared.ConsentAttribute, shared.InternalAttribute, shared.OrderedListAttribute, shared.FileAttribute, shared.ComputedAttribute, shared.PartnerStatusAttribute, shared.InvitationEmailAttribute, shared.AutomationAttribute, shared.InternalUserAttribute, shared.PurposeAttribute, shared.PartnerOrganisationAttribute]](undefined/models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] | -| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | -| `capabilities` | list[[shared.EntityCapability](undefined/models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | -| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | 360_features | -| `explicit_search_mappings` | dict[str, [shared.SearchMappings](undefined/models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| [object Object] | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `group_settings` | list[[shared.EntitySchemaGroupSettings](undefined/models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | [object Object],[object Object] | -| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | -| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | -| `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | -| `plural` | *Optional[str]* | :heavy_check_mark: | N/A | Contacts | -| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `slug` | *Optional[str]* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | -| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | -| `ui_config` | [Optional[shared.EntitySchemaUIConfig]](undefined/models/shared/entityschemauiconfig.md) | :heavy_minus_sign: | N/A | | -| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] | +| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | +| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | +| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | 360_features | +| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| [object Object] | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group_settings` | list[[EntitySchemaGroupSettings](../../models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | [object Object],[object Object] | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | +| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | +| `plural` | *str* | :heavy_check_mark: | N/A | Contacts | +| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | +| `ui_config` | [Optional[EntitySchemaUIConfig]](../../models/shared/entityschemauiconfig.md) | :heavy_minus_sign: | N/A | | +| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemagroupsettings.md b/entity/docs/models/shared/entityschemagroupsettings.md index b7c6a17df..22ed11aff 100755 --- a/entity/docs/models/shared/entityschemagroupsettings.md +++ b/entity/docs/models/shared/entityschemagroupsettings.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `id` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `info_tooltip_title` | [Optional[shared.EntitySchemaGroupSettingsInfoTooltipTitle]](undefined/models/shared/entityschemagroupsettingsinfotooltiptitle.md) | :heavy_minus_sign: | N/A | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `order` | *Optional[int]* | :heavy_minus_sign: | Render order of the group | | -| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | -| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the setting is enabled | MY_SETTING | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `info_tooltip_title` | [Optional[EntitySchemaGroupSettingsInfoTooltipTitle]](../../models/shared/entityschemagroupsettingsinfotooltiptitle.md) | :heavy_minus_sign: | N/A | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Render order of the group | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the setting is enabled | MY_SETTING | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitem.md b/entity/docs/models/shared/entityschemaitem.md index 7baa52385..adb7ef7fe 100755 --- a/entity/docs/models/shared/entityschemaitem.md +++ b/entity/docs/models/shared/entityschemaitem.md @@ -5,28 +5,28 @@ The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relati ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `attributes` | list[[Union[shared.TextAttribute, shared.LinkAttribute, shared.DateAttribute, shared.CountryAttribute, shared.BooleanAttribute, shared.SelectAttribute, shared.MultiSelectAttribute, shared.StatusAttribute, shared.SequenceAttribute, shared.RelationAttribute, shared.UserRelationAttribute, shared.AddressRelationAttribute, shared.PaymentMethodRelationAttribute, shared.CurrencyAttribute, shared.RepeatableAttribute, shared.TagsAttribute, shared.NumberAttribute, shared.ConsentAttribute, shared.InternalAttribute, shared.OrderedListAttribute, shared.FileAttribute, shared.ComputedAttribute, shared.PartnerStatusAttribute, shared.InvitationEmailAttribute, shared.AutomationAttribute, shared.InternalUserAttribute, shared.PurposeAttribute, shared.PartnerOrganisationAttribute]](undefined/models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] | -| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | -| `capabilities` | list[[shared.EntityCapability](undefined/models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | -| `comment` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | 360_features | -| `explicit_search_mappings` | dict[str, [shared.SearchMappings](undefined/models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| [object Object] | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `group_settings` | list[[shared.EntitySchemaItemGroupSettings](undefined/models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | [object Object],[object Object] | -| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | -| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for schema | | -| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | -| `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | -| `plural` | *Optional[str]* | :heavy_check_mark: | N/A | Contacts | -| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `slug` | *Optional[str]* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | -| `source` | [Optional[shared.EntitySchemaItemSource]](undefined/models/shared/entityschemaitemsource.md) | :heavy_minus_sign: | N/A | | -| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | -| `ui_config` | [Optional[shared.EntitySchemaItemUIConfig]](undefined/models/shared/entityschemaitemuiconfig.md) | :heavy_minus_sign: | N/A | | -| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] | +| `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | +| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | +| `comment` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | 360_features | +| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| [object Object] | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `group_settings` | list[[EntitySchemaItemGroupSettings](../../models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | [object Object],[object Object] | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | +| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for schema | | +| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | +| `plural` | *str* | :heavy_check_mark: | N/A | Contacts | +| `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `source` | [Optional[EntitySchemaItemSource]](../../models/shared/entityschemaitemsource.md) | :heavy_minus_sign: | N/A | | +| `title_template` | *Optional[str]* | :heavy_minus_sign: | Template for rendering the title field. Uses handlebars | {{first_name}} {{last_name}} | +| `ui_config` | [Optional[EntitySchemaItemUIConfig]](../../models/shared/entityschemaitemuiconfig.md) | :heavy_minus_sign: | N/A | | +| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `version` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemgroupsettings.md b/entity/docs/models/shared/entityschemaitemgroupsettings.md index c16cf1bbc..764606624 100755 --- a/entity/docs/models/shared/entityschemaitemgroupsettings.md +++ b/entity/docs/models/shared/entityschemaitemgroupsettings.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `id` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `info_tooltip_title` | [Optional[shared.EntitySchemaItemGroupSettingsInfoTooltipTitle]](undefined/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md) | :heavy_minus_sign: | N/A | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `order` | *Optional[int]* | :heavy_minus_sign: | Render order of the group | | -| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | -| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the setting is enabled | MY_SETTING | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `info_tooltip_title` | [Optional[EntitySchemaItemGroupSettingsInfoTooltipTitle]](../../models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md) | :heavy_minus_sign: | N/A | | +| `label` | *str* | :heavy_check_mark: | N/A | | +| `order` | *Optional[int]* | :heavy_minus_sign: | Render order of the group | | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the setting is enabled | MY_SETTING | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfig.md b/entity/docs/models/shared/entityschemaitemuiconfig.md index eed4cf516..94301cef2 100755 --- a/entity/docs/models/shared/entityschemaitemuiconfig.md +++ b/entity/docs/models/shared/entityschemaitemuiconfig.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `create_view` | [Optional[Union[shared.EntityDefaultCreate, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemaitemuiconfigcreateview.md) | :heavy_minus_sign: | N/A | -| `edit_view` | [Optional[Union[shared.EntityDefaultEdit, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemaitemuiconfigeditview.md) | :heavy_minus_sign: | N/A | -| `list_item` | [Optional[shared.EntitySchemaItemUIConfigListItem]](undefined/models/shared/entityschemaitemuiconfiglistitem.md) | :heavy_minus_sign: | N/A | -| `sharing` | [Optional[shared.EntitySchemaItemUIConfigSharing]](undefined/models/shared/entityschemaitemuiconfigsharing.md) | :heavy_minus_sign: | N/A | -| `single_view` | [Optional[Union[shared.EntityDefaultEdit, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemaitemuiconfigsingleview.md) | :heavy_minus_sign: | N/A | -| `table_view` | [Optional[Union[shared.EntityDefaultTable, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemaitemuiconfigtableview.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `create_view` | [Optional[Union[EntityDefaultCreate, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigcreateview.md) | :heavy_minus_sign: | N/A | +| `edit_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigeditview.md) | :heavy_minus_sign: | N/A | +| `list_item` | [Optional[EntitySchemaItemUIConfigListItem]](../../models/shared/entityschemaitemuiconfiglistitem.md) | :heavy_minus_sign: | N/A | +| `sharing` | [Optional[EntitySchemaItemUIConfigSharing]](../../models/shared/entityschemaitemuiconfigsharing.md) | :heavy_minus_sign: | N/A | +| `single_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigsingleview.md) | :heavy_minus_sign: | N/A | +| `table_view` | [Optional[Union[EntityDefaultTable, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemaitemuiconfigtableview.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md index 1b1b26ad6..baa96f3e0 100755 --- a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md +++ b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `summary_attributes` | list[[Union[shared.SummaryAttribute, str]](undefined/models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `summary_attributes` | list[[Union[SummaryAttribute, str]](../../models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfig.md b/entity/docs/models/shared/entityschemauiconfig.md index 081ebac9c..246332f95 100755 --- a/entity/docs/models/shared/entityschemauiconfig.md +++ b/entity/docs/models/shared/entityschemauiconfig.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `create_view` | [Optional[Union[shared.EntityDefaultCreate, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemauiconfigcreateview.md) | :heavy_minus_sign: | N/A | -| `edit_view` | [Optional[Union[shared.EntityDefaultEdit, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemauiconfigeditview.md) | :heavy_minus_sign: | N/A | -| `list_item` | [Optional[shared.EntitySchemaUIConfigListItem]](undefined/models/shared/entityschemauiconfiglistitem.md) | :heavy_minus_sign: | N/A | -| `sharing` | [Optional[shared.EntitySchemaUIConfigSharing]](undefined/models/shared/entityschemauiconfigsharing.md) | :heavy_minus_sign: | N/A | -| `single_view` | [Optional[Union[shared.EntityDefaultEdit, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemauiconfigsingleview.md) | :heavy_minus_sign: | N/A | -| `table_view` | [Optional[Union[shared.EntityDefaultTable, shared.RedirectEntityView, shared.EntityViewDisabled]]](undefined/models/shared/entityschemauiconfigtableview.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `create_view` | [Optional[Union[EntityDefaultCreate, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigcreateview.md) | :heavy_minus_sign: | N/A | +| `edit_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigeditview.md) | :heavy_minus_sign: | N/A | +| `list_item` | [Optional[EntitySchemaUIConfigListItem]](../../models/shared/entityschemauiconfiglistitem.md) | :heavy_minus_sign: | N/A | +| `sharing` | [Optional[EntitySchemaUIConfigSharing]](../../models/shared/entityschemauiconfigsharing.md) | :heavy_minus_sign: | N/A | +| `single_view` | [Optional[Union[EntityDefaultEdit, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigsingleview.md) | :heavy_minus_sign: | N/A | +| `table_view` | [Optional[Union[EntityDefaultTable, RedirectEntityView, EntityViewDisabled]]](../../models/shared/entityschemauiconfigtableview.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfiglistitem.md b/entity/docs/models/shared/entityschemauiconfiglistitem.md index 4f06adebf..d55ca9564 100755 --- a/entity/docs/models/shared/entityschemauiconfiglistitem.md +++ b/entity/docs/models/shared/entityschemauiconfiglistitem.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `summary_attributes` | list[[Union[shared.SummaryAttribute, str]](undefined/models/shared/entityschemauiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `summary_attributes` | list[[Union[SummaryAttribute, str]](../../models/shared/entityschemauiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitysearchparams.md b/entity/docs/models/shared/entitysearchparams.md index 1a259b27b..57b2dcef4 100755 --- a/entity/docs/models/shared/entitysearchparams.md +++ b/entity/docs/models/shared/entitysearchparams.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `aggs` | [Optional[shared.EntitySearchParamsAggs]](undefined/models/shared/entitysearchparamsaggs.md) | :heavy_minus_sign: | Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics. | | +| `aggs` | [Optional[EntitySearchParamsAggs]](../../models/shared/entitysearchparamsaggs.md) | :heavy_minus_sign: | Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics. | | | `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in search results | _id,_title,first_name | | `from_` | *Optional[int]* | :heavy_minus_sign: | N/A | | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | | `include_scores` | *Optional[bool]* | :heavy_minus_sign: | Adds a `_score` number field to results that can be used to rank by match score | | -| `q` | *Optional[str]* | :heavy_check_mark: | Lucene queries supported with ElasticSearch | _schema:contact AND status:active | +| `q` | *str* | :heavy_check_mark: | Lucene queries supported with ElasticSearch | _schema:contact AND status:active | | `size` | *Optional[int]* | :heavy_minus_sign: | Max search size is 1000 with higher values defaulting to 1000 | | | `sort` | *Optional[str]* | :heavy_minus_sign: | N/A | _created_at:desc | \ No newline at end of file diff --git a/entity/docs/models/shared/entitysearchresults.md b/entity/docs/models/shared/entitysearchresults.md index 06024d2ab..bc0247253 100755 --- a/entity/docs/models/shared/entitysearchresults.md +++ b/entity/docs/models/shared/entitysearchresults.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `aggregations` | [Optional[shared.EntitySearchResultsAggregations]](undefined/models/shared/entitysearchresultsaggregations.md) | :heavy_minus_sign: | N/A | | -| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `results` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `aggregations` | [Optional[EntitySearchResultsAggregations]](../../models/shared/entitysearchresultsaggregations.md) | :heavy_minus_sign: | N/A | | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `results` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityviewdisabled.md b/entity/docs/models/shared/entityviewdisabled.md index 3b614a38a..bce87a9f8 100755 --- a/entity/docs/models/shared/entityviewdisabled.md +++ b/entity/docs/models/shared/entityviewdisabled.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `view_type` | [Optional[shared.EntityViewDisabledViewType]](undefined/models/shared/entityviewdisabledviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `view_type` | [Optional[EntityViewDisabledViewType]](../../models/shared/entityviewdisabledviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/fileattribute.md b/entity/docs/models/shared/fileattribute.md index d69a52399..f19274b41 100755 --- a/entity/docs/models/shared/fileattribute.md +++ b/entity/docs/models/shared/fileattribute.md @@ -9,8 +9,8 @@ File or Image Attachment | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | | `allowed_extensions` | list[*str*] | :heavy_minus_sign: | List of file extensions (without the dot suffix) | csv | -| `constraints` | [Optional[shared.FileAttributeConstraints]](undefined/models/shared/fileattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | -| `default_access_control` | [Optional[shared.FileAttributeDefaultAccessControl]](undefined/models/shared/fileattributedefaultaccesscontrol.md) | :heavy_minus_sign: | N/A | | +| `constraints` | [Optional[FileAttributeConstraints]](../../models/shared/fileattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `default_access_control` | [Optional[FileAttributeDefaultAccessControl]](../../models/shared/fileattributedefaultaccesscontrol.md) | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `display_images_landscaped` | *Optional[bool]* | :heavy_minus_sign: | Controls how the images are presented to the user during upload on the Entity Details view. | | @@ -21,11 +21,11 @@ File or Image Attachment | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.FileAttributeInfoHelpers]](undefined/models/shared/fileattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[FileAttributeInfoHelpers]](../../models/shared/fileattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `multiple` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -36,5 +36,5 @@ File or Image Attachment | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.FileAttributeType]](undefined/models/shared/fileattributetype.md) | :heavy_check_mark: | N/A | | +| `type` | [FileAttributeType](../../models/shared/fileattributetype.md) | :heavy_check_mark: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/getrelationsrespwithpagination.md b/entity/docs/models/shared/getrelationsrespwithpagination.md index f5cde89e4..37bfbbe33 100755 --- a/entity/docs/models/shared/getrelationsrespwithpagination.md +++ b/entity/docs/models/shared/getrelationsrespwithpagination.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `relations` | list[[Union[shared.RelationItem, dict[str, Any]]](undefined/models/shared/getrelationsresp.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | +| `relations` | list[[Union[RelationItem, dict[str, Any]]](../../models/shared/getrelationsresp.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattribute.md b/entity/docs/models/shared/internalattribute.md index c2ed5d08e..88f5067bd 100755 --- a/entity/docs/models/shared/internalattribute.md +++ b/entity/docs/models/shared/internalattribute.md @@ -8,7 +8,7 @@ No UI representation | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.InternalAttributeConstraints]](undefined/models/shared/internalattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[InternalAttributeConstraints]](../../models/shared/internalattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ No UI representation | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.InternalAttributeInfoHelpers]](undefined/models/shared/internalattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[InternalAttributeInfoHelpers]](../../models/shared/internalattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ No UI representation | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.InternalAttributeType]](undefined/models/shared/internalattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[InternalAttributeType]](../../models/shared/internalattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internaluserattribute.md b/entity/docs/models/shared/internaluserattribute.md index 74cf6d848..03a2edc50 100755 --- a/entity/docs/models/shared/internaluserattribute.md +++ b/entity/docs/models/shared/internaluserattribute.md @@ -8,7 +8,7 @@ Epilot internal user info | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.InternalUserAttributeConstraints]](undefined/models/shared/internaluserattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[InternalUserAttributeConstraints]](../../models/shared/internaluserattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Epilot internal user info | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.InternalUserAttributeInfoHelpers]](undefined/models/shared/internaluserattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[InternalUserAttributeInfoHelpers]](../../models/shared/internaluserattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Epilot internal user info | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.InternalUserAttributeType]](undefined/models/shared/internaluserattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[InternalUserAttributeType]](../../models/shared/internaluserattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/invitationemailattribute.md b/entity/docs/models/shared/invitationemailattribute.md index dd049fc58..3537e8fa1 100755 --- a/entity/docs/models/shared/invitationemailattribute.md +++ b/entity/docs/models/shared/invitationemailattribute.md @@ -8,7 +8,7 @@ Email address for send invitation | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.InvitationEmailAttributeConstraints]](undefined/models/shared/invitationemailattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[InvitationEmailAttributeConstraints]](../../models/shared/invitationemailattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Email address for send invitation | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.InvitationEmailAttributeInfoHelpers]](undefined/models/shared/invitationemailattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[InvitationEmailAttributeInfoHelpers]](../../models/shared/invitationemailattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Email address for send invitation | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.InvitationEmailAttributeType]](undefined/models/shared/invitationemailattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[InvitationEmailAttributeType]](../../models/shared/invitationemailattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/linkattribute.md b/entity/docs/models/shared/linkattribute.md index 588ec7f82..7a898a93b 100755 --- a/entity/docs/models/shared/linkattribute.md +++ b/entity/docs/models/shared/linkattribute.md @@ -8,7 +8,7 @@ Link with title and href | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.LinkAttributeConstraints]](undefined/models/shared/linkattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[LinkAttributeConstraints]](../../models/shared/linkattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Link with title and href | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.LinkAttributeInfoHelpers]](undefined/models/shared/linkattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[LinkAttributeInfoHelpers]](../../models/shared/linkattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Link with title and href | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.LinkAttributeType]](undefined/models/shared/linkattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[LinkAttributeType]](../../models/shared/linkattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattribute.md b/entity/docs/models/shared/multiselectattribute.md index f36e935f8..93811b3a9 100755 --- a/entity/docs/models/shared/multiselectattribute.md +++ b/entity/docs/models/shared/multiselectattribute.md @@ -10,7 +10,7 @@ Multi Choice Selection | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | | `allow_any` | *Optional[bool]* | :heavy_minus_sign: | Allow arbitrary input values in addition to provided options | | | `allow_extra_options` | *Optional[bool]* | :heavy_minus_sign: | controls if the 360 ui will allow the user to enter a value which is not defined by the options | | -| `constraints` | [Optional[shared.MultiSelectAttributeConstraints]](undefined/models/shared/multiselectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[MultiSelectAttributeConstraints]](../../models/shared/multiselectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `disable_case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | controls if the matching of values against the options is case sensitive or not | | @@ -20,11 +20,11 @@ Multi Choice Selection | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.MultiSelectAttributeInfoHelpers]](undefined/models/shared/multiselectattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[MultiSelectAttributeInfoHelpers]](../../models/shared/multiselectattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `options` | list[[Union[str, shared.MultiSelectAttributeOptions2]](undefined/models/shared/multiselectattributeoptions.md)] | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `options` | list[[Union[str, MultiSelectAttributeOptions2]](../../models/shared/multiselectattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -35,5 +35,5 @@ Multi Choice Selection | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.MultiSelectAttributeType]](undefined/models/shared/multiselectattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[MultiSelectAttributeType]](../../models/shared/multiselectattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/multiselectattributeoptions2.md b/entity/docs/models/shared/multiselectattributeoptions2.md index 5ac818288..48fc585d5 100755 --- a/entity/docs/models/shared/multiselectattributeoptions2.md +++ b/entity/docs/models/shared/multiselectattributeoptions2.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | | `title` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `value` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/numberattribute.md b/entity/docs/models/shared/numberattribute.md index 800feb25b..8c3c883bb 100755 --- a/entity/docs/models/shared/numberattribute.md +++ b/entity/docs/models/shared/numberattribute.md @@ -8,7 +8,7 @@ Numeric input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.NumberAttributeConstraints]](undefined/models/shared/numberattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[NumberAttributeConstraints]](../../models/shared/numberattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -18,10 +18,10 @@ Numeric input | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.NumberAttributeInfoHelpers]](undefined/models/shared/numberattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[NumberAttributeInfoHelpers]](../../models/shared/numberattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ Numeric input | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.NumberAttributeType]](undefined/models/shared/numberattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[NumberAttributeType]](../../models/shared/numberattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/orderedlistattribute.md b/entity/docs/models/shared/orderedlistattribute.md index f639f7038..7e9bc77d4 100755 --- a/entity/docs/models/shared/orderedlistattribute.md +++ b/entity/docs/models/shared/orderedlistattribute.md @@ -8,7 +8,7 @@ Type of attribute to render N number of ordered fields | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.OrderedListAttributeConstraints]](undefined/models/shared/orderedlistattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[OrderedListAttributeConstraints]](../../models/shared/orderedlistattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Type of attribute to render N number of ordered fields | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.OrderedListAttributeInfoHelpers]](undefined/models/shared/orderedlistattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[OrderedListAttributeInfoHelpers]](../../models/shared/orderedlistattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Type of attribute to render N number of ordered fields | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.OrderedListAttributeType]](undefined/models/shared/orderedlistattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[OrderedListAttributeType]](../../models/shared/orderedlistattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerorganisationattribute.md b/entity/docs/models/shared/partnerorganisationattribute.md index ed90a0652..e792e4d42 100755 --- a/entity/docs/models/shared/partnerorganisationattribute.md +++ b/entity/docs/models/shared/partnerorganisationattribute.md @@ -8,7 +8,7 @@ Shared Partner Organisations | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.PartnerOrganisationAttributeConstraints]](undefined/models/shared/partnerorganisationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[PartnerOrganisationAttributeConstraints]](../../models/shared/partnerorganisationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Shared Partner Organisations | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.PartnerOrganisationAttributeInfoHelpers]](undefined/models/shared/partnerorganisationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[PartnerOrganisationAttributeInfoHelpers]](../../models/shared/partnerorganisationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Shared Partner Organisations | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.PartnerOrganisationAttributeType]](undefined/models/shared/partnerorganisationattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[PartnerOrganisationAttributeType]](../../models/shared/partnerorganisationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/partnerstatusattribute.md b/entity/docs/models/shared/partnerstatusattribute.md index 34ce2267a..a56225c9a 100755 --- a/entity/docs/models/shared/partnerstatusattribute.md +++ b/entity/docs/models/shared/partnerstatusattribute.md @@ -8,7 +8,7 @@ Partner Status | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.PartnerStatusAttributeConstraints]](undefined/models/shared/partnerstatusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[PartnerStatusAttributeConstraints]](../../models/shared/partnerstatusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Partner Status | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.PartnerStatusAttributeInfoHelpers]](undefined/models/shared/partnerstatusattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[PartnerStatusAttributeInfoHelpers]](../../models/shared/partnerstatusattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -31,5 +31,5 @@ Partner Status | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.PartnerStatusAttributeType]](undefined/models/shared/partnerstatusattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[PartnerStatusAttributeType]](../../models/shared/partnerstatusattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/paymentmethodrelationattribute.md b/entity/docs/models/shared/paymentmethodrelationattribute.md index df36af4e9..9586f898f 100755 --- a/entity/docs/models/shared/paymentmethodrelationattribute.md +++ b/entity/docs/models/shared/paymentmethodrelationattribute.md @@ -8,7 +8,7 @@ Reference to a payment method attribute of another entity | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.PaymentMethodRelationAttributeConstraints]](undefined/models/shared/paymentmethodrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[PaymentMethodRelationAttributeConstraints]](../../models/shared/paymentmethodrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -18,10 +18,10 @@ Reference to a payment method attribute of another entity | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.PaymentMethodRelationAttributeInfoHelpers]](undefined/models/shared/paymentmethodrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[PaymentMethodRelationAttributeInfoHelpers]](../../models/shared/paymentmethodrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ Reference to a payment method attribute of another entity | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.PaymentMethodRelationAttributeType]](undefined/models/shared/paymentmethodrelationattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[PaymentMethodRelationAttributeType]](../../models/shared/paymentmethodrelationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/purposeattribute.md b/entity/docs/models/shared/purposeattribute.md index 5fbaffb8b..6816d073d 100755 --- a/entity/docs/models/shared/purposeattribute.md +++ b/entity/docs/models/shared/purposeattribute.md @@ -8,7 +8,7 @@ Entity Taxonomy | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.PurposeAttributeConstraints]](undefined/models/shared/purposeattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[PurposeAttributeConstraints]](../../models/shared/purposeattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | @@ -19,10 +19,10 @@ Entity Taxonomy | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | | `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `info_helpers` | [Optional[shared.PurposeAttributeInfoHelpers]](undefined/models/shared/purposeattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[PurposeAttributeInfoHelpers]](../../models/shared/purposeattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | Wallbox PV | +| `name` | *str* | :heavy_check_mark: | N/A | Wallbox PV | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `parents` | list[*str*] | :heavy_minus_sign: | N/A | | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -34,6 +34,6 @@ Entity Taxonomy | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.PurposeAttributeType]](undefined/models/shared/purposeattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[PurposeAttributeType]](../../models/shared/purposeattributetype.md) | :heavy_minus_sign: | N/A | | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/redirectentityview.md b/entity/docs/models/shared/redirectentityview.md index 62b8526dc..7146cfa18 100755 --- a/entity/docs/models/shared/redirectentityview.md +++ b/entity/docs/models/shared/redirectentityview.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `route` | *Optional[str]* | :heavy_minus_sign: | N/A | /app/pricing-hub/product/:entityId | -| `view_type` | [Optional[shared.RedirectEntityViewViewType]](undefined/models/shared/redirectentityviewviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `route` | *Optional[str]* | :heavy_minus_sign: | N/A | /app/pricing-hub/product/:entityId | +| `view_type` | [Optional[RedirectEntityViewViewType]](../../models/shared/redirectentityviewviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattribute.md b/entity/docs/models/shared/relationattribute.md index ee5e610c3..c556eb4f8 100755 --- a/entity/docs/models/shared/relationattribute.md +++ b/entity/docs/models/shared/relationattribute.md @@ -8,15 +8,15 @@ Entity Relationship | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `actions` | list[[shared.RelationAttributeActions](undefined/models/shared/relationattributeactions.md)] | :heavy_minus_sign: | N/A | [object Object] | +| `actions` | list[[RelationAttributeActions](../../models/shared/relationattributeactions.md)] | :heavy_minus_sign: | N/A | [object Object] | | `add_button_label` | *Optional[str]* | :heavy_minus_sign: | Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is. | | | `allowed_schemas` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.RelationAttributeConstraints]](undefined/models/shared/relationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[RelationAttributeConstraints]](../../models/shared/relationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `details_view_mode_enabled` | *Optional[bool]* | :heavy_minus_sign: | Enables the preview, edition, and creation of relation items on a Master-Details view mode. | | -| `drawer_size` | [Optional[shared.RelationAttributeDrawerSize]](undefined/models/shared/relationattributedrawersize.md) | :heavy_minus_sign: | N/A | | -| `edit_mode` | [Optional[shared.RelationAttributeEditMode]](undefined/models/shared/relationattributeeditmode.md) | :heavy_minus_sign: | N/A | | +| `drawer_size` | [Optional[RelationAttributeDrawerSize]](../../models/shared/relationattributedrawersize.md) | :heavy_minus_sign: | N/A | | +| `edit_mode` | [Optional[RelationAttributeEditMode]](../../models/shared/relationattributeeditmode.md) | :heavy_minus_sign: | N/A | | | `enable_relation_picker` | *Optional[bool]* | :heavy_minus_sign: | When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link. | | | `enable_relation_tags` | *Optional[bool]* | :heavy_minus_sign: | When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item. | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -26,17 +26,17 @@ Entity Relationship | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `info_helpers` | [Optional[shared.RelationAttributeInfoHelpers]](undefined/models/shared/relationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[RelationAttributeInfoHelpers]](../../models/shared/relationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | | `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `relation_affinity_mode` | [Optional[shared.RelationAttributeRelationAffinityMode]](undefined/models/shared/relationattributerelationaffinitymode.md) | :heavy_minus_sign: | Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity. | | -| `relation_type` | [Optional[shared.RelationAttributeRelationType]](undefined/models/shared/relationattributerelationtype.md) | :heavy_minus_sign: | N/A | | +| `relation_affinity_mode` | [Optional[RelationAttributeRelationAffinityMode]](../../models/shared/relationattributerelationaffinitymode.md) | :heavy_minus_sign: | Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity. | | +| `relation_type` | [Optional[RelationAttributeRelationType]](../../models/shared/relationattributerelationtype.md) | :heavy_minus_sign: | N/A | | | `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `reverse_attributes` | dict[str, *str*] | :heavy_minus_sign: | Map of schema slug to target relation attribute | [object Object] | @@ -44,6 +44,6 @@ Entity Relationship | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `summary_fields` | list[[Union[str, shared.SummaryField]](undefined/models/shared/relationattributesummaryfields.md)] | :heavy_minus_sign: | N/A | | -| `type` | [Optional[shared.RelationAttributeType]](undefined/models/shared/relationattributetype.md) | :heavy_minus_sign: | N/A | | +| `summary_fields` | list[[Union[str, SummaryField]](../../models/shared/relationattributesummaryfields.md)] | :heavy_minus_sign: | N/A | | +| `type` | [Optional[RelationAttributeType]](../../models/shared/relationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributeactions.md b/entity/docs/models/shared/relationattributeactions.md index f778523e5..b2df233e8 100755 --- a/entity/docs/models/shared/relationattributeactions.md +++ b/entity/docs/models/shared/relationattributeactions.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action_type` | [Optional[shared.RelationAttributeActionsActionType]](undefined/models/shared/relationattributeactionsactiontype.md) | :heavy_minus_sign: | The action type. Currently supported actions:

\| action \| description \|
\|--------\|-------------\|
\| add_existing \| Enables the user to pick an existing entity to link as relation \|
\| create_new \| Enables the user to create a new entity using the first/main `allowed_schemas` schema
\| create_from_existing \| Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation \|
| | +| `action_type` | [Optional[RelationAttributeActionsActionType]](../../models/shared/relationattributeactionsactiontype.md) | :heavy_minus_sign: | The action type. Currently supported actions:

\| action \| description \|
\|--------\|-------------\|
\| add_existing \| Enables the user to pick an existing entity to link as relation \|
\| create_new \| Enables the user to create a new entity using the first/main `allowed_schemas` schema
\| create_from_existing \| Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation \|
| | | `default` | *Optional[bool]* | :heavy_minus_sign: | Sets the action as the default action, visible as the main action button. | | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the feature flag that enables this action | | | `label` | *Optional[str]* | :heavy_minus_sign: | The action label or action translation key (i18n) | | diff --git a/entity/docs/models/shared/relationitem.md b/entity/docs/models/shared/relationitem.md index 76ca794c0..900acb8c8 100755 --- a/entity/docs/models/shared/relationitem.md +++ b/entity/docs/models/shared/relationitem.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | | `tags` | list[*str*] | :heavy_minus_sign: | N/A | -| `attribute` | *Optional[str]* | :heavy_check_mark: | N/A | -| `entity_id` | *Optional[str]* | :heavy_check_mark: | N/A | +| `attribute` | *str* | :heavy_check_mark: | N/A | +| `entity_id` | *str* | :heavy_check_mark: | N/A | | `reverse` | *Optional[bool]* | :heavy_minus_sign: | Whether this is a reverse relation | \ No newline at end of file diff --git a/entity/docs/models/shared/repeatableattribute.md b/entity/docs/models/shared/repeatableattribute.md index 9a2aaa7fe..ba13a0dc0 100755 --- a/entity/docs/models/shared/repeatableattribute.md +++ b/entity/docs/models/shared/repeatableattribute.md @@ -8,7 +8,7 @@ Repeatable (add N number of fields) | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.RepeatableAttributeConstraints]](undefined/models/shared/repeatableattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[RepeatableAttributeConstraints]](../../models/shared/repeatableattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `enable_relation_picker` | *Optional[bool]* | :heavy_minus_sign: | when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link. | | @@ -19,21 +19,21 @@ Repeatable (add N number of fields) | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.RepeatableAttributeInfoHelpers]](undefined/models/shared/repeatableattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[RepeatableAttributeInfoHelpers]](../../models/shared/repeatableattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | | `readonly` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `relation_affinity_mode` | [Optional[shared.RepeatableAttributeRelationAffinityMode]](undefined/models/shared/repeatableattributerelationaffinitymode.md) | :heavy_minus_sign: | Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity. | | +| `relation_affinity_mode` | [Optional[RepeatableAttributeRelationAffinityMode]](../../models/shared/repeatableattributerelationaffinitymode.md) | :heavy_minus_sign: | Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity. | | | `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | | `repeatable` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.RepeatableAttributeType]](undefined/models/shared/repeatableattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[RepeatableAttributeType]](../../models/shared/repeatableattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/savedview.md b/entity/docs/models/shared/savedview.md index 9ab3d25f8..052b2ea92 100755 --- a/entity/docs/models/shared/savedview.md +++ b/entity/docs/models/shared/savedview.md @@ -5,12 +5,12 @@ A saved entity view ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `created_by` | [Optional[Union[shared.SavedViewCreatedBy1, dict[str, Any]]]](undefined/models/shared/savedviewcreatedby.md) | :heavy_check_mark: | N/A | | -| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | 11701 | -| `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | -| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | -| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | -| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | -| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `created_by` | [Union[SavedViewCreatedBy1, dict[str, Any]]](../../models/shared/savedviewcreatedby.md) | :heavy_check_mark: | N/A | | +| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | 11701 | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | +| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | +| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | +| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewitem.md b/entity/docs/models/shared/savedviewitem.md index 12b31560c..b428ce862 100755 --- a/entity/docs/models/shared/savedviewitem.md +++ b/entity/docs/models/shared/savedviewitem.md @@ -5,15 +5,15 @@ A saved entity view ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `created_by` | [Optional[Union[shared.SavedViewItemCreatedBy1, dict[str, Any]]]](undefined/models/shared/savedviewitemcreatedby.md) | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | -| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | 11701 | -| `name` | *Optional[str]* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | -| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | -| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | -| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | -| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | -| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `created_by` | [Union[SavedViewItemCreatedBy1, dict[str, Any]]](../../models/shared/savedviewitemcreatedby.md) | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | +| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | 11701 | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | +| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | +| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | +| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | +| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/searchmappings.md b/entity/docs/models/shared/searchmappings.md index b64abe4b1..117bd6494 100755 --- a/entity/docs/models/shared/searchmappings.md +++ b/entity/docs/models/shared/searchmappings.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `fields_` | dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `index` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [Optional[shared.SearchMappingsType]](undefined/models/shared/searchmappingstype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `fields_` | dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `index` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `type` | [Optional[SearchMappingsType]](../../models/shared/searchmappingstype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattribute.md b/entity/docs/models/shared/selectattribute.md index b6a085a89..443b89dd0 100755 --- a/entity/docs/models/shared/selectattribute.md +++ b/entity/docs/models/shared/selectattribute.md @@ -9,7 +9,7 @@ Dropdown select | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | | `allow_any` | *Optional[bool]* | :heavy_minus_sign: | Allow arbitrary input values in addition to provided options | | -| `constraints` | [Optional[shared.SelectAttributeConstraints]](undefined/models/shared/selectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[SelectAttributeConstraints]](../../models/shared/selectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -18,11 +18,11 @@ Dropdown select | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.SelectAttributeInfoHelpers]](undefined/models/shared/selectattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[SelectAttributeInfoHelpers]](../../models/shared/selectattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `options` | list[[Union[shared.SelectAttributeOptions1, str]](undefined/models/shared/selectattributeoptions.md)] | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `options` | list[[Union[SelectAttributeOptions1, str]](../../models/shared/selectattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -33,5 +33,5 @@ Dropdown select | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.SelectAttributeType]](undefined/models/shared/selectattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[SelectAttributeType]](../../models/shared/selectattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattributeoptions1.md b/entity/docs/models/shared/selectattributeoptions1.md index c80258c77..0bb8bf0c4 100755 --- a/entity/docs/models/shared/selectattributeoptions1.md +++ b/entity/docs/models/shared/selectattributeoptions1.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | | `title` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `value` | *Optional[str]* | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/sequenceattribute.md b/entity/docs/models/shared/sequenceattribute.md index 3785aa306..9eb78732b 100755 --- a/entity/docs/models/shared/sequenceattribute.md +++ b/entity/docs/models/shared/sequenceattribute.md @@ -8,7 +8,7 @@ Sequence of unique identifiers | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.SequenceAttributeConstraints]](undefined/models/shared/sequenceattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[SequenceAttributeConstraints]](../../models/shared/sequenceattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Sequence of unique identifiers | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.SequenceAttributeInfoHelpers]](undefined/models/shared/sequenceattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[SequenceAttributeInfoHelpers]](../../models/shared/sequenceattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `prefix` | *Optional[str]* | :heavy_minus_sign: | Prefix added before the sequence number | OR- | @@ -33,5 +33,5 @@ Sequence of unique identifiers | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `start_number` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `type` | [Optional[shared.SequenceAttributeType]](undefined/models/shared/sequenceattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[SequenceAttributeType]](../../models/shared/sequenceattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattribute.md b/entity/docs/models/shared/statusattribute.md index 628f08990..0a33a27a1 100755 --- a/entity/docs/models/shared/statusattribute.md +++ b/entity/docs/models/shared/statusattribute.md @@ -8,7 +8,7 @@ Status select | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.StatusAttributeConstraints]](undefined/models/shared/statusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[StatusAttributeConstraints]](../../models/shared/statusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,11 +17,11 @@ Status select | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.StatusAttributeInfoHelpers]](undefined/models/shared/statusattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[StatusAttributeInfoHelpers]](../../models/shared/statusattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | -| `options` | list[[Union[str, shared.StatusAttributeOptions2]](undefined/models/shared/statusattributeoptions.md)] | :heavy_minus_sign: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `options` | list[[Union[str, StatusAttributeOptions2]](../../models/shared/statusattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ Status select | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.StatusAttributeType]](undefined/models/shared/statusattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[StatusAttributeType]](../../models/shared/statusattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/statusattributeoptions2.md b/entity/docs/models/shared/statusattributeoptions2.md index 64199c976..b363733b6 100755 --- a/entity/docs/models/shared/statusattributeoptions2.md +++ b/entity/docs/models/shared/statusattributeoptions2.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | | `title` | *Optional[str]* | :heavy_minus_sign: | The displayed title of the option | -| `value` | *Optional[str]* | :heavy_check_mark: | The stored value of the option | \ No newline at end of file +| `value` | *str* | :heavy_check_mark: | The stored value of the option | \ No newline at end of file diff --git a/entity/docs/models/shared/summaryattribute.md b/entity/docs/models/shared/summaryattribute.md index 66cdeb084..0eb07aab0 100755 --- a/entity/docs/models/shared/summaryattribute.md +++ b/entity/docs/models/shared/summaryattribute.md @@ -19,9 +19,9 @@ The value field supports handlebar expressions from which you can pick any field | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | Binds summary field visibility to the feature flag state. | -| `label` | *Optional[str]* | :heavy_check_mark: | Label to be shown on the top of the value. | +| `label` | *str* | :heavy_check_mark: | Label to be shown on the top of the value. | | `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | Binds summary field visibility to the setting flag state. | | `show_as_tag` | *Optional[bool]* | :heavy_minus_sign: | Displays the value within a tag chip. | | `tag_color` | *Optional[str]* | :heavy_minus_sign: | CSS hex color or CSS color name for the tag chip. | -| `value` | *Optional[str]* | :heavy_check_mark: | A static value or an handlebar expression. | \ No newline at end of file +| `value` | *str* | :heavy_check_mark: | A static value or an handlebar expression. | \ No newline at end of file diff --git a/entity/docs/models/shared/tagsattribute.md b/entity/docs/models/shared/tagsattribute.md index a6f8a8e53..c8332cf8a 100755 --- a/entity/docs/models/shared/tagsattribute.md +++ b/entity/docs/models/shared/tagsattribute.md @@ -8,7 +8,7 @@ Tags | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.TagsAttributeConstraints]](undefined/models/shared/tagsattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[TagsAttributeConstraints]](../../models/shared/tagsattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,10 +17,10 @@ Tags | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.TagsAttributeInfoHelpers]](undefined/models/shared/tagsattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[TagsAttributeInfoHelpers]](../../models/shared/tagsattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `options` | list[*str*] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -33,5 +33,5 @@ Tags | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | | `suggestions` | list[*str*] | :heavy_minus_sign: | N/A | | -| `type` | [Optional[shared.TagsAttributeType]](undefined/models/shared/tagsattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[TagsAttributeType]](../../models/shared/tagsattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/taxonomy.md b/entity/docs/models/shared/taxonomy.md index cdf634202..84674090e 100755 --- a/entity/docs/models/shared/taxonomy.md +++ b/entity/docs/models/shared/taxonomy.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | -| `name` | *Optional[str]* | :heavy_check_mark: | A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag | Purpose | +| `name` | *str* | :heavy_check_mark: | A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag | Purpose | | `plural` | *Optional[str]* | :heavy_minus_sign: | Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags | Purposes | -| `slug` | *Optional[str]* | :heavy_check_mark: | URL-friendly name for taxonomy | purpose | +| `slug` | *str* | :heavy_check_mark: | URL-friendly name for taxonomy | purpose | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/taxonomyclassification.md b/entity/docs/models/shared/taxonomyclassification.md index 42765826f..3a7f5794f 100755 --- a/entity/docs/models/shared/taxonomyclassification.md +++ b/entity/docs/models/shared/taxonomyclassification.md @@ -7,6 +7,6 @@ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | Wallbox PV | +| `name` | *str* | :heavy_check_mark: | N/A | Wallbox PV | | `parents` | list[*str*] | :heavy_minus_sign: | N/A | | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/textattribute.md b/entity/docs/models/shared/textattribute.md index dd992e892..32ce14b7e 100755 --- a/entity/docs/models/shared/textattribute.md +++ b/entity/docs/models/shared/textattribute.md @@ -8,7 +8,7 @@ Textarea or text input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.TextAttributeConstraints]](undefined/models/shared/textattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[TextAttributeConstraints]](../../models/shared/textattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,11 +17,11 @@ Textarea or text input | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.TextAttributeInfoHelpers]](undefined/models/shared/textattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[TextAttributeInfoHelpers]](../../models/shared/textattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `multiline` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ Textarea or text input | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.TextAttributeType]](undefined/models/shared/textattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[TextAttributeType]](../../models/shared/textattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/userrelationattribute.md b/entity/docs/models/shared/userrelationattribute.md index 93bc4a3d5..b21332cde 100755 --- a/entity/docs/models/shared/userrelationattribute.md +++ b/entity/docs/models/shared/userrelationattribute.md @@ -8,7 +8,7 @@ User Relationship | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `constraints` | [Optional[shared.UserRelationAttributeConstraints]](undefined/models/shared/userrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | +| `constraints` | [Optional[UserRelationAttributeConstraints]](../../models/shared/userrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `entity_builder_disable_edit` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` disables editing the attribute on the entity builder UI | | @@ -17,11 +17,11 @@ User Relationship | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `info_helpers` | [Optional[shared.UserRelationAttributeInfoHelpers]](undefined/models/shared/userrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | -| `label` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `info_helpers` | [Optional[UserRelationAttributeInfoHelpers]](../../models/shared/userrelationattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | +| `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `multiple` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `name` | *Optional[str]* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,5 +32,5 @@ User Relationship | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `type` | [Optional[shared.UserRelationAttributeType]](undefined/models/shared/userrelationattributetype.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[UserRelationAttributeType]](../../models/shared/userrelationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md index 663989873..6c62f1537 100755 --- a/entity/docs/sdks/activity/README.md +++ b/entity/docs/sdks/activity/README.md @@ -39,6 +39,7 @@ res = s.activity.attach_activity(req) if res.activity_item is not None: # handle response + pass ``` ### Parameters @@ -91,6 +92,7 @@ res = s.activity.create_activity(req) if res.activity_item is not None: # handle response + pass ``` ### Parameters @@ -129,6 +131,7 @@ res = s.activity.get_activity(req) if res.activity_item is not None: # handle response + pass ``` ### Parameters @@ -171,6 +174,7 @@ res = s.activity.get_entity_activity_feed(req) if res.get_entity_activity_feed_200_application_json_object is not None: # handle response + pass ``` ### Parameters diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 86c2c86b2..55eb1be41 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -42,6 +42,7 @@ res = s.entities.autocomplete(req) if res.autocomplete_200_application_json_object is not None: # handle response + pass ``` ### Parameters @@ -99,14 +100,14 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( request_body={ - "_updated_at": 'Industrial', - "_acl": 'Implementation', - "_id": 'Future', - "_org": 'Southeast', - "_owners": 'Tandem', - "_schema": 'male', - "_tags": 'North', - "_created_at": 'Beach', + "_created_at": 'Industrial', + "_updated_at": 'Implementation', + "_acl": 'Future', + "_id": 'Southeast', + "_org": 'Tandem', + "_owners": 'male', + "_schema": 'North', + "_tags": 'Beach', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', slug='contact', @@ -116,6 +117,7 @@ res = s.entities.create_entity(req) if res.entity_item is not None: # handle response + pass ``` ### Parameters @@ -161,6 +163,7 @@ res = s.entities.delete_entity(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -263,6 +266,7 @@ res = s.entities.get_entity(req) if res.get_entity_200_application_json_object is not None: # handle response + pass ``` ### Parameters @@ -322,14 +326,14 @@ s = epilot.Epilot( req = operations.PatchEntityRequest( request_body={ - "_tags": 'fuchsia', - "_created_at": 'Account', - "_updated_at": 'engage', - "_acl": 'Cis', - "_id": 'solutions', - "_org": 'founder', - "_owners": 'Southeast', - "_schema": 'Cab', + "_updated_at": 'fuchsia', + "_acl": 'Account', + "_id": 'engage', + "_org": 'Cis', + "_owners": 'solutions', + "_schema": 'founder', + "_tags": 'Southeast', + "_created_at": 'Cab', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', id='06e999b7-2319-4d9e-8290-d19da9e1f40d', @@ -340,6 +344,7 @@ res = s.entities.patch_entity(req) if res.entity_item is not None: # handle response + pass ``` ### Parameters @@ -450,6 +455,7 @@ res = s.entities.search_entities(req) if res.entity_search_results is not None: # handle response + pass ``` ### Parameters @@ -507,14 +513,14 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( request_body={ - "_updated_at": 'Hartmann', - "_acl": 'invoice', - "_id": 'fathom', - "_org": 'Nepal', - "_owners": 'indexing', - "_schema": 'male', - "_tags": 'Profound', - "_created_at": 'policy', + "_acl": 'Hartmann', + "_id": 'invoice', + "_org": 'fathom', + "_owners": 'Nepal', + "_schema": 'indexing', + "_tags": 'male', + "_created_at": 'Profound', + "_updated_at": 'policy', }, activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', id='1d12df74-462a-498e-a7ff-ce36a4e49616', @@ -525,6 +531,7 @@ res = s.entities.update_entity(req) if res.entity_item is not None: # handle response + pass ``` ### Parameters @@ -588,6 +595,7 @@ res = s.entities.upsert_entity(req) if res.entity_item is not None: # handle response + pass ``` ### Parameters diff --git a/entity/docs/sdks/entityimport/README.md b/entity/docs/sdks/entityimport/README.md index c533a56ab..04b9fb152 100755 --- a/entity/docs/sdks/entityimport/README.md +++ b/entity/docs/sdks/entityimport/README.md @@ -39,6 +39,7 @@ res = s.entity_import.import_entities(req) if res.status_code == 200: # handle response + pass ``` ### Parameters diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md index 321140a27..71c9e7e35 100755 --- a/entity/docs/sdks/export/README.md +++ b/entity/docs/sdks/export/README.md @@ -43,6 +43,7 @@ res = s.export.export_entities(req) if res.status_code == 200: # handle response + pass ``` ### Parameters diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index 4f50ee5e8..4cf5f4b17 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -49,6 +49,7 @@ res = s.relations.add_relations(req) if res.relation_item is not None: # handle response + pass ``` ### Parameters @@ -91,6 +92,7 @@ res = s.relations.delete_relation(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -134,6 +136,7 @@ res = s.relations.get_related_entities_count(req) if res.get_related_entities_count is not None: # handle response + pass ``` ### Parameters @@ -178,6 +181,7 @@ res = s.relations.get_relations(req) if res.get_relations_resp is not None: # handle response + pass ``` ### Parameters @@ -227,6 +231,7 @@ res = s.relations.get_relations_v2(req) if res.get_relations_resp_with_pagination is not None: # handle response + pass ``` ### Parameters @@ -274,6 +279,7 @@ res = s.relations.update_relation(req) if res.relation_item is not None: # handle response + pass ``` ### Parameters diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index 81a81cd98..147c7be3e 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -53,6 +53,7 @@ res = s.saved_views.create_saved_view(req) if res.saved_view_item is not None: # handle response + pass ``` ### Parameters @@ -91,6 +92,7 @@ res = s.saved_views.delete_saved_view(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -129,6 +131,7 @@ res = s.saved_views.get_saved_view(req) if res.get_saved_view_200_application_json_object is not None: # handle response + pass ``` ### Parameters @@ -164,6 +167,7 @@ res = s.saved_views.list_favorite_views_for_user() if res.list_favorite_views_for_user_200_application_json_object is not None: # handle response + pass ``` @@ -193,6 +197,7 @@ res = s.saved_views.list_saved_views() if res.list_saved_views_200_application_json_object is not None: # handle response + pass ``` @@ -243,6 +248,7 @@ res = s.saved_views.update_saved_view(req) if res.saved_view_item is not None: # handle response + pass ``` ### Parameters diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index b101ae1dc..2d8c5f58b 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -39,6 +39,7 @@ res = s.schemas.delete_schema(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -77,6 +78,7 @@ res = s.schemas.get_schema(req) if res.entity_schema_item is not None: # handle response + pass ``` ### Parameters @@ -115,6 +117,7 @@ res = s.schemas.get_schema_versions(req) if res.get_schema_versions_200_application_json_object is not None: # handle response + pass ``` ### Parameters @@ -150,6 +153,7 @@ res = s.schemas.list_schema_blueprints() if res.list_schema_blueprints_200_application_json_object is not None: # handle response + pass ``` @@ -180,6 +184,7 @@ res = s.schemas.list_schemas(req) if res.list_schemas_200_application_json_object is not None: # handle response + pass ``` ### Parameters @@ -219,6 +224,7 @@ res = s.schemas.list_taxonomy_classifications_for_schema(req) if res.list_taxonomy_classifications_for_schema_200_application_json_object is not None: # handle response + pass ``` ### Parameters @@ -487,6 +493,7 @@ res = s.schemas.put_schema(req) if res.entity_schema_item is not None: # handle response + pass ``` ### Parameters diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index a3a4e7446..24985e650 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -37,6 +37,7 @@ res = s.taxonomy.get_taxonomy(req) if res.taxonomy is not None: # handle response + pass ``` ### Parameters @@ -72,6 +73,7 @@ res = s.taxonomy.list_taxonomies() if res.list_taxonomies_200_application_json_object is not None: # handle response + pass ``` @@ -109,6 +111,7 @@ res = s.taxonomy.taxonomies_classifications_search(req) if res.taxonomies_classifications_search_200_application_json_object is not None: # handle response + pass ``` ### Parameters @@ -147,6 +150,7 @@ res = s.taxonomy.taxonomy_autocomplete(req) if res.taxonomy_autocomplete_200_application_json_object is not None: # handle response + pass ``` ### Parameters @@ -207,6 +211,7 @@ res = s.taxonomy.update_classifications_for_taxonomy(req) if res.update_classifications_for_taxonomy_200_application_json_object is not None: # handle response + pass ``` ### Parameters diff --git a/entity/gen.yaml b/entity/gen.yaml index 59635a341..61fa9cb55 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: f8fda659e78397d7d3ffdf366a682493 docVersion: 1.0.0 - speakeasyVersion: 1.96.1 - generationVersion: 2.150.0 + speakeasyVersion: 1.99.1 + generationVersion: 2.154.1 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,11 @@ generation: telemetryEnabled: false features: python: - core: 2.88.4 + core: 2.88.6 globalSecurity: 2.82.0 globalServerURLs: 2.82.0 python: - version: 1.27.0 + version: 1.27.1 author: epilot description: Python Client SDK for Epilot flattenGlobalSecurity: false diff --git a/entity/setup.py b/entity/setup.py index b9ff9ebc8..fed3c1fde 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="1.27.0", + version="1.27.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdk.py b/entity/src/epilot/sdk.py index e403e04dd..f89364459 100755 --- a/entity/src/epilot/sdk.py +++ b/entity/src/epilot/sdk.py @@ -39,7 +39,7 @@ class Epilot: sdk_configuration: SDKConfiguration def __init__(self, - epilot_auth: str, + security: shared.Security = None, server_idx: int = None, server_url: str = None, url_params: dict[str, str] = None, @@ -48,8 +48,8 @@ def __init__(self, ) -> None: """Instantiates the SDK configuring it with the provided parameters. - :param epilot_auth: The epilot_auth required for authentication - :type epilot_auth: str + :param security: The security details required for authentication + :type security: shared.Security :param server_idx: The index of the server to use for all operations :type server_idx: int :param server_url: The server URL to use for all operations diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 01cd84281..74725b313 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -19,9 +19,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.27.0' - gen_version: str = '2.150.0' - user_agent: str = 'speakeasy-sdk/python 1.27.0 2.150.0 1.0.0 epilot-entity' + sdk_version: str = '1.27.1' + gen_version: str = '2.154.1' + user_agent: str = 'speakeasy-sdk/python 1.27.1 2.154.1 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: From aa93c11a81827d4f915b405b28ff3bb161ec8234 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 18 Oct 2023 01:14:55 +0000 Subject: [PATCH 48/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.101.0 --- entity/RELEASES.md | 10 +- .../models/operations/addrelationsrequest.md | 2 +- .../operations/attachactivityrequest.md | 2 +- .../autocomplete200applicationjson.md | 2 +- .../autocomplete200applicationjsonresults.md | 2 +- .../operations/createactivityrequest.md | 2 +- .../models/operations/createentityrequest.md | 2 +- .../models/operations/createentityresponse.md | 12 +- .../operations/getentity200applicationjson.md | 8 +- ...getentityactivityfeed200applicationjson.md | 2 +- .../getrelatedentitiescountrequest.md | 2 +- .../models/operations/getrelationsresponse.md | 12 +- .../operations/getrelationsv2request.md | 2 +- .../getschemaversions200applicationjson.md | 4 +- ...tfavoriteviewsforuser200applicationjson.md | 2 +- .../listsavedviews200applicationjson.md | 2 +- .../listschemablueprints200applicationjson.md | 2 +- .../listschemas200applicationjson.md | 2 +- .../listtaxonomies200applicationjson.md | 2 +- ...ssificationsforschema200applicationjson.md | 2 +- .../models/operations/patchentityrequest.md | 2 +- .../models/operations/patchentityresponse.md | 12 +- ...classificationssearch200applicationjson.md | 2 +- ...onomiesclassificationssearchrequestbody.md | 2 +- .../taxonomyautocomplete200applicationjson.md | 2 +- ...ificationsfortaxonomy200applicationjson.md | 4 +- .../models/operations/updateentityrequest.md | 2 +- .../models/operations/updateentityresponse.md | 12 +- .../operations/updaterelationrequestbody.md | 2 +- .../operations/upsertentityrequestbody.md | 8 +- .../models/operations/upsertentityresponse.md | 12 +- entity/docs/models/shared/activity.md | 2 +- .../models/shared/activitycallercontext.md | 9 + .../shared/activitycallercontextepilotauth.md | 8 + .../activitycallercontextepilotauthtoken.md | 11 + entity/docs/models/shared/activityitem.md | 22 +- .../models/shared/addressrelationattribute.md | 2 +- .../docs/models/shared/automationattribute.md | 2 +- entity/docs/models/shared/booleanattribute.md | 2 +- .../models/shared/classificationsupdate.md | 6 +- .../docs/models/shared/computedattribute.md | 2 +- entity/docs/models/shared/consentattribute.md | 4 +- entity/docs/models/shared/countryattribute.md | 2 +- .../docs/models/shared/currencyattribute.md | 4 +- entity/docs/models/shared/dateattribute.md | 2 +- entity/docs/models/shared/entity.md | 17 ++ entity/docs/models/shared/entityacl.md | 13 + entity/docs/models/shared/entitycapability.md | 6 +- .../models/shared/entitycapabilityuihooks.md | 20 ++ ...titycapabilityuihooksrequiredpermission.md | 11 + .../docs/models/shared/entitydefaultcreate.md | 2 +- .../docs/models/shared/entitydefaultedit.md | 4 +- .../docs/models/shared/entitydefaulttable.md | 6 +- .../shared/entitydefaulttablenavbaractions.md | 2 +- entity/docs/models/shared/entityitem.md | 17 ++ entity/docs/models/shared/entityoperation.md | 18 +- .../docs/models/shared/entityoperationdiff.md | 10 +- .../models/shared/entityoperationpayload.md | 17 ++ entity/docs/models/shared/entityowner.md | 14 + entity/docs/models/shared/entityschema.md | 14 +- .../shared/entityschemagroupsettings.md | 2 +- entity/docs/models/shared/entityschemaitem.md | 14 +- .../shared/entityschemaitemgroupsettings.md | 2 +- .../shared/entityschemaitemlayoutsettings.md | 15 + .../entityschemaitemuiconfiglistitem.md | 2 +- .../shared/entityschemalayoutsettings.md | 15 + .../shared/entityschemauiconfiglistitem.md | 2 +- .../docs/models/shared/entitysearchparams.md | 2 +- .../docs/models/shared/entitysearchresults.md | 2 +- entity/docs/models/shared/fileattribute.md | 4 +- entity/docs/models/shared/getrelationsresp.md | 4 +- .../shared/getrelationsrespwithpagination.md | 2 +- .../docs/models/shared/internalattribute.md | 2 +- .../models/shared/internaluserattribute.md | 2 +- .../models/shared/invitationemailattribute.md | 2 +- entity/docs/models/shared/linkattribute.md | 2 +- .../models/shared/multiselectattribute.md | 4 +- entity/docs/models/shared/numberattribute.md | 2 +- .../models/shared/orderedlistattribute.md | 2 +- .../shared/partnerorganisationattribute.md | 2 +- .../models/shared/partnerstatusattribute.md | 2 +- .../shared/paymentmethodrelationattribute.md | 2 +- entity/docs/models/shared/purposeattribute.md | 4 +- .../docs/models/shared/relationattribute.md | 10 +- .../models/shared/relationattributeactions.md | 16 +- .../relationattributeactionsnewentityitem.md | 17 ++ entity/docs/models/shared/relationentity.md | 18 ++ entity/docs/models/shared/relationitem.md | 2 +- .../docs/models/shared/repeatableattribute.md | 2 +- entity/docs/models/shared/savedview.md | 18 +- .../docs/models/shared/savedviewcreatedby.md | 4 +- .../docs/models/shared/savedviewcreatedby2.md | 11 + .../shared/savedviewcreatedby2source.md | 9 + entity/docs/models/shared/savedviewitem.md | 24 +- .../models/shared/savedviewitemcreatedby.md | 4 +- .../models/shared/savedviewitemcreatedby2.md | 11 + .../shared/savedviewitemcreatedby2source.md | 9 + entity/docs/models/shared/searchmappings.md | 2 +- entity/docs/models/shared/selectattribute.md | 4 +- .../docs/models/shared/sequenceattribute.md | 2 +- entity/docs/models/shared/statusattribute.md | 4 +- entity/docs/models/shared/tagsattribute.md | 6 +- .../models/shared/taxonomyclassification.md | 2 +- entity/docs/models/shared/textattribute.md | 2 +- .../models/shared/userrelationattribute.md | 2 +- entity/docs/sdks/entities/README.md | 264 +++++++++++++++--- entity/docs/sdks/relations/README.md | 18 +- entity/docs/sdks/savedviews/README.md | 4 +- entity/docs/sdks/schemas/README.md | 135 +++++---- entity/docs/sdks/taxonomy/README.md | 6 +- entity/files.gen | 24 ++ entity/gen.yaml | 9 +- entity/pylintrc | 2 +- entity/setup.py | 26 +- entity/src/epilot/entities.py | 16 +- .../epilot/models/operations/addrelations.py | 6 +- .../models/operations/attachactivity.py | 6 +- .../epilot/models/operations/autocomplete.py | 8 +- .../models/operations/createactivity.py | 6 +- .../epilot/models/operations/createentity.py | 10 +- .../models/operations/createsavedview.py | 1 - .../epilot/models/operations/deleteentity.py | 2 - .../models/operations/deleterelation.py | 2 - .../models/operations/deletesavedview.py | 2 - .../epilot/models/operations/deleteschema.py | 2 - .../models/operations/exportentities.py | 2 - .../epilot/models/operations/getactivity.py | 2 - .../src/epilot/models/operations/getentity.py | 10 +- .../operations/getentityactivityfeed.py | 7 +- .../operations/getrelatedentitiescount.py | 6 +- .../epilot/models/operations/getrelations.py | 8 +- .../models/operations/getrelationsv2.py | 6 +- .../epilot/models/operations/getsavedview.py | 3 - .../src/epilot/models/operations/getschema.py | 2 - .../models/operations/getschemaversions.py | 9 +- .../epilot/models/operations/gettaxonomy.py | 2 - .../models/operations/importentities.py | 2 - .../operations/listfavoriteviewsforuser.py | 6 +- .../models/operations/listsavedviews.py | 6 +- .../models/operations/listschemablueprints.py | 6 +- .../epilot/models/operations/listschemas.py | 7 +- .../models/operations/listtaxonomies.py | 6 +- .../listtaxonomyclassificationsforschema.py | 7 +- .../epilot/models/operations/patchentity.py | 10 +- .../src/epilot/models/operations/putschema.py | 2 - .../models/operations/searchentities.py | 1 - .../taxonomiesclassificationssearch.py | 10 +- .../models/operations/taxonomyautocomplete.py | 7 +- .../updateclassificationsfortaxonomy.py | 10 +- .../epilot/models/operations/updateentity.py | 10 +- .../models/operations/updaterelation.py | 7 +- .../models/operations/updatesavedview.py | 2 - .../epilot/models/operations/upsertentity.py | 13 +- entity/src/epilot/models/shared/__init__.py | 8 +- entity/src/epilot/models/shared/activity.py | 5 +- .../models/shared/activitycallercontext.py | 35 +++ .../src/epilot/models/shared/activityitem.py | 10 +- .../models/shared/addressrelationattribute.py | 7 +- .../models/shared/automationattribute.py | 7 +- .../epilot/models/shared/booleanattribute.py | 7 +- .../models/shared/classificationsupdate.py | 9 +- .../epilot/models/shared/computedattribute.py | 7 +- .../epilot/models/shared/consentattribute.py | 9 +- .../epilot/models/shared/countryattribute.py | 7 +- .../epilot/models/shared/currencyattribute.py | 11 +- .../src/epilot/models/shared/dateattribute.py | 7 +- entity/src/epilot/models/shared/entity.py | 32 +++ entity/src/epilot/models/shared/entityacl.py | 19 ++ .../epilot/models/shared/entitycapability.py | 47 +++- .../models/shared/entitydefaultcreate.py | 6 +- .../epilot/models/shared/entitydefaultedit.py | 8 +- .../models/shared/entitydefaulttable.py | 17 +- .../models/shared/entityimportparams.py | 2 - entity/src/epilot/models/shared/entityitem.py | 32 +++ .../epilot/models/shared/entityoperation.py | 37 ++- .../src/epilot/models/shared/entityowner.py | 20 ++ .../src/epilot/models/shared/entityschema.py | 45 +-- .../epilot/models/shared/entityschemaitem.py | 46 +-- .../models/shared/entitysearchparams.py | 6 +- .../models/shared/entitysearchresults.py | 7 +- .../models/shared/entityviewdisabled.py | 1 - .../src/epilot/models/shared/fileattribute.py | 9 +- .../models/shared/getrelatedentitiescount.py | 1 - .../shared/getrelationsrespwithpagination.py | 7 +- .../epilot/models/shared/internalattribute.py | 7 +- .../models/shared/internaluserattribute.py | 7 +- .../models/shared/invitationemailattribute.py | 7 +- .../src/epilot/models/shared/linkattribute.py | 7 +- .../models/shared/multiselectattribute.py | 11 +- .../epilot/models/shared/numberattribute.py | 7 +- .../models/shared/orderedlistattribute.py | 7 +- .../shared/partnerorganisationattribute.py | 7 +- .../models/shared/partnerstatusattribute.py | 7 +- .../shared/paymentmethodrelationattribute.py | 7 +- .../epilot/models/shared/purposeattribute.py | 9 +- .../models/shared/redirectentityview.py | 1 - .../epilot/models/shared/relationattribute.py | 42 ++- .../epilot/models/shared/relationentity.py | 34 +++ .../src/epilot/models/shared/relationitem.py | 5 +- .../models/shared/repeatableattribute.py | 7 +- entity/src/epilot/models/shared/savedview.py | 26 +- .../src/epilot/models/shared/savedviewitem.py | 26 +- .../epilot/models/shared/searchmappings.py | 5 +- entity/src/epilot/models/shared/security.py | 1 - .../epilot/models/shared/selectattribute.py | 11 +- .../epilot/models/shared/sequenceattribute.py | 7 +- .../epilot/models/shared/statusattribute.py | 11 +- .../epilot/models/shared/summaryattribute.py | 1 - .../src/epilot/models/shared/summaryfield.py | 1 - .../src/epilot/models/shared/tagsattribute.py | 11 +- entity/src/epilot/models/shared/taxonomy.py | 1 - .../models/shared/taxonomyclassification.py | 5 +- .../src/epilot/models/shared/textattribute.py | 7 +- .../models/shared/userrelationattribute.py | 7 +- entity/src/epilot/relations.py | 4 +- entity/src/epilot/sdk.py | 5 +- entity/src/epilot/sdkconfiguration.py | 13 +- entity/src/epilot/utils/retries.py | 5 +- entity/src/epilot/utils/utils.py | 117 ++++---- 219 files changed, 1436 insertions(+), 845 deletions(-) create mode 100755 entity/docs/models/shared/activitycallercontext.md create mode 100755 entity/docs/models/shared/activitycallercontextepilotauth.md create mode 100755 entity/docs/models/shared/activitycallercontextepilotauthtoken.md create mode 100755 entity/docs/models/shared/entity.md create mode 100755 entity/docs/models/shared/entityacl.md create mode 100755 entity/docs/models/shared/entitycapabilityuihooks.md create mode 100755 entity/docs/models/shared/entitycapabilityuihooksrequiredpermission.md create mode 100755 entity/docs/models/shared/entityitem.md create mode 100755 entity/docs/models/shared/entityoperationpayload.md create mode 100755 entity/docs/models/shared/entityowner.md create mode 100755 entity/docs/models/shared/entityschemaitemlayoutsettings.md create mode 100755 entity/docs/models/shared/entityschemalayoutsettings.md create mode 100755 entity/docs/models/shared/relationattributeactionsnewentityitem.md create mode 100755 entity/docs/models/shared/relationentity.md create mode 100755 entity/docs/models/shared/savedviewcreatedby2.md create mode 100755 entity/docs/models/shared/savedviewcreatedby2source.md create mode 100755 entity/docs/models/shared/savedviewitemcreatedby2.md create mode 100755 entity/docs/models/shared/savedviewitemcreatedby2source.md create mode 100755 entity/src/epilot/models/shared/activitycallercontext.py create mode 100755 entity/src/epilot/models/shared/entity.py create mode 100755 entity/src/epilot/models/shared/entityacl.py create mode 100755 entity/src/epilot/models/shared/entityitem.py create mode 100755 entity/src/epilot/models/shared/entityowner.py create mode 100755 entity/src/epilot/models/shared/relationentity.py diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 5dca99917..923f69454 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -356,4 +356,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.99.1 (2.154.1) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v1.27.1] entity \ No newline at end of file +- [python v1.27.1] entity + +## 2023-10-18 01:14:28 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.101.0 (2.161.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v2.0.0] entity \ No newline at end of file diff --git a/entity/docs/models/operations/addrelationsrequest.md b/entity/docs/models/operations/addrelationsrequest.md index 62a5f2a79..911ab25a8 100755 --- a/entity/docs/models/operations/addrelationsrequest.md +++ b/entity/docs/models/operations/addrelationsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `request_body` | list[[shared.RelationItem](../../models/shared/relationitem.md)] | :heavy_minus_sign: | N/A | | +| `request_body` | List[[shared.RelationItem](../../models/shared/relationitem.md)] | :heavy_minus_sign: | N/A | | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | | `id` | *str* | :heavy_check_mark: | Entity id | | diff --git a/entity/docs/models/operations/attachactivityrequest.md b/entity/docs/models/operations/attachactivityrequest.md index 871cb14d9..86bfd18fc 100755 --- a/entity/docs/models/operations/attachactivityrequest.md +++ b/entity/docs/models/operations/attachactivityrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `entities` | list[*str*] | :heavy_minus_sign: | Comma-separated list of entities which the activity primarily concerns | | +| `entities` | List[*str*] | :heavy_minus_sign: | Comma-separated list of entities which the activity primarily concerns | | | `id` | *str* | :heavy_check_mark: | Activity Id | 01F130Q52Q6MWSNS8N2AVXV4JN | \ No newline at end of file diff --git a/entity/docs/models/operations/autocomplete200applicationjson.md b/entity/docs/models/operations/autocomplete200applicationjson.md index a897a266e..a861c108d 100755 --- a/entity/docs/models/operations/autocomplete200applicationjson.md +++ b/entity/docs/models/operations/autocomplete200applicationjson.md @@ -8,4 +8,4 @@ Success | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `results` | list[[Union[str, bool, dict[str, Any]]](../../models/operations/autocomplete200applicationjsonresults.md)] | :heavy_minus_sign: | N/A | value | \ No newline at end of file +| `results` | List[[Union[str, bool, Dict[str, Any]]](../../models/operations/autocomplete200applicationjsonresults.md)] | :heavy_minus_sign: | N/A | value | \ No newline at end of file diff --git a/entity/docs/models/operations/autocomplete200applicationjsonresults.md b/entity/docs/models/operations/autocomplete200applicationjsonresults.md index a52f37b03..9ee1890ec 100755 --- a/entity/docs/models/operations/autocomplete200applicationjsonresults.md +++ b/entity/docs/models/operations/autocomplete200applicationjsonresults.md @@ -18,6 +18,6 @@ autocomplete200ApplicationJSONResults: bool = /* values here */ ### ```python -autocomplete200ApplicationJSONResults: dict[str, Any] = /* values here */ +autocomplete200ApplicationJSONResults: Dict[str, Any] = /* values here */ ``` diff --git a/entity/docs/models/operations/createactivityrequest.md b/entity/docs/models/operations/createactivityrequest.md index eaf600128..55e99f092 100755 --- a/entity/docs/models/operations/createactivityrequest.md +++ b/entity/docs/models/operations/createactivityrequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | | `activity` | [Optional[shared.Activity]](../../models/shared/activity.md) | :heavy_minus_sign: | N/A | -| `entities` | list[*str*] | :heavy_minus_sign: | Comma-separated list of entities which the activity primarily concerns | \ No newline at end of file +| `entities` | List[*str*] | :heavy_minus_sign: | Comma-separated list of entities which the activity primarily concerns | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityrequest.md b/entity/docs/models/operations/createentityrequest.md index d305f3547..54ec655ea 100755 --- a/entity/docs/models/operations/createentityrequest.md +++ b/entity/docs/models/operations/createentityrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `entity` | [Optional[shared.Entity]](../../models/shared/entity.md) | :heavy_minus_sign: | N/A | | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | | `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/createentityresponse.md b/entity/docs/models/operations/createentityresponse.md index fc7d204a7..b63d7c5d6 100755 --- a/entity/docs/models/operations/createentityresponse.md +++ b/entity/docs/models/operations/createentityresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | -| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | [object Object] | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `entity_item` | [Optional[shared.EntityItem]](../../models/shared/entityitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getentity200applicationjson.md b/entity/docs/models/operations/getentity200applicationjson.md index 487a62bbc..8b68b39bb 100755 --- a/entity/docs/models/operations/getentity200applicationjson.md +++ b/entity/docs/models/operations/getentity200applicationjson.md @@ -5,7 +5,7 @@ Success ## Fields -| Field | Type | Required | Description | Example | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `entity` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | -| `relations` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `entity` | [Optional[shared.EntityItem]](../../models/shared/entityitem.md) | :heavy_minus_sign: | N/A | +| `relations` | List[[shared.EntityItem](../../models/shared/entityitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeed200applicationjson.md b/entity/docs/models/operations/getentityactivityfeed200applicationjson.md index 607e07ad4..a19ff44ab 100755 --- a/entity/docs/models/operations/getentityactivityfeed200applicationjson.md +++ b/entity/docs/models/operations/getentityactivityfeed200applicationjson.md @@ -7,5 +7,5 @@ Success | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `results` | list[[shared.ActivityItem](../../models/shared/activityitem.md)] | :heavy_minus_sign: | N/A | | +| `results` | List[[shared.ActivityItem](../../models/shared/activityitem.md)] | :heavy_minus_sign: | N/A | | | `total` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelatedentitiescountrequest.md b/entity/docs/models/operations/getrelatedentitiescountrequest.md index eedab1bf4..b73c7a450 100755 --- a/entity/docs/models/operations/getrelatedentitiescountrequest.md +++ b/entity/docs/models/operations/getrelatedentitiescountrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `exclude_schemas` | list[*str*] | :heavy_minus_sign: | To be excluded from the count by given schemas | | +| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | To be excluded from the count by given schemas | | | `id` | *str* | :heavy_check_mark: | Entity id | | | `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsresponse.md b/entity/docs/models/operations/getrelationsresponse.md index 148425e2d..ad56da2e4 100755 --- a/entity/docs/models/operations/getrelationsresponse.md +++ b/entity/docs/models/operations/getrelationsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `get_relations_resp` | list[[Union[shared.RelationItem, dict[str, Any]]](../../models/shared/getrelationsresp.md)] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `get_relations_resp` | List[[Union[shared.RelationItem, shared.RelationEntity]](../../models/shared/getrelationsresp.md)] | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv2request.md b/entity/docs/models/operations/getrelationsv2request.md index 6f87b432c..4c3871f70 100755 --- a/entity/docs/models/operations/getrelationsv2request.md +++ b/entity/docs/models/operations/getrelationsv2request.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in results | _id,_schema,_title | +| `fields_` | List[*str*] | :heavy_minus_sign: | List of entity fields to include in results | _id,_schema,_title | | `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | | `id` | *str* | :heavy_check_mark: | Entity id | | diff --git a/entity/docs/models/operations/getschemaversions200applicationjson.md b/entity/docs/models/operations/getschemaversions200applicationjson.md index c04fd28b3..1cbbadab6 100755 --- a/entity/docs/models/operations/getschemaversions200applicationjson.md +++ b/entity/docs/models/operations/getschemaversions200applicationjson.md @@ -7,5 +7,5 @@ Success | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `drafts` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | -| `versions` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `drafts` | List[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | +| `versions` | List[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md b/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md index c0ef2ddef..7d41cb21c 100755 --- a/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md +++ b/entity/docs/models/operations/listfavoriteviewsforuser200applicationjson.md @@ -7,4 +7,4 @@ Success | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `results` | list[[shared.SavedViewItem](../../models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `results` | List[[shared.SavedViewItem](../../models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listsavedviews200applicationjson.md b/entity/docs/models/operations/listsavedviews200applicationjson.md index 1b3bd47f5..119d02ea0 100755 --- a/entity/docs/models/operations/listsavedviews200applicationjson.md +++ b/entity/docs/models/operations/listsavedviews200applicationjson.md @@ -7,4 +7,4 @@ Success | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `results` | list[[shared.SavedViewItem](../../models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `results` | List[[shared.SavedViewItem](../../models/shared/savedviewitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemablueprints200applicationjson.md b/entity/docs/models/operations/listschemablueprints200applicationjson.md index 57d194fdb..e65ce25b4 100755 --- a/entity/docs/models/operations/listschemablueprints200applicationjson.md +++ b/entity/docs/models/operations/listschemablueprints200applicationjson.md @@ -7,4 +7,4 @@ Success | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `results` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `results` | List[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listschemas200applicationjson.md b/entity/docs/models/operations/listschemas200applicationjson.md index fd7595402..8b0555f3a 100755 --- a/entity/docs/models/operations/listschemas200applicationjson.md +++ b/entity/docs/models/operations/listschemas200applicationjson.md @@ -7,4 +7,4 @@ Success | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `results` | list[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `results` | List[[shared.EntitySchemaItem](../../models/shared/entityschemaitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomies200applicationjson.md b/entity/docs/models/operations/listtaxonomies200applicationjson.md index 57b6fab4c..0db943e4c 100755 --- a/entity/docs/models/operations/listtaxonomies200applicationjson.md +++ b/entity/docs/models/operations/listtaxonomies200applicationjson.md @@ -7,4 +7,4 @@ Returns list of taxonomies in an organisation | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `results` | list[[shared.Taxonomy](../../models/shared/taxonomy.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `results` | List[[shared.Taxonomy](../../models/shared/taxonomy.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md b/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md index 9bee2d403..82004af91 100755 --- a/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschema200applicationjson.md @@ -7,4 +7,4 @@ List of taxonomy classifications | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `results` | List[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/patchentityrequest.md b/entity/docs/models/operations/patchentityrequest.md index 61815599d..c2b2fdcf7 100755 --- a/entity/docs/models/operations/patchentityrequest.md +++ b/entity/docs/models/operations/patchentityrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `request_body` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | +| `entity` | [shared.Entity](../../models/shared/entity.md) | :heavy_check_mark: | N/A | | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for the patch entity to become available in Search API. Useful for large migrations | | | `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = returns the patch result but doesn't perform the patch. | | diff --git a/entity/docs/models/operations/patchentityresponse.md b/entity/docs/models/operations/patchentityresponse.md index 467382ce7..8d19f1d75 100755 --- a/entity/docs/models/operations/patchentityresponse.md +++ b/entity/docs/models/operations/patchentityresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | -| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | [object Object] | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `entity_item` | [Optional[shared.EntityItem]](../../models/shared/entityitem.md) | :heavy_minus_sign: | Entity was updated | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md b/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md index 5338757ad..f168c0c5e 100755 --- a/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md +++ b/entity/docs/models/operations/taxonomiesclassificationssearch200applicationjson.md @@ -7,4 +7,4 @@ Returns list of taxonomy classifications | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `results` | List[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md b/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md index f865d8a3c..25a355308 100755 --- a/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md +++ b/entity/docs/models/operations/taxonomiesclassificationssearchrequestbody.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `classification_ids` | list[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `classification_ids` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md b/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md index 697d86e3b..6d3f7a5a4 100755 --- a/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md +++ b/entity/docs/models/operations/taxonomyautocomplete200applicationjson.md @@ -7,4 +7,4 @@ Taxonomy classifications | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `results` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `results` | List[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md index 4518623a3..d1b75fcf8 100755 --- a/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md +++ b/entity/docs/models/operations/updateclassificationsfortaxonomy200applicationjson.md @@ -7,6 +7,6 @@ Taxonomies classifications | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | +| `created` | List[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | | `deleted` | [Optional[UpdateClassificationsForTaxonomy200ApplicationJSONDeleted]](../../models/operations/updateclassificationsfortaxonomy200applicationjsondeleted.md) | :heavy_minus_sign: | N/A | -| `updated` | list[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `updated` | List[[shared.TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/updateentityrequest.md b/entity/docs/models/operations/updateentityrequest.md index 5ef553cce..3ecf72e57 100755 --- a/entity/docs/models/operations/updateentityrequest.md +++ b/entity/docs/models/operations/updateentityrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `request_body` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `entity` | [Optional[shared.Entity]](../../models/shared/entity.md) | :heavy_minus_sign: | N/A | | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | | `id` | *str* | :heavy_check_mark: | Entity id | | diff --git a/entity/docs/models/operations/updateentityresponse.md b/entity/docs/models/operations/updateentityresponse.md index 57160b4e0..208ff22d9 100755 --- a/entity/docs/models/operations/updateentityresponse.md +++ b/entity/docs/models/operations/updateentityresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | -| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Success | [object Object] | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `entity_item` | [Optional[shared.EntityItem]](../../models/shared/entityitem.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/operations/updaterelationrequestbody.md b/entity/docs/models/operations/updaterelationrequestbody.md index f909edeab..b25bcf3cf 100755 --- a/entity/docs/models/operations/updaterelationrequestbody.md +++ b/entity/docs/models/operations/updaterelationrequestbody.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `tags` | list[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `tags` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityrequestbody.md b/entity/docs/models/operations/upsertentityrequestbody.md index d1ae2ddf5..552791f3e 100755 --- a/entity/docs/models/operations/upsertentityrequestbody.md +++ b/entity/docs/models/operations/upsertentityrequestbody.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `entity` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | -| `unique_key` | list[*str*] | :heavy_check_mark: | N/A | _id | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `entity` | [shared.Entity](../../models/shared/entity.md) | :heavy_check_mark: | N/A | | +| `unique_key` | List[*str*] | :heavy_check_mark: | N/A | _id | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityresponse.md b/entity/docs/models/operations/upsertentityresponse.md index 54b3556e9..5564f69f6 100755 --- a/entity/docs/models/operations/upsertentityresponse.md +++ b/entity/docs/models/operations/upsertentityresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | -| `entity_item` | dict[str, *Any*] | :heavy_minus_sign: | Entity was updated | [object Object] | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `entity_item` | [Optional[shared.EntityItem]](../../models/shared/entityitem.md) | :heavy_minus_sign: | Entity was updated | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/models/shared/activity.md b/entity/docs/models/shared/activity.md index 7265c71e2..ac2a014df 100755 --- a/entity/docs/models/shared/activity.md +++ b/entity/docs/models/shared/activity.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | `message` | *str* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | -| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `payload` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | | `title` | *str* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | | `type` | *str* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file diff --git a/entity/docs/models/shared/activitycallercontext.md b/entity/docs/models/shared/activitycallercontext.md new file mode 100755 index 000000000..3aa216ba6 --- /dev/null +++ b/entity/docs/models/shared/activitycallercontext.md @@ -0,0 +1,9 @@ +# ActivityCallerContext + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `epilot_auth` | [Optional[ActivityCallerContextEpilotAuth]](../../models/shared/activitycallercontextepilotauth.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/activitycallercontextepilotauth.md b/entity/docs/models/shared/activitycallercontextepilotauth.md new file mode 100755 index 000000000..a5cc2fcf3 --- /dev/null +++ b/entity/docs/models/shared/activitycallercontextepilotauth.md @@ -0,0 +1,8 @@ +# ActivityCallerContextEpilotAuth + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `token` | [Optional[ActivityCallerContextEpilotAuthToken]](../../models/shared/activitycallercontextepilotauthtoken.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/activitycallercontextepilotauthtoken.md b/entity/docs/models/shared/activitycallercontextepilotauthtoken.md new file mode 100755 index 000000000..11dd7d5a9 --- /dev/null +++ b/entity/docs/models/shared/activitycallercontextepilotauthtoken.md @@ -0,0 +1,11 @@ +# ActivityCallerContextEpilotAuthToken + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | +| `cognito_username` | *Optional[str]* | :heavy_minus_sign: | N/A | example@epilot.cloud | +| `custom_ivy_user_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 10006129 | +| `email` | *Optional[str]* | :heavy_minus_sign: | N/A | example@epilot.cloud | +| `sub` | *Optional[str]* | :heavy_minus_sign: | N/A | 476e9b48-42f4-4234-a2b0-4668b34626ce | \ No newline at end of file diff --git a/entity/docs/models/shared/activityitem.md b/entity/docs/models/shared/activityitem.md index 8e541d6b5..8af878cd7 100755 --- a/entity/docs/models/shared/activityitem.md +++ b/entity/docs/models/shared/activityitem.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `caller` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `message` | *str* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | -| `operations` | list[[EntityOperation](../../models/shared/entityoperation.md)] | :heavy_minus_sign: | N/A | | -| `operations_total` | *Optional[int]* | :heavy_minus_sign: | Count of total operations attached to this activity | 1 | -| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | -| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | -| `title` | *str* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | -| `type` | *str* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `caller` | [Optional[ActivityCallerContext]](../../models/shared/activitycallercontext.md) | :heavy_minus_sign: | N/A | | +| `message` | *str* | :heavy_check_mark: | Message for activity. Supports handlebars syntax. | {{caller}} did something with {{entity payload.entity.id}}. | +| `operations` | List[[EntityOperation](../../models/shared/entityoperation.md)] | :heavy_minus_sign: | N/A | | +| `operations_total` | *Optional[int]* | :heavy_minus_sign: | Count of total operations attached to this activity | 1 | +| `payload` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | +| `title` | *str* | :heavy_check_mark: | Title for activity. Supports handlebars syntax. | My custom activity | +| `type` | *str* | :heavy_check_mark: | N/A | MyCustomActivity | \ No newline at end of file diff --git a/entity/docs/models/shared/addressrelationattribute.md b/entity/docs/models/shared/addressrelationattribute.md index a7b8382bd..b658b40b4 100755 --- a/entity/docs/models/shared/addressrelationattribute.md +++ b/entity/docs/models/shared/addressrelationattribute.md @@ -7,7 +7,7 @@ Reference to an address attribute of another entity | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[AddressRelationAttributeConstraints]](../../models/shared/addressrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/automationattribute.md b/entity/docs/models/shared/automationattribute.md index f0806752c..e7a7b51db 100755 --- a/entity/docs/models/shared/automationattribute.md +++ b/entity/docs/models/shared/automationattribute.md @@ -7,7 +7,7 @@ Automation entity | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[AutomationAttributeConstraints]](../../models/shared/automationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/booleanattribute.md b/entity/docs/models/shared/booleanattribute.md index 83a502ad8..4e5badcf8 100755 --- a/entity/docs/models/shared/booleanattribute.md +++ b/entity/docs/models/shared/booleanattribute.md @@ -7,7 +7,7 @@ Yes / No Toggle | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[BooleanAttributeConstraints]](../../models/shared/booleanattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/classificationsupdate.md b/entity/docs/models/shared/classificationsupdate.md index b54b24277..1335f94ee 100755 --- a/entity/docs/models/shared/classificationsupdate.md +++ b/entity/docs/models/shared/classificationsupdate.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `create` | list[[TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | -| `delete` | list[*str*] | :heavy_minus_sign: | N/A | -| `update` | list[[TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `create` | List[[TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | +| `delete` | List[*str*] | :heavy_minus_sign: | N/A | +| `update` | List[[TaxonomyClassification](../../models/shared/taxonomyclassification.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/computedattribute.md b/entity/docs/models/shared/computedattribute.md index ea4891fac..cf6792c03 100755 --- a/entity/docs/models/shared/computedattribute.md +++ b/entity/docs/models/shared/computedattribute.md @@ -7,7 +7,7 @@ An attribute that is computed from the entity data. For more details on how to u | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[ComputedAttributeConstraints]](../../models/shared/computedattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/consentattribute.md b/entity/docs/models/shared/consentattribute.md index 375da754a..c6cf9ec71 100755 --- a/entity/docs/models/shared/consentattribute.md +++ b/entity/docs/models/shared/consentattribute.md @@ -7,7 +7,7 @@ Consent Management | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[ConsentAttributeConstraints]](../../models/shared/consentattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | @@ -17,7 +17,7 @@ Consent Management | `hidden` | *Optional[bool]* | :heavy_minus_sign: | Do not render attribute in entity views | | | `hide_label` | *Optional[bool]* | :heavy_minus_sign: | When set to true, will hide the label of the field. | | | `icon` | *Optional[str]* | :heavy_minus_sign: | Code name of the icon to used to represent this attribute.
The value must be a valid @epilot/base-elements Icon name
| | -| `identifiers` | list[*str*] | :heavy_minus_sign: | N/A | | +| `identifiers` | List[*str*] | :heavy_minus_sign: | N/A | | | `info_helpers` | [Optional[ConsentAttributeInfoHelpers]](../../models/shared/consentattributeinfohelpers.md) | :heavy_minus_sign: | A set of configurations meant to document and assist the user in filling the attribute. | | | `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | diff --git a/entity/docs/models/shared/countryattribute.md b/entity/docs/models/shared/countryattribute.md index d734f6d41..99eb362c3 100755 --- a/entity/docs/models/shared/countryattribute.md +++ b/entity/docs/models/shared/countryattribute.md @@ -7,7 +7,7 @@ Country picker | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[CountryAttributeConstraints]](../../models/shared/countryattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/currencyattribute.md b/entity/docs/models/shared/currencyattribute.md index 566e91a01..e92da118c 100755 --- a/entity/docs/models/shared/currencyattribute.md +++ b/entity/docs/models/shared/currencyattribute.md @@ -7,9 +7,9 @@ Currency input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[CurrencyAttributeConstraints]](../../models/shared/currencyattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | -| `currency` | list[[Union[CurrencyAttributeCurrency1]](../../models/shared/currencyattributecurrency.md)] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | +| `currency` | List[[Union[CurrencyAttributeCurrency1]](../../models/shared/currencyattributecurrency.md)] | :heavy_check_mark: | An array of currency configurations with a country code (ISO-4217) | | | `currency_selector_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/dateattribute.md b/entity/docs/models/shared/dateattribute.md index 43649e651..641dccdbc 100755 --- a/entity/docs/models/shared/dateattribute.md +++ b/entity/docs/models/shared/dateattribute.md @@ -7,7 +7,7 @@ Date or Datetime picker | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[DateAttributeConstraints]](../../models/shared/dateattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/entity.md b/entity/docs/models/shared/entity.md new file mode 100755 index 000000000..8795a763e --- /dev/null +++ b/entity/docs/models/shared/entity.md @@ -0,0 +1,17 @@ +# Entity + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `acl` | [Optional[EntityACL]](../../models/shared/entityacl.md) | :heavy_minus_sign: | Access control list (ACL) for an entity. Defines sharing access to external orgs or users. | | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organization Id the entity belongs to | | +| `owners` | List[[EntityOwner](../../models/shared/entityowner.md)] | :heavy_minus_sign: | N/A | | +| `schema` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | +| `tags` | List[*str*] | :heavy_minus_sign: | N/A | | +| `title` | *Optional[str]* | :heavy_minus_sign: | Title of entity | | +| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityacl.md b/entity/docs/models/shared/entityacl.md new file mode 100755 index 000000000..a01f06213 --- /dev/null +++ b/entity/docs/models/shared/entityacl.md @@ -0,0 +1,13 @@ +# EntityACL + +Access control list (ACL) for an entity. Defines sharing access to external orgs or users. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `delete` | List[*str*] | :heavy_minus_sign: | N/A | org:456 | +| `edit` | List[*str*] | :heavy_minus_sign: | N/A | org:456 | +| `view` | List[*str*] | :heavy_minus_sign: | N/A | org:456 | \ No newline at end of file diff --git a/entity/docs/models/shared/entitycapability.md b/entity/docs/models/shared/entitycapability.md index 0c39a607d..d3384c85b 100755 --- a/entity/docs/models/shared/entitycapability.md +++ b/entity/docs/models/shared/entitycapability.md @@ -7,11 +7,11 @@ Capabilities the Entity has. Turn features on/off for entities. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | +| `attributes` | List[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_minus_sign: | N/A | | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | | `legacy` | *Optional[bool]* | :heavy_minus_sign: | Only show capability for legacy tenants (ivy) | | | `name` | *str* | :heavy_check_mark: | Unique name for the capability | customer_messaging | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This capability should only be active when the setting is enabled | MY_SETTING | | `title` | *Optional[str]* | :heavy_minus_sign: | Human readable title of the capability | Messaging | -| `ui_hooks` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `ui_hooks` | List[[EntityCapabilityUIHooks](../../models/shared/entitycapabilityuihooks.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitycapabilityuihooks.md b/entity/docs/models/shared/entitycapabilityuihooks.md new file mode 100755 index 000000000..ac7cee710 --- /dev/null +++ b/entity/docs/models/shared/entitycapabilityuihooks.md @@ -0,0 +1,20 @@ +# EntityCapabilityUIHooks + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `component` | *Optional[str]* | :heavy_minus_sign: | the component to be dynamically loaded | PricingItems | +| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether capability should be disabled | | +| `group_expanded` | *Optional[bool]* | :heavy_minus_sign: | Sets the group expand/collapse default state | | +| `header` | *Optional[bool]* | :heavy_minus_sign: | Specific to Activity pilot | | +| `hook` | *str* | :heavy_check_mark: | name of the hook to use | EntityDetailsV2:Tab | +| `icon` | *Optional[str]* | :heavy_minus_sign: | Preview icon name(As in Base elements) for the capability | email | +| `import_` | *Optional[str]* | :heavy_minus_sign: | package to be imported | @epilot360/notes | +| `order` | *Optional[int]* | :heavy_minus_sign: | render order (ascending) | 10 | +| `render_condition` | *Optional[str]* | :heavy_minus_sign: | N/A | _is_composite_price = "false" | +| `required_permission` | [Optional[EntityCapabilityUIHooksRequiredPermission]](../../models/shared/entitycapabilityuihooksrequiredpermission.md) | :heavy_minus_sign: | Require a permission to display UI hook | | +| `route` | *Optional[str]* | :heavy_minus_sign: | route for specified capability | notes | +| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | Notes | \ No newline at end of file diff --git a/entity/docs/models/shared/entitycapabilityuihooksrequiredpermission.md b/entity/docs/models/shared/entitycapabilityuihooksrequiredpermission.md new file mode 100755 index 000000000..02ec78b3a --- /dev/null +++ b/entity/docs/models/shared/entitycapabilityuihooksrequiredpermission.md @@ -0,0 +1,11 @@ +# EntityCapabilityUIHooksRequiredPermission + +Require a permission to display UI hook + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `action` | *str* | :heavy_check_mark: | N/A | note:view | +| `resource` | *Optional[str]* | :heavy_minus_sign: | N/A | 123 | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreate.md b/entity/docs/models/shared/entitydefaultcreate.md index d4699a2db..c7154b1ce 100755 --- a/entity/docs/models/shared/entitydefaultcreate.md +++ b/entity/docs/models/shared/entitydefaultcreate.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | +| `search_params` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | `table_menu_options` | [Optional[EntityDefaultCreateTableMenuOptions]](../../models/shared/entitydefaultcreatetablemenuoptions.md) | :heavy_minus_sign: | N/A | | `view_type` | [Optional[EntityDefaultCreateViewType]](../../models/shared/entitydefaultcreateviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultedit.md b/entity/docs/models/shared/entitydefaultedit.md index 8fa4dcea9..af949f786 100755 --- a/entity/docs/models/shared/entitydefaultedit.md +++ b/entity/docs/models/shared/entitydefaultedit.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `search_params` | dict[str, *str*] | :heavy_minus_sign: | N/A | | -| `summary_attributes` | list[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | email | +| `search_params` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | +| `summary_attributes` | List[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | email | | `table_menu_options` | [Optional[EntityDefaultEditTableMenuOptions]](../../models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | | | `view_type` | [Optional[EntityDefaultEditViewType]](../../models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttable.md b/entity/docs/models/shared/entitydefaulttable.md index 4fd442fe1..c5179825e 100755 --- a/entity/docs/models/shared/entitydefaulttable.md +++ b/entity/docs/models/shared/entitydefaulttable.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `classic_view` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `dropdown_items` | list[[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]](../../models/shared/entitydefaulttabledropdownitems.md)] | :heavy_minus_sign: | N/A | +| `dropdown_items` | List[[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]](../../models/shared/entitydefaulttabledropdownitems.md)] | :heavy_minus_sign: | N/A | | `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | -| `navbar_actions` | list[[EntityDefaultTableNavbarActions](../../models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | -| `row_actions` | list[*str*] | :heavy_minus_sign: | N/A | +| `navbar_actions` | List[[EntityDefaultTableNavbarActions](../../models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | +| `row_actions` | List[*str*] | :heavy_minus_sign: | N/A | | `view_type` | [Optional[EntityDefaultTableViewType]](../../models/shared/entitydefaulttableviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttablenavbaractions.md b/entity/docs/models/shared/entitydefaulttablenavbaractions.md index 0d1db344c..00acf7269 100755 --- a/entity/docs/models/shared/entitydefaulttablenavbaractions.md +++ b/entity/docs/models/shared/entitydefaulttablenavbaractions.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `options` | list[[EntityDefaultTableNavbarActionsOptions](../../models/shared/entitydefaulttablenavbaractionsoptions.md)] | :heavy_minus_sign: | N/A | +| `options` | List[[EntityDefaultTableNavbarActionsOptions](../../models/shared/entitydefaulttablenavbaractionsoptions.md)] | :heavy_minus_sign: | N/A | | `type` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityitem.md b/entity/docs/models/shared/entityitem.md new file mode 100755 index 000000000..166bd7672 --- /dev/null +++ b/entity/docs/models/shared/entityitem.md @@ -0,0 +1,17 @@ +# EntityItem + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `acl` | [Optional[EntityACL]](../../models/shared/entityacl.md) | :heavy_minus_sign: | Access control list (ACL) for an entity. Defines sharing access to external orgs or users. | | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `org` | *str* | :heavy_check_mark: | Organization Id the entity belongs to | | +| `owners` | List[[EntityOwner](../../models/shared/entityowner.md)] | :heavy_minus_sign: | N/A | | +| `schema` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `tags` | List[*str*] | :heavy_minus_sign: | N/A | | +| `title` | *Optional[str]* | :heavy_check_mark: | Title of entity | | +| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperation.md b/entity/docs/models/shared/entityoperation.md index 401354a6f..85602d89d 100755 --- a/entity/docs/models/shared/entityoperation.md +++ b/entity/docs/models/shared/entityoperation.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `activity_id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `diff` | [Optional[EntityOperationDiff]](../../models/shared/entityoperationdiff.md) | :heavy_minus_sign: | N/A | | -| `entity` | *str* | :heavy_check_mark: | N/A | | -| `operation` | [EntityOperationOperation](../../models/shared/entityoperationoperation.md) | :heavy_check_mark: | N/A | | -| `org` | *str* | :heavy_check_mark: | N/A | 123 | -| `params` | [Optional[EntityOperationParams]](../../models/shared/entityoperationparams.md) | :heavy_minus_sign: | N/A | | -| `payload` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | See https://github.com/ulid/spec | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `diff` | [Optional[EntityOperationDiff]](../../models/shared/entityoperationdiff.md) | :heavy_minus_sign: | N/A | | +| `entity` | *str* | :heavy_check_mark: | N/A | | +| `operation` | [EntityOperationOperation](../../models/shared/entityoperationoperation.md) | :heavy_check_mark: | N/A | | +| `org` | *str* | :heavy_check_mark: | N/A | 123 | +| `params` | [Optional[EntityOperationParams]](../../models/shared/entityoperationparams.md) | :heavy_minus_sign: | N/A | | +| `payload` | [Optional[EntityOperationPayload]](../../models/shared/entityoperationpayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperationdiff.md b/entity/docs/models/shared/entityoperationdiff.md index f2a5760c2..74ef20389 100755 --- a/entity/docs/models/shared/entityoperationdiff.md +++ b/entity/docs/models/shared/entityoperationdiff.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `added` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | -| `deleted` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | -| `updated` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | +| `added` | [Optional[Entity]](../../models/shared/entity.md) | :heavy_minus_sign: | N/A | +| `deleted` | [Optional[Entity]](../../models/shared/entity.md) | :heavy_minus_sign: | N/A | +| `updated` | [Optional[Entity]](../../models/shared/entity.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityoperationpayload.md b/entity/docs/models/shared/entityoperationpayload.md new file mode 100755 index 000000000..277d48767 --- /dev/null +++ b/entity/docs/models/shared/entityoperationpayload.md @@ -0,0 +1,17 @@ +# EntityOperationPayload + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `acl` | [Optional[EntityACL]](../../models/shared/entityacl.md) | :heavy_minus_sign: | Access control list (ACL) for an entity. Defines sharing access to external orgs or users. | | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organization Id the entity belongs to | | +| `owners` | List[[EntityOwner](../../models/shared/entityowner.md)] | :heavy_minus_sign: | N/A | | +| `schema` | *Optional[str]* | :heavy_minus_sign: | URL-friendly identifier for the entity schema | contact | +| `tags` | List[*str*] | :heavy_minus_sign: | N/A | | +| `title` | *Optional[str]* | :heavy_minus_sign: | Title of entity | | +| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entityowner.md b/entity/docs/models/shared/entityowner.md new file mode 100755 index 000000000..a4848e499 --- /dev/null +++ b/entity/docs/models/shared/entityowner.md @@ -0,0 +1,14 @@ +# EntityOwner + +The user / organization owning this entity. + +Note: Owner implicitly has access to the entity regardless of ACLs. + + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `org_id` | *str* | :heavy_check_mark: | N/A | 123 | +| `user_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 123 | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschema.md b/entity/docs/models/shared/entityschema.md index 1b9572f24..88a62d22a 100755 --- a/entity/docs/models/shared/entityschema.md +++ b/entity/docs/models/shared/entityschema.md @@ -7,17 +7,17 @@ The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relati | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] | +| `attributes` | List[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] | | `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | -| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | -| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `capabilities` | List[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | +| `dialog_config` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | | `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | 360_features | -| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| [object Object] | +| `enable_setting` | List[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | 360_features | +| `explicit_search_mappings` | Dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| [object Object] | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `group_settings` | list[[EntitySchemaGroupSettings](../../models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | [object Object],[object Object] | +| `group_settings` | List[[EntitySchemaGroupSettings](../../models/shared/entityschemagroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | [object Object],[object Object] | | `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | -| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | +| `layout_settings` | [Optional[EntitySchemaLayoutSettings]](../../models/shared/entityschemalayoutsettings.md) | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | | `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | | `plural` | *str* | :heavy_check_mark: | N/A | Contacts | | `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | diff --git a/entity/docs/models/shared/entityschemagroupsettings.md b/entity/docs/models/shared/entityschemagroupsettings.md index 22ed11aff..75ef6e3d2 100755 --- a/entity/docs/models/shared/entityschemagroupsettings.md +++ b/entity/docs/models/shared/entityschemagroupsettings.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | | `id` | *str* | :heavy_check_mark: | N/A | | diff --git a/entity/docs/models/shared/entityschemaitem.md b/entity/docs/models/shared/entityschemaitem.md index adb7ef7fe..15a84fa99 100755 --- a/entity/docs/models/shared/entityschemaitem.md +++ b/entity/docs/models/shared/entityschemaitem.md @@ -7,20 +7,20 @@ The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relati | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `attributes` | list[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] | +| `attributes` | List[[Union[TextAttribute, LinkAttribute, DateAttribute, CountryAttribute, BooleanAttribute, SelectAttribute, MultiSelectAttribute, StatusAttribute, SequenceAttribute, RelationAttribute, UserRelationAttribute, AddressRelationAttribute, PaymentMethodRelationAttribute, CurrencyAttribute, RepeatableAttribute, TagsAttribute, NumberAttribute, ConsentAttribute, InternalAttribute, OrderedListAttribute, FileAttribute, ComputedAttribute, PartnerStatusAttribute, InvitationEmailAttribute, AutomationAttribute, InternalUserAttribute, PurposeAttribute, PartnerOrganisationAttribute]](../../models/shared/attribute.md)] | :heavy_check_mark: | An ordered list of attributes the entity contains | [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] | | `blueprint` | *Optional[str]* | :heavy_minus_sign: | Reference to blueprint | | -| `capabilities` | list[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | +| `capabilities` | List[[EntityCapability](../../models/shared/entitycapability.md)] | :heavy_check_mark: | N/A | | | `comment` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `dialog_config` | dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `dialog_config` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | | `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `enable_setting` | list[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | 360_features | -| `explicit_search_mappings` | dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| [object Object] | +| `enable_setting` | List[*str*] | :heavy_minus_sign: | This schema should only be active when one of the organization settings is enabled | 360_features | +| `explicit_search_mappings` | Dict[str, [SearchMappings](../../models/shared/searchmappings.md)] | :heavy_minus_sign: | Advanced: explicit Elasticsearch index mapping definitions for entity data
| [object Object] | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This schema should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | -| `group_settings` | list[[EntitySchemaItemGroupSettings](../../models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | [object Object],[object Object] | +| `group_settings` | List[[EntitySchemaItemGroupSettings](../../models/shared/entityschemaitemgroupsettings.md)] | :heavy_minus_sign: | A dictionary of Group Titles and associated settings if present. | [object Object],[object Object] | | `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | person | | `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for schema | | -| `layout_settings` | dict[str, *Any*] | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | +| `layout_settings` | [Optional[EntitySchemaItemLayoutSettings]](../../models/shared/entityschemaitemlayoutsettings.md) | :heavy_minus_sign: | Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
- Managed Properties: are interpreted and transformed into layout styles
- Un-managed Properties: are appended as styles into the attribute mounting node
| | | `name` | *str* | :heavy_check_mark: | User-friendly identifier for the entity schema | Contact | | `plural` | *str* | :heavy_check_mark: | N/A | Contacts | | `published` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | diff --git a/entity/docs/models/shared/entityschemaitemgroupsettings.md b/entity/docs/models/shared/entityschemaitemgroupsettings.md index 764606624..59974ae7f 100755 --- a/entity/docs/models/shared/entityschemaitemgroupsettings.md +++ b/entity/docs/models/shared/entityschemaitemgroupsettings.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `expanded` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `feature_flag` | *Optional[str]* | :heavy_minus_sign: | This group should only be active when the feature flag is enabled | FF_MY_FEATURE_FLAG | | `id` | *str* | :heavy_check_mark: | N/A | | diff --git a/entity/docs/models/shared/entityschemaitemlayoutsettings.md b/entity/docs/models/shared/entityschemaitemlayoutsettings.md new file mode 100755 index 000000000..43778e08e --- /dev/null +++ b/entity/docs/models/shared/entityschemaitemlayoutsettings.md @@ -0,0 +1,15 @@ +# EntitySchemaItemLayoutSettings + +Custom grid definitions for the layout. These settings are composed by managed and un-managed properties: +- Managed Properties: are interpreted and transformed into layout styles +- Un-managed Properties: are appended as styles into the attribute mounting node + + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `grid_gap` | *Optional[str]* | :heavy_minus_sign: | Defines the grid gap for the mounting node of the attribute. | +| `grid_template_columns` | *Optional[str]* | :heavy_minus_sign: | Defines the grid column template for the mounting node of the attribute. | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md index baa96f3e0..72921e7c9 100755 --- a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md +++ b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `summary_attributes` | list[[Union[SummaryAttribute, str]](../../models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `summary_attributes` | List[[Union[SummaryAttribute, str]](../../models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemalayoutsettings.md b/entity/docs/models/shared/entityschemalayoutsettings.md new file mode 100755 index 000000000..44eb5a085 --- /dev/null +++ b/entity/docs/models/shared/entityschemalayoutsettings.md @@ -0,0 +1,15 @@ +# EntitySchemaLayoutSettings + +Custom grid definitions for the layout. These settings are composed by managed and un-managed properties: +- Managed Properties: are interpreted and transformed into layout styles +- Un-managed Properties: are appended as styles into the attribute mounting node + + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `grid_gap` | *Optional[str]* | :heavy_minus_sign: | Defines the grid gap for the mounting node of the attribute. | +| `grid_template_columns` | *Optional[str]* | :heavy_minus_sign: | Defines the grid column template for the mounting node of the attribute. | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfiglistitem.md b/entity/docs/models/shared/entityschemauiconfiglistitem.md index d55ca9564..6a0cf0342 100755 --- a/entity/docs/models/shared/entityschemauiconfiglistitem.md +++ b/entity/docs/models/shared/entityschemauiconfiglistitem.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `summary_attributes` | list[[Union[SummaryAttribute, str]](../../models/shared/entityschemauiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `summary_attributes` | List[[Union[SummaryAttribute, str]](../../models/shared/entityschemauiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitysearchparams.md b/entity/docs/models/shared/entitysearchparams.md index 57b2dcef4..8693681e9 100755 --- a/entity/docs/models/shared/entitysearchparams.md +++ b/entity/docs/models/shared/entitysearchparams.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `aggs` | [Optional[EntitySearchParamsAggs]](../../models/shared/entitysearchparamsaggs.md) | :heavy_minus_sign: | Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics. | | -| `fields_` | list[*str*] | :heavy_minus_sign: | List of entity fields to include in search results | _id,_title,first_name | +| `fields_` | List[*str*] | :heavy_minus_sign: | List of entity fields to include in search results | _id,_title,first_name | | `from_` | *Optional[int]* | :heavy_minus_sign: | N/A | | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | | `include_scores` | *Optional[bool]* | :heavy_minus_sign: | Adds a `_score` number field to results that can be used to rank by match score | | diff --git a/entity/docs/models/shared/entitysearchresults.md b/entity/docs/models/shared/entitysearchresults.md index bc0247253..8024a7bc0 100755 --- a/entity/docs/models/shared/entitysearchresults.md +++ b/entity/docs/models/shared/entitysearchresults.md @@ -7,4 +7,4 @@ | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | `aggregations` | [Optional[EntitySearchResultsAggregations]](../../models/shared/entitysearchresultsaggregations.md) | :heavy_minus_sign: | N/A | | | `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `results` | list[dict[str, *Any*]] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `results` | List[[EntityItem](../../models/shared/entityitem.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/fileattribute.md b/entity/docs/models/shared/fileattribute.md index f19274b41..fb83c0a97 100755 --- a/entity/docs/models/shared/fileattribute.md +++ b/entity/docs/models/shared/fileattribute.md @@ -7,8 +7,8 @@ File or Image Attachment | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `allowed_extensions` | list[*str*] | :heavy_minus_sign: | List of file extensions (without the dot suffix) | csv | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | +| `allowed_extensions` | List[*str*] | :heavy_minus_sign: | List of file extensions (without the dot suffix) | csv | | `constraints` | [Optional[FileAttributeConstraints]](../../models/shared/fileattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_access_control` | [Optional[FileAttributeDefaultAccessControl]](../../models/shared/fileattributedefaultaccesscontrol.md) | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/getrelationsresp.md b/entity/docs/models/shared/getrelationsresp.md index 8f246b248..837a898bb 100755 --- a/entity/docs/models/shared/getrelationsresp.md +++ b/entity/docs/models/shared/getrelationsresp.md @@ -9,9 +9,9 @@ getRelationsResp: shared.RelationItem = /* values here */ ``` -### +### RelationEntity ```python -getRelationsResp: dict[str, Any] = /* values here */ +getRelationsResp: shared.RelationEntity = /* values here */ ``` diff --git a/entity/docs/models/shared/getrelationsrespwithpagination.md b/entity/docs/models/shared/getrelationsrespwithpagination.md index 37bfbbe33..388754516 100755 --- a/entity/docs/models/shared/getrelationsrespwithpagination.md +++ b/entity/docs/models/shared/getrelationsrespwithpagination.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | `hits` | *Optional[float]* | :heavy_minus_sign: | N/A | 1 | -| `relations` | list[[Union[RelationItem, dict[str, Any]]](../../models/shared/getrelationsresp.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `relations` | List[[Union[RelationItem, RelationEntity]](../../models/shared/getrelationsresp.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/internalattribute.md b/entity/docs/models/shared/internalattribute.md index 88f5067bd..42d1d7a1c 100755 --- a/entity/docs/models/shared/internalattribute.md +++ b/entity/docs/models/shared/internalattribute.md @@ -7,7 +7,7 @@ No UI representation | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[InternalAttributeConstraints]](../../models/shared/internalattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/internaluserattribute.md b/entity/docs/models/shared/internaluserattribute.md index 03a2edc50..4594b43d9 100755 --- a/entity/docs/models/shared/internaluserattribute.md +++ b/entity/docs/models/shared/internaluserattribute.md @@ -7,7 +7,7 @@ Epilot internal user info | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[InternalUserAttributeConstraints]](../../models/shared/internaluserattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/invitationemailattribute.md b/entity/docs/models/shared/invitationemailattribute.md index 3537e8fa1..f835a26a2 100755 --- a/entity/docs/models/shared/invitationemailattribute.md +++ b/entity/docs/models/shared/invitationemailattribute.md @@ -7,7 +7,7 @@ Email address for send invitation | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[InvitationEmailAttributeConstraints]](../../models/shared/invitationemailattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/linkattribute.md b/entity/docs/models/shared/linkattribute.md index 7a898a93b..76da3c59f 100755 --- a/entity/docs/models/shared/linkattribute.md +++ b/entity/docs/models/shared/linkattribute.md @@ -7,7 +7,7 @@ Link with title and href | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[LinkAttributeConstraints]](../../models/shared/linkattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/multiselectattribute.md b/entity/docs/models/shared/multiselectattribute.md index 93811b3a9..59c17f564 100755 --- a/entity/docs/models/shared/multiselectattribute.md +++ b/entity/docs/models/shared/multiselectattribute.md @@ -7,7 +7,7 @@ Multi Choice Selection | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `allow_any` | *Optional[bool]* | :heavy_minus_sign: | Allow arbitrary input values in addition to provided options | | | `allow_extra_options` | *Optional[bool]* | :heavy_minus_sign: | controls if the 360 ui will allow the user to enter a value which is not defined by the options | | | `constraints` | [Optional[MultiSelectAttributeConstraints]](../../models/shared/multiselectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | @@ -24,7 +24,7 @@ Multi Choice Selection | `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `name` | *str* | :heavy_check_mark: | N/A | | -| `options` | list[[Union[str, MultiSelectAttributeOptions2]](../../models/shared/multiselectattributeoptions.md)] | :heavy_minus_sign: | N/A | | +| `options` | List[[Union[str, MultiSelectAttributeOptions2]](../../models/shared/multiselectattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/numberattribute.md b/entity/docs/models/shared/numberattribute.md index 8c3c883bb..e832be565 100755 --- a/entity/docs/models/shared/numberattribute.md +++ b/entity/docs/models/shared/numberattribute.md @@ -7,7 +7,7 @@ Numeric input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[NumberAttributeConstraints]](../../models/shared/numberattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/orderedlistattribute.md b/entity/docs/models/shared/orderedlistattribute.md index 7e9bc77d4..2169cf077 100755 --- a/entity/docs/models/shared/orderedlistattribute.md +++ b/entity/docs/models/shared/orderedlistattribute.md @@ -7,7 +7,7 @@ Type of attribute to render N number of ordered fields | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[OrderedListAttributeConstraints]](../../models/shared/orderedlistattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/partnerorganisationattribute.md b/entity/docs/models/shared/partnerorganisationattribute.md index e792e4d42..de15cbcf0 100755 --- a/entity/docs/models/shared/partnerorganisationattribute.md +++ b/entity/docs/models/shared/partnerorganisationattribute.md @@ -7,7 +7,7 @@ Shared Partner Organisations | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[PartnerOrganisationAttributeConstraints]](../../models/shared/partnerorganisationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/partnerstatusattribute.md b/entity/docs/models/shared/partnerstatusattribute.md index a56225c9a..04bd26dff 100755 --- a/entity/docs/models/shared/partnerstatusattribute.md +++ b/entity/docs/models/shared/partnerstatusattribute.md @@ -7,7 +7,7 @@ Partner Status | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[PartnerStatusAttributeConstraints]](../../models/shared/partnerstatusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/paymentmethodrelationattribute.md b/entity/docs/models/shared/paymentmethodrelationattribute.md index 9586f898f..bbedfe0f9 100755 --- a/entity/docs/models/shared/paymentmethodrelationattribute.md +++ b/entity/docs/models/shared/paymentmethodrelationattribute.md @@ -7,7 +7,7 @@ Reference to a payment method attribute of another entity | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[PaymentMethodRelationAttributeConstraints]](../../models/shared/paymentmethodrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/purposeattribute.md b/entity/docs/models/shared/purposeattribute.md index 6816d073d..4ca06b017 100755 --- a/entity/docs/models/shared/purposeattribute.md +++ b/entity/docs/models/shared/purposeattribute.md @@ -7,7 +7,7 @@ Entity Taxonomy | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[PurposeAttributeConstraints]](../../models/shared/purposeattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | @@ -24,7 +24,7 @@ Entity Taxonomy | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `name` | *str* | :heavy_check_mark: | N/A | Wallbox PV | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | -| `parents` | list[*str*] | :heavy_minus_sign: | N/A | | +| `parents` | List[*str*] | :heavy_minus_sign: | N/A | | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `protected` | *Optional[bool]* | :heavy_minus_sign: | Setting to `true` prevents the attribute from being modified / deleted | | diff --git a/entity/docs/models/shared/relationattribute.md b/entity/docs/models/shared/relationattribute.md index c556eb4f8..e261c8577 100755 --- a/entity/docs/models/shared/relationattribute.md +++ b/entity/docs/models/shared/relationattribute.md @@ -7,10 +7,10 @@ Entity Relationship | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | -| `actions` | list[[RelationAttributeActions](../../models/shared/relationattributeactions.md)] | :heavy_minus_sign: | N/A | [object Object] | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | +| `actions` | List[[RelationAttributeActions](../../models/shared/relationattributeactions.md)] | :heavy_minus_sign: | N/A | [object Object] | | `add_button_label` | *Optional[str]* | :heavy_minus_sign: | Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is. | | -| `allowed_schemas` | list[*str*] | :heavy_minus_sign: | N/A | | +| `allowed_schemas` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[RelationAttributeConstraints]](../../models/shared/relationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | @@ -39,11 +39,11 @@ Entity Relationship | `relation_type` | [Optional[RelationAttributeRelationType]](../../models/shared/relationattributerelationtype.md) | :heavy_minus_sign: | N/A | | | `render_condition` | *Optional[str]* | :heavy_minus_sign: | Defines the conditional rendering expression for showing this field.
When a valid expression is parsed, their evaluation defines the visibility of this attribute.
Note: Empty or invalid expression have no effect on the field visibility.
| | | `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `reverse_attributes` | dict[str, *str*] | :heavy_minus_sign: | Map of schema slug to target relation attribute | [object Object] | +| `reverse_attributes` | Dict[str, *str*] | :heavy_minus_sign: | Map of schema slug to target relation attribute | [object Object] | | `search_placeholder` | *Optional[str]* | :heavy_minus_sign: | Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is. | | | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `summary_fields` | list[[Union[str, SummaryField]](../../models/shared/relationattributesummaryfields.md)] | :heavy_minus_sign: | N/A | | +| `summary_fields` | List[[Union[str, SummaryField]](../../models/shared/relationattributesummaryfields.md)] | :heavy_minus_sign: | N/A | | | `type` | [Optional[RelationAttributeType]](../../models/shared/relationattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributeactions.md b/entity/docs/models/shared/relationattributeactions.md index b2df233e8..fc736f732 100755 --- a/entity/docs/models/shared/relationattributeactions.md +++ b/entity/docs/models/shared/relationattributeactions.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action_type` | [Optional[RelationAttributeActionsActionType]](../../models/shared/relationattributeactionsactiontype.md) | :heavy_minus_sign: | The action type. Currently supported actions:

\| action \| description \|
\|--------\|-------------\|
\| add_existing \| Enables the user to pick an existing entity to link as relation \|
\| create_new \| Enables the user to create a new entity using the first/main `allowed_schemas` schema
\| create_from_existing \| Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation \|
| | -| `default` | *Optional[bool]* | :heavy_minus_sign: | Sets the action as the default action, visible as the main action button. | | -| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the feature flag that enables this action | | -| `label` | *Optional[str]* | :heavy_minus_sign: | The action label or action translation key (i18n) | | -| `new_entity_item` | dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | -| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the setting flag that enables this action | | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `action_type` | [Optional[RelationAttributeActionsActionType]](../../models/shared/relationattributeactionsactiontype.md) | :heavy_minus_sign: | The action type. Currently supported actions:

\| action \| description \|
\|--------\|-------------\|
\| add_existing \| Enables the user to pick an existing entity to link as relation \|
\| create_new \| Enables the user to create a new entity using the first/main `allowed_schemas` schema
\| create_from_existing \| Enables the user to pick an existing entity to clone from, while creating a blank new entity to link as relation \|
| +| `default` | *Optional[bool]* | :heavy_minus_sign: | Sets the action as the default action, visible as the main action button. | +| `feature_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the feature flag that enables this action | +| `label` | *Optional[str]* | :heavy_minus_sign: | The action label or action translation key (i18n) | +| `new_entity_item` | [Optional[RelationAttributeActionsNewEntityItem]](../../models/shared/relationattributeactionsnewentityitem.md) | :heavy_minus_sign: | N/A | +| `setting_flag` | *Optional[str]* | :heavy_minus_sign: | Name of the setting flag that enables this action | \ No newline at end of file diff --git a/entity/docs/models/shared/relationattributeactionsnewentityitem.md b/entity/docs/models/shared/relationattributeactionsnewentityitem.md new file mode 100755 index 000000000..946446b35 --- /dev/null +++ b/entity/docs/models/shared/relationattributeactionsnewentityitem.md @@ -0,0 +1,17 @@ +# RelationAttributeActionsNewEntityItem + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `acl` | [Optional[EntityACL]](../../models/shared/entityacl.md) | :heavy_minus_sign: | Access control list (ACL) for an entity. Defines sharing access to external orgs or users. | | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `org` | *str* | :heavy_check_mark: | Organization Id the entity belongs to | | +| `owners` | List[[EntityOwner](../../models/shared/entityowner.md)] | :heavy_minus_sign: | N/A | | +| `schema` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `tags` | List[*str*] | :heavy_minus_sign: | N/A | | +| `title` | *Optional[str]* | :heavy_check_mark: | Title of entity | | +| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/relationentity.md b/entity/docs/models/shared/relationentity.md new file mode 100755 index 000000000..f03f5e8e5 --- /dev/null +++ b/entity/docs/models/shared/relationentity.md @@ -0,0 +1,18 @@ +# RelationEntity + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `dollar_relation` | [Optional[RelationItem]](../../models/shared/relationitem.md) | :heavy_minus_sign: | N/A | | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | [object Object] | +| `acl` | [Optional[EntityACL]](../../models/shared/entityacl.md) | :heavy_minus_sign: | Access control list (ACL) for an entity. Defines sharing access to external orgs or users. | | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | | +| `org` | *str* | :heavy_check_mark: | Organization Id the entity belongs to | | +| `owners` | List[[EntityOwner](../../models/shared/entityowner.md)] | :heavy_minus_sign: | N/A | | +| `schema` | *str* | :heavy_check_mark: | URL-friendly identifier for the entity schema | contact | +| `tags` | List[*str*] | :heavy_minus_sign: | N/A | | +| `title` | *Optional[str]* | :heavy_check_mark: | Title of entity | | +| `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/relationitem.md b/entity/docs/models/shared/relationitem.md index 900acb8c8..0c1c4cf99 100755 --- a/entity/docs/models/shared/relationitem.md +++ b/entity/docs/models/shared/relationitem.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `tags` | list[*str*] | :heavy_minus_sign: | N/A | +| `tags` | List[*str*] | :heavy_minus_sign: | N/A | | `attribute` | *str* | :heavy_check_mark: | N/A | | `entity_id` | *str* | :heavy_check_mark: | N/A | | `reverse` | *Optional[bool]* | :heavy_minus_sign: | Whether this is a reverse relation | \ No newline at end of file diff --git a/entity/docs/models/shared/repeatableattribute.md b/entity/docs/models/shared/repeatableattribute.md index ba13a0dc0..89c978d6e 100755 --- a/entity/docs/models/shared/repeatableattribute.md +++ b/entity/docs/models/shared/repeatableattribute.md @@ -7,7 +7,7 @@ Repeatable (add N number of fields) | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[RepeatableAttributeConstraints]](../../models/shared/repeatableattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/savedview.md b/entity/docs/models/shared/savedview.md index 052b2ea92..b0c332281 100755 --- a/entity/docs/models/shared/savedview.md +++ b/entity/docs/models/shared/savedview.md @@ -5,12 +5,12 @@ A saved entity view ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `created_by` | [Union[SavedViewCreatedBy1, dict[str, Any]]](../../models/shared/savedviewcreatedby.md) | :heavy_check_mark: | N/A | | -| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | 11701 | -| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | -| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | -| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | -| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | -| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `created_by` | [Union[SavedViewCreatedBy1, SavedViewCreatedBy2]](../../models/shared/savedviewcreatedby.md) | :heavy_check_mark: | N/A | | +| `is_favorited_by` | List[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | 11701 | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | +| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | +| `slug` | List[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | +| `ui_config` | Dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewcreatedby.md b/entity/docs/models/shared/savedviewcreatedby.md index d32dba75d..782e8939c 100755 --- a/entity/docs/models/shared/savedviewcreatedby.md +++ b/entity/docs/models/shared/savedviewcreatedby.md @@ -9,9 +9,9 @@ savedViewCreatedBy: shared.SavedViewCreatedBy1 = /* values here */ ``` -### +### SavedViewCreatedBy2 ```python -savedViewCreatedBy: dict[str, Any] = /* values here */ +savedViewCreatedBy: shared.SavedViewCreatedBy2 = /* values here */ ``` diff --git a/entity/docs/models/shared/savedviewcreatedby2.md b/entity/docs/models/shared/savedviewcreatedby2.md new file mode 100755 index 000000000..f39daa4a2 --- /dev/null +++ b/entity/docs/models/shared/savedviewcreatedby2.md @@ -0,0 +1,11 @@ +# SavedViewCreatedBy2 + +A system-created view + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `source` | [Optional[SavedViewCreatedBy2Source]](../../models/shared/savedviewcreatedby2source.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewcreatedby2source.md b/entity/docs/models/shared/savedviewcreatedby2source.md new file mode 100755 index 000000000..1fb6f33e5 --- /dev/null +++ b/entity/docs/models/shared/savedviewcreatedby2source.md @@ -0,0 +1,9 @@ +# SavedViewCreatedBy2Source + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SYSTEM` | SYSTEM | +| `BLUEPRINT` | BLUEPRINT | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewitem.md b/entity/docs/models/shared/savedviewitem.md index b428ce862..59ffabb40 100755 --- a/entity/docs/models/shared/savedviewitem.md +++ b/entity/docs/models/shared/savedviewitem.md @@ -5,15 +5,15 @@ A saved entity view ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `created_by` | [Union[SavedViewItemCreatedBy1, dict[str, Any]]](../../models/shared/savedviewitemcreatedby.md) | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | -| `is_favorited_by` | list[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | 11701 | -| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | -| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | -| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | -| `slug` | list[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | -| `ui_config` | dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | -| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `created_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `created_by` | [Union[SavedViewItemCreatedBy1, SavedViewItemCreatedBy2]](../../models/shared/savedviewitemcreatedby.md) | :heavy_check_mark: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | Generated uuid for a saved view | | +| `is_favorited_by` | List[*str*] | :heavy_minus_sign: | List of users (IDs) that have favorited the view | 11701 | +| `name` | *str* | :heavy_check_mark: | User-friendly identifier for the saved view | View listing German | +| `org` | *Optional[str]* | :heavy_minus_sign: | Organisation ID a view belongs to | 66 | +| `shared` | *Optional[bool]* | :heavy_minus_sign: | boolean property for if a view is shared with organisation | true | +| `slug` | List[*str*] | :heavy_check_mark: | list of schemas a view can belong to | | +| `ui_config` | Dict[str, *Any*] | :heavy_check_mark: | N/A | [object Object] | +| `updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewitemcreatedby.md b/entity/docs/models/shared/savedviewitemcreatedby.md index 971ca8720..a7b4ac1a1 100755 --- a/entity/docs/models/shared/savedviewitemcreatedby.md +++ b/entity/docs/models/shared/savedviewitemcreatedby.md @@ -9,9 +9,9 @@ savedViewItemCreatedBy: shared.SavedViewItemCreatedBy1 = /* values here */ ``` -### +### SavedViewItemCreatedBy2 ```python -savedViewItemCreatedBy: dict[str, Any] = /* values here */ +savedViewItemCreatedBy: shared.SavedViewItemCreatedBy2 = /* values here */ ``` diff --git a/entity/docs/models/shared/savedviewitemcreatedby2.md b/entity/docs/models/shared/savedviewitemcreatedby2.md new file mode 100755 index 000000000..6a9bd1495 --- /dev/null +++ b/entity/docs/models/shared/savedviewitemcreatedby2.md @@ -0,0 +1,11 @@ +# SavedViewItemCreatedBy2 + +A system-created view + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `source` | [Optional[SavedViewItemCreatedBy2Source]](../../models/shared/savedviewitemcreatedby2source.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/savedviewitemcreatedby2source.md b/entity/docs/models/shared/savedviewitemcreatedby2source.md new file mode 100755 index 000000000..38ffa0a8a --- /dev/null +++ b/entity/docs/models/shared/savedviewitemcreatedby2source.md @@ -0,0 +1,9 @@ +# SavedViewItemCreatedBy2Source + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `SYSTEM` | SYSTEM | +| `BLUEPRINT` | BLUEPRINT | \ No newline at end of file diff --git a/entity/docs/models/shared/searchmappings.md b/entity/docs/models/shared/searchmappings.md index 117bd6494..dec7a286a 100755 --- a/entity/docs/models/shared/searchmappings.md +++ b/entity/docs/models/shared/searchmappings.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `fields_` | dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fields_` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `index` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [Optional[SearchMappingsType]](../../models/shared/searchmappingstype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/selectattribute.md b/entity/docs/models/shared/selectattribute.md index 443b89dd0..0ae86fb92 100755 --- a/entity/docs/models/shared/selectattribute.md +++ b/entity/docs/models/shared/selectattribute.md @@ -7,7 +7,7 @@ Dropdown select | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `allow_any` | *Optional[bool]* | :heavy_minus_sign: | Allow arbitrary input values in addition to provided options | | | `constraints` | [Optional[SelectAttributeConstraints]](../../models/shared/selectattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | @@ -22,7 +22,7 @@ Dropdown select | `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `name` | *str* | :heavy_check_mark: | N/A | | -| `options` | list[[Union[SelectAttributeOptions1, str]](../../models/shared/selectattributeoptions.md)] | :heavy_minus_sign: | N/A | | +| `options` | List[[Union[SelectAttributeOptions1, str]](../../models/shared/selectattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/sequenceattribute.md b/entity/docs/models/shared/sequenceattribute.md index 9eb78732b..f15cb2e17 100755 --- a/entity/docs/models/shared/sequenceattribute.md +++ b/entity/docs/models/shared/sequenceattribute.md @@ -7,7 +7,7 @@ Sequence of unique identifiers | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[SequenceAttributeConstraints]](../../models/shared/sequenceattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/statusattribute.md b/entity/docs/models/shared/statusattribute.md index 0a33a27a1..ba98fc7e8 100755 --- a/entity/docs/models/shared/statusattribute.md +++ b/entity/docs/models/shared/statusattribute.md @@ -7,7 +7,7 @@ Status select | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[StatusAttributeConstraints]](../../models/shared/statusattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | @@ -21,7 +21,7 @@ Status select | `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `name` | *str* | :heavy_check_mark: | N/A | | -| `options` | list[[Union[str, StatusAttributeOptions2]](../../models/shared/statusattributeoptions.md)] | :heavy_minus_sign: | N/A | | +| `options` | List[[Union[str, StatusAttributeOptions2]](../../models/shared/statusattributeoptions.md)] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/tagsattribute.md b/entity/docs/models/shared/tagsattribute.md index c8332cf8a..44251df64 100755 --- a/entity/docs/models/shared/tagsattribute.md +++ b/entity/docs/models/shared/tagsattribute.md @@ -7,7 +7,7 @@ Tags | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[TagsAttributeConstraints]](../../models/shared/tagsattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | @@ -21,7 +21,7 @@ Tags | `label` | *str* | :heavy_check_mark: | N/A | | | `layout` | *Optional[str]* | :heavy_minus_sign: | N/A | full_width | | `name` | *str* | :heavy_check_mark: | N/A | | -| `options` | list[*str*] | :heavy_minus_sign: | N/A | | +| `options` | List[*str*] | :heavy_minus_sign: | N/A | | | `order` | *Optional[int]* | :heavy_minus_sign: | Attribute sort order (ascending) in group | 0 | | `placeholder` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `preview_value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | @@ -32,6 +32,6 @@ Tags | `setting_flag` | *Optional[str]* | :heavy_minus_sign: | This attribute should only be active when the setting is enabled | MY_SETTING | | `show_in_table` | *Optional[bool]* | :heavy_minus_sign: | Render as a column in table views. When defined, overrides `hidden` | | | `sortable` | *Optional[bool]* | :heavy_minus_sign: | Allow sorting by this attribute in table views if `show_in_table` is true | | -| `suggestions` | list[*str*] | :heavy_minus_sign: | N/A | | +| `suggestions` | List[*str*] | :heavy_minus_sign: | N/A | | | `type` | [Optional[TagsAttributeType]](../../models/shared/tagsattributetype.md) | :heavy_minus_sign: | N/A | | | `value_formatter` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/taxonomyclassification.md b/entity/docs/models/shared/taxonomyclassification.md index 3a7f5794f..d0c0f0654 100755 --- a/entity/docs/models/shared/taxonomyclassification.md +++ b/entity/docs/models/shared/taxonomyclassification.md @@ -8,5 +8,5 @@ | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | | `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `name` | *str* | :heavy_check_mark: | N/A | Wallbox PV | -| `parents` | list[*str*] | :heavy_minus_sign: | N/A | | +| `parents` | List[*str*] | :heavy_minus_sign: | N/A | | | `updated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/textattribute.md b/entity/docs/models/shared/textattribute.md index 32ce14b7e..39bd42d7e 100755 --- a/entity/docs/models/shared/textattribute.md +++ b/entity/docs/models/shared/textattribute.md @@ -7,7 +7,7 @@ Textarea or text input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[TextAttributeConstraints]](../../models/shared/textattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/models/shared/userrelationattribute.md b/entity/docs/models/shared/userrelationattribute.md index b21332cde..322f6c8c3 100755 --- a/entity/docs/models/shared/userrelationattribute.md +++ b/entity/docs/models/shared/userrelationattribute.md @@ -7,7 +7,7 @@ User Relationship | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `purpose` | list[*str*] | :heavy_minus_sign: | N/A | | +| `purpose` | List[*str*] | :heavy_minus_sign: | N/A | | | `constraints` | [Optional[UserRelationAttributeConstraints]](../../models/shared/userrelationattributeconstraints.md) | :heavy_minus_sign: | A set of constraints applicable to the attribute.
These constraints should and will be enforced by the attribute renderer.
| | | `default_value` | *Optional[Any]* | :heavy_minus_sign: | N/A | | | `deprecated` | *Optional[bool]* | :heavy_minus_sign: | N/A | | diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 55eb1be41..3c8bf6337 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -90,6 +90,7 @@ The items in `$relation` support two properties: ```python import epilot +import dateutil.parser from epilot.models import operations, shared s = epilot.Epilot( @@ -99,16 +100,60 @@ s = epilot.Epilot( ) req = operations.CreateEntityRequest( - request_body={ - "_created_at": 'Industrial', - "_updated_at": 'Implementation', - "_acl": 'Future', - "_id": 'Southeast', - "_org": 'Tandem', - "_owners": 'male', - "_schema": 'North', - "_tags": 'Beach', - }, + entity=shared.Entity( + additional_properties={ + "_owners": 'Industrial', + "_schema": 'Implementation', + "_tags": 'Future', + "_created_at": 'Southeast', + "_updated_at": 'Tandem', + "_acl": 'male', + "_id": 'North', + "_org": 'Beach', + }, + acl=shared.EntityACL( + additional_properties={ + "Fresh": 'lavender', + }, + delete=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + edit=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + view=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + ), + owners=[ + shared.EntityOwner( + org_id='123', + user_id='123', + ), + ], + schema='contact', + tags=[ + 'than', + ], + ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', slug='contact', ) @@ -316,6 +361,7 @@ The items in `$relation` support two properties: ```python import epilot +import dateutil.parser from epilot.models import operations, shared s = epilot.Epilot( @@ -325,18 +371,62 @@ s = epilot.Epilot( ) req = operations.PatchEntityRequest( - request_body={ - "_updated_at": 'fuchsia', - "_acl": 'Account', - "_id": 'engage', - "_org": 'Cis', - "_owners": 'solutions', - "_schema": 'founder', - "_tags": 'Southeast', - "_created_at": 'Cab', - }, + entity=shared.Entity( + additional_properties={ + "_tags": 'fuchsia', + "_created_at": 'Account', + "_updated_at": 'engage', + "_acl": 'Cis', + "_id": 'solutions', + "_org": 'founder', + "_owners": 'Southeast', + "_schema": 'Cab', + }, + acl=shared.EntityACL( + additional_properties={ + "Italy": 'potentially', + }, + delete=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + edit=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + view=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + ), + owners=[ + shared.EntityOwner( + org_id='123', + user_id='123', + ), + ], + schema='contact', + tags=[ + 'Multigender', + ], + ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - id='06e999b7-2319-4d9e-8290-d19da9e1f40d', + id='b72319d9-e429-40d1-9da9-e1f40d7c71a7', slug='contact', ) @@ -503,6 +593,7 @@ The items in `$relation` support two properties: ```python import epilot +import dateutil.parser from epilot.models import operations, shared s = epilot.Epilot( @@ -512,18 +603,62 @@ s = epilot.Epilot( ) req = operations.UpdateEntityRequest( - request_body={ - "_acl": 'Hartmann', - "_id": 'invoice', - "_org": 'fathom', - "_owners": 'Nepal', - "_schema": 'indexing', - "_tags": 'male', - "_created_at": 'Profound', - "_updated_at": 'policy', - }, + entity=shared.Entity( + additional_properties={ + "_id": 'Hartmann', + "_org": 'invoice', + "_owners": 'fathom', + "_schema": 'Nepal', + "_tags": 'indexing', + "_created_at": 'male', + "_updated_at": 'Profound', + "_acl": 'policy', + }, + acl=shared.EntityACL( + additional_properties={ + "Southwest": 'Avon', + }, + delete=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + edit=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + view=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + ), + owners=[ + shared.EntityOwner( + org_id='123', + user_id='123', + ), + ], + schema='contact', + tags=[ + 'Volvo', + ], + ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - id='1d12df74-462a-498e-a7ff-ce36a4e49616', + id='74462a98-e27f-4fce-b6a4-e496163b217a', slug='contact', ) @@ -563,6 +698,7 @@ If no `activity_id` query parameter is provided, implicitly creates Activity of ```python import epilot +import dateutil.parser from epilot.models import operations, shared s = epilot.Epilot( @@ -573,16 +709,60 @@ s = epilot.Epilot( req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( - entity={ - "_created_at": 'West', - "_updated_at": 'close', - "_acl": 'Infrastructure', - "_id": 'music', - "_org": 'astride', - "_owners": 'Designer', - "_schema": 'strategic', - "_tags": 'along', - }, + entity=shared.Entity( + additional_properties={ + "_schema": 'West', + "_tags": 'close', + "_created_at": 'Infrastructure', + "_updated_at": 'music', + "_acl": 'astride', + "_id": 'Designer', + "_org": 'strategic', + "_owners": 'along', + }, + acl=shared.EntityACL( + additional_properties={ + "Rap": 'Virtual', + }, + delete=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + edit=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + view=[ + 'o', + 'r', + 'g', + ':', + '4', + '5', + '6', + ], + ), + owners=[ + shared.EntityOwner( + org_id='123', + user_id='123', + ), + ], + schema='contact', + tags=[ + 'Home', + ], + ), unique_key=[ '_id', ], diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index 4cf5f4b17..0891129aa 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -36,12 +36,12 @@ req = operations.AddRelationsRequest( tags=[ 'Forward', ], - attribute='Swedish Hatchback Luxurious', - entity_id='9248b564-99df-4660-9593-cfe3d006d87e', + attribute='Pickup', + entity_id='1d83d924-8b56-4499-9f66-0d593cfe3d00', ), ], activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - id='69d98cd0-9bf6-4d30-b52c-36108777da47', + id='6d87e69d-98cd-409b-b6d3-0b52c3610877', slug='contact', ) @@ -82,9 +82,9 @@ s = epilot.Epilot( req = operations.DeleteRelationRequest( activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - attribute='whiteboard sandal', - entity_id='quasi South Southeast', - id='f5b77b85-5b9c-4585-b7ae-4d21f6044e25', + attribute='compressing', + entity_id='Representative', + id='cd911519-f5b7-47b8-95b9-c58577ae4d21', slug='contact', ) @@ -269,9 +269,9 @@ req = operations.UpdateRelationRequest( ], ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - attribute='imperturbable female during', - entity_id='HDD Gasoline', - id='3b01c385-4f8c-44b2-a614-3d8a0d332324', + attribute='male', + entity_id='Account', + id='ff6a74da-3b01-4c38-94f8-c4b226143d8a', slug='contact', ) diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index 147c7be3e..7ff011c65 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -237,8 +237,8 @@ req = operations.UpdateSavedViewRequest( 'contact', ], ui_config={ - "filters": 'red', - "table_layout": 'Car', + "table_layout": 'red', + "filters": 'Car', }, ), id='92cd4781-664d-4f55-b084-1d72e4e501ca', diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index 2d8c5f58b..466216ce2 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -268,99 +268,99 @@ req = operations.PutSchemaRequest( info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='Home', + label='channels', layout='full_width', - name='Account parse Hybrid', + name='exploit', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '1de0f32d-6571-4521-8cf5-04680eaf6fd6', + '6bf8fcc1-de0f-432d-a571-5210cf504680', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='warmly green Rolls', + label='till', layout='full_width', - name='payment archive', + name='grill', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '5b3e0e28-c6d1-4668-943e-4eb242b720a7', + 'fd6bef20-dd28-47b6-95b3-e0e28c6d1668', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='Martin Buckinghamshire second', + label='discrete', layout='full_width', - name='East', + name='Unbranded', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '66bc3807-5c84-437b-9710-c2601905e25f', + '4eb242b7-20a7-4fd0-81cb-030766bc3807', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='female payment Gloves', + label='radical', layout='full_width', - name='redundant grow', + name='compressing', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '647c7479-d9c5-460e-a796-9366d774fa49', + '37b1710c-2601-4905-a25f-bb37949e5c67', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='voluptatem withdrawal Jersey', + label='firmware', layout='full_width', - name='Latin Massachusetts', + name='IP', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '82a9ba9c-c095-4367-8af5-3c32a28a3faa', + '47c7479d-9c56-40ea-b969-366d774fa49a', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='parse Legacy', + label='voluptatem', layout='full_width', - name='killer', + name='withdrawal', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '3c780e75-fefd-44fb-b09f-43acc8e6b933', + '19da9b26-82a9-4ba9-8c09-53674af53c32', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='likely Synchronised', + label='Corporate', layout='full_width', - name='inundate invoice', + name='synthesize', order=0, setting_flag='MY_SETTING', ), @@ -368,31 +368,26 @@ req = operations.PutSchemaRequest( capabilities=[ shared.EntityCapability( purpose=[ - '76391618-2360-49a0-98c5-8211d87549e8', + '3faa88fa-b246-43c7-80e7-5fefd4fb709f', ], attributes=[ - shared.CurrencyAttribute( + shared.StatusAttribute( purpose=[ - 'e05451ea-976b-47aa-8556-cbb2f4955baf', - ], - constraints=shared.CurrencyAttributeConstraints(), - currency=[ - shared.CurrencyAttributeCurrency1( - code='Road', - description='Operative bi-directional extranet', - symbol='concerning', - ), + '3acc8e6b-9335-4e75-97f7-7f7639161823', ], + constraints=shared.StatusAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', - info_helpers=shared.CurrencyAttributeInfoHelpers( + info_helpers=shared.StatusAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='optimizing', + label='analyzer', layout='full_width', - name='sievert', + name='Classical', + options=[ + 'Lamborghini', + ], order=0, setting_flag='MY_SETTING', - type=shared.CurrencyAttributeType.CURRENCY, ), ], feature_flag='FF_MY_FEATURE_FLAG', @@ -400,14 +395,28 @@ req = operations.PutSchemaRequest( setting_flag='MY_SETTING', title='Messaging', ui_hooks=[ - { - "Berkshire": 'Hybrid', - }, + shared.EntityCapabilityUIHooks( + additional_properties={ + "newton": 'hacking', + }, + component='PricingItems', + hook='EntityDetailsV2:Tab', + icon='email', + import_='@epilot360/notes', + order=10, + render_condition='_is_composite_price = "false"', + required_permission=shared.EntityCapabilityUIHooksRequiredPermission( + action='note:view', + resource='123', + ), + route='notes', + title='Notes', + ), ], ), ], dialog_config={ - "harden": 'Practical', + "North": 'Kia', }, draft=False, enable_setting=[ @@ -427,7 +436,7 @@ req = operations.PutSchemaRequest( explicit_search_mappings={ "image": shared.SearchMappings( fields_={ - "Classical": 'Distributed', + "HDD": 'engage', }, ), }, @@ -435,39 +444,44 @@ req = operations.PutSchemaRequest( group_settings=[ shared.EntitySchemaGroupSettings( purpose=[ - '9a93bb27-212d-48fe-b517-f7f32d0d1a32', + 'e87e0545-1ea9-476b-baa4-556cbb2f4955', ], feature_flag='FF_MY_FEATURE_FLAG', id='', info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle(), - label='Koruna Zimbabwe', + label='Orchestrator', render_condition='_is_composite_price = "false"', setting_flag='MY_SETTING', ), shared.EntitySchemaGroupSettings( purpose=[ - '65b8f4f0-c08e-4211-8d68-3456c3d852ff', + 'f0c06824-2f55-46b2-8c16-cff63699539a', ], feature_flag='FF_MY_FEATURE_FLAG', id='', info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle(), - label='mint 4th', + label='Folk', render_condition='_is_composite_price = "false"', setting_flag='MY_SETTING', ), ], icon='person', - layout_settings={ - "surmise": 'Direct', - }, + layout_settings=shared.EntitySchemaLayoutSettings( + additional_properties={ + "male": 'Health', + }, + ), name='Contact', plural='Contacts', published=False, slug='contact', title_template='{{first_name}} {{last_name}}', ui_config=shared.EntitySchemaUIConfig( - shared.RedirectEntityView( - route='/app/pricing-hub/product/:entityId', + shared.EntityDefaultCreate( + search_params={ + "Avon": 'marvelous', + }, + table_menu_options=shared.EntityDefaultCreateTableMenuOptions(), ), shared.EntityViewDisabled(), list_item=shared.EntitySchemaUIConfigListItem( @@ -481,8 +495,27 @@ req = operations.PutSchemaRequest( shared.RedirectEntityView( route='/app/pricing-hub/product/:entityId', ), - shared.RedirectEntityView( - route='/app/pricing-hub/product/:entityId', + shared.EntityDefaultTable( + dropdown_items=[ + shared.EntityDefaultTableDropdownItems1( + entity='contact', + feature_flag='FF_MY_FEATURE_FLAG', + ), + ], + navbar_actions=[ + shared.EntityDefaultTableNavbarActions( + options=[ + shared.EntityDefaultTableNavbarActionsOptions( + label='invoice', + params=shared.EntityDefaultTableNavbarActionsOptionsParams(), + ), + ], + type='XML', + ), + ], + row_actions=[ + 'Mouse', + ], ), ), ), diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index 24985e650..59556e2cf 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -104,7 +104,7 @@ req = operations.TaxonomiesClassificationsSearchRequest( '140d9b86-5e3a-4ede-b609-1ca17c7aaeae', ], ), - taxonomy_slug='Oklahoma azure illum', + taxonomy_slug='Bicycle', ) res = s.taxonomy.taxonomies_classifications_search(req) @@ -143,7 +143,7 @@ s = epilot.Epilot( ) req = operations.TaxonomyAutocompleteRequest( - taxonomy_slug='Polarised optio Hybrid', + taxonomy_slug='Planner', ) res = s.taxonomy.taxonomy_autocomplete(req) @@ -204,7 +204,7 @@ req = operations.UpdateClassificationsForTaxonomyRequest( ), ], ), - taxonomy_slug='transmitting female Polarised', + taxonomy_slug='or', ) res = s.taxonomy.update_classifications_for_taxonomy(req) diff --git a/entity/files.gen b/entity/files.gen index 1e15b56f1..541f34999 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -57,12 +57,18 @@ src/epilot/models/operations/updateclassificationsfortaxonomy.py src/epilot/models/operations/__init__.py src/epilot/models/shared/activityitem.py src/epilot/models/shared/entityoperation.py +src/epilot/models/shared/entityowner.py +src/epilot/models/shared/entityacl.py +src/epilot/models/shared/entity.py +src/epilot/models/shared/activitycallercontext.py src/epilot/models/shared/activity.py +src/epilot/models/shared/entityitem.py src/epilot/models/shared/entitysearchresults.py src/epilot/models/shared/entitysearchparams.py src/epilot/models/shared/entityimportparams.py src/epilot/models/shared/relationitem.py src/epilot/models/shared/getrelatedentitiescount.py +src/epilot/models/shared/relationentity.py src/epilot/models/shared/getrelationsrespwithpagination.py src/epilot/models/shared/savedviewitem.py src/epilot/models/shared/savedview.py @@ -205,8 +211,16 @@ docs/models/shared/activityitem.md docs/models/shared/entityoperationdiff.md docs/models/shared/entityoperationoperation.md docs/models/shared/entityoperationparams.md +docs/models/shared/entityoperationpayload.md docs/models/shared/entityoperation.md +docs/models/shared/entityowner.md +docs/models/shared/entityacl.md +docs/models/shared/entity.md +docs/models/shared/activitycallercontextepilotauthtoken.md +docs/models/shared/activitycallercontextepilotauth.md +docs/models/shared/activitycallercontext.md docs/models/shared/activity.md +docs/models/shared/entityitem.md docs/models/shared/entitysearchresultsaggregations.md docs/models/shared/entitysearchresults.md docs/models/shared/entitysearchparamsaggs.md @@ -216,15 +230,21 @@ docs/models/shared/entityimportparams.md docs/models/shared/relationitem.md docs/models/shared/getrelatedentitiescount.md docs/models/shared/getrelationsresp.md +docs/models/shared/relationentity.md docs/models/shared/getrelationsrespwithpagination.md +docs/models/shared/savedviewitemcreatedby2source.md +docs/models/shared/savedviewitemcreatedby2.md docs/models/shared/savedviewitemcreatedby1.md docs/models/shared/savedviewitemcreatedby.md docs/models/shared/savedviewitem.md +docs/models/shared/savedviewcreatedby2source.md +docs/models/shared/savedviewcreatedby2.md docs/models/shared/savedviewcreatedby1.md docs/models/shared/savedviewcreatedby.md docs/models/shared/savedview.md docs/models/shared/entityschemaitemgroupsettingsinfotooltiptitle.md docs/models/shared/entityschemaitemgroupsettings.md +docs/models/shared/entityschemaitemlayoutsettings.md docs/models/shared/entityschemaitemsource.md docs/models/shared/entityschemaitemuiconfigcreateview.md docs/models/shared/entityschemaitemuiconfigeditview.md @@ -258,6 +278,8 @@ docs/models/shared/entitydefaultcreateviewtype.md docs/models/shared/entitydefaultcreate.md docs/models/shared/searchmappingstype.md docs/models/shared/searchmappings.md +docs/models/shared/entitycapabilityuihooksrequiredpermission.md +docs/models/shared/entitycapabilityuihooks.md docs/models/shared/entitycapability.md docs/models/shared/attribute.md docs/models/shared/textattributeconstraints.md @@ -303,6 +325,7 @@ docs/models/shared/sequenceattributeinfohelpers.md docs/models/shared/sequenceattributetype.md docs/models/shared/sequenceattribute.md docs/models/shared/relationattributeactionsactiontype.md +docs/models/shared/relationattributeactionsnewentityitem.md docs/models/shared/relationattributeactions.md docs/models/shared/relationattributeconstraints.md docs/models/shared/relationattributedrawersize.md @@ -393,6 +416,7 @@ docs/models/shared/partnerorganisationattribute.md docs/models/shared/taxonomyclassification.md docs/models/shared/entityschemagroupsettingsinfotooltiptitle.md docs/models/shared/entityschemagroupsettings.md +docs/models/shared/entityschemalayoutsettings.md docs/models/shared/entityschemauiconfigcreateview.md docs/models/shared/entityschemauiconfigeditview.md docs/models/shared/entityschemauiconfiglistitemsummaryattributes.md diff --git a/entity/gen.yaml b/entity/gen.yaml index 61fa9cb55..46bc0f3fa 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -2,8 +2,8 @@ configVersion: 1.0.0 management: docChecksum: f8fda659e78397d7d3ffdf366a682493 docVersion: 1.0.0 - speakeasyVersion: 1.99.1 - generationVersion: 2.154.1 + speakeasyVersion: 1.101.0 + generationVersion: 2.161.0 generation: sdkClassName: epilot sdkFlattening: true @@ -11,11 +11,12 @@ generation: telemetryEnabled: false features: python: - core: 2.88.6 + additionalProperties: 0.1.0 + core: 3.0.2 globalSecurity: 2.82.0 globalServerURLs: 2.82.0 python: - version: 1.27.1 + version: 2.0.0 author: epilot description: Python Client SDK for Epilot flattenGlobalSecurity: false diff --git a/entity/pylintrc b/entity/pylintrc index ca6869cfb..22b805943 100755 --- a/entity/pylintrc +++ b/entity/pylintrc @@ -88,7 +88,7 @@ persistent=yes # Minimum Python version to use for version dependent checks. Will default to # the version used to run pylint. -py-version=3.9 +py-version=3.8 # Discover python modules and packages in the file system subtree. recursive=no diff --git a/entity/setup.py b/entity/setup.py index fed3c1fde..1db34ea21 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,33 +10,31 @@ setuptools.setup( name="epilot-entity", - version="1.27.1", + version="2.0.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, long_description_content_type="text/markdown", packages=setuptools.find_packages(where="src"), install_requires=[ - "certifi>=2022.12.7", - "charset-normalizer>=2.1.1", + "certifi>=2023.7.22", + "charset-normalizer>=3.2.0", "dataclasses-json>=0.6.1", - "idna>=3.3", + "idna>=3.4", "jsonpath-python>=1.0.6 ", - "marshmallow>=3.17.1", - "marshmallow-enum>=1.5.1", - "mypy-extensions>=0.4.3", - "packaging>=21.3", - "pyparsing>=3.0.9", + "marshmallow>=3.19.0", + "mypy-extensions>=1.0.0", + "packaging>=23.1", "python-dateutil>=2.8.2", - "requests>=2.28.1", + "requests>=2.31.0", "six>=1.16.0", - "typing-inspect>=0.8.0", - "typing_extensions>=4.3.0", - "urllib3>=1.26.12", + "typing-inspect>=0.9.0", + "typing_extensions>=4.7.1", + "urllib3>=2.0.4", ], extras_require={ "dev":["pylint==2.16.2"] }, package_dir={'': 'src'}, - python_requires='>=3.9' + python_requires='>=3.8' ) diff --git a/entity/src/epilot/entities.py b/entity/src/epilot/entities.py index 169466cb2..61e9acbef 100755 --- a/entity/src/epilot/entities.py +++ b/entity/src/epilot/entities.py @@ -4,7 +4,7 @@ from enum import Enum from epilot import utils from epilot.models import errors, operations, shared -from typing import Any, Optional +from typing import Optional class SearchEntitiesAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" @@ -79,7 +79,7 @@ def create_entity(self, request: operations.CreateEntityRequest) -> operations.C url = utils.generate_url(operations.CreateEntityRequest, base_url, '/v1/entity/{slug}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') + req_content_type, data, form = utils.serialize_request_body(request, "entity", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateEntityRequest, request) @@ -95,7 +95,7 @@ def create_entity(self, request: operations.CreateEntityRequest) -> operations.C if http_res.status_code == 201: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[dict[str, Any]]) + out = utils.unmarshal_json(http_res.text, Optional[shared.EntityItem]) res.entity_item = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) @@ -255,7 +255,7 @@ def patch_entity(self, request: operations.PatchEntityRequest) -> operations.Pat url = utils.generate_url(operations.PatchEntityRequest, base_url, '/v1/entity/{slug}/{id}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, False, 'json') + req_content_type, data, form = utils.serialize_request_body(request, "entity", False, False, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type if data is None and form is None: @@ -273,7 +273,7 @@ def patch_entity(self, request: operations.PatchEntityRequest) -> operations.Pat if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[dict[str, Any]]) + out = utils.unmarshal_json(http_res.text, Optional[shared.EntityItem]) res.entity_item = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) @@ -415,7 +415,7 @@ def update_entity(self, request: operations.UpdateEntityRequest) -> operations.U url = utils.generate_url(operations.UpdateEntityRequest, base_url, '/v1/entity/{slug}/{id}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') + req_content_type, data, form = utils.serialize_request_body(request, "entity", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.UpdateEntityRequest, request) @@ -431,7 +431,7 @@ def update_entity(self, request: operations.UpdateEntityRequest) -> operations.U if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[dict[str, Any]]) + out = utils.unmarshal_json(http_res.text, Optional[shared.EntityItem]) res.entity_item = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) @@ -471,7 +471,7 @@ def upsert_entity(self, request: operations.UpsertEntityRequest) -> operations.U if http_res.status_code in [200, 201]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[dict[str, Any]]) + out = utils.unmarshal_json(http_res.text, Optional[shared.EntityItem]) res.entity_item = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) diff --git a/entity/src/epilot/models/operations/addrelations.py b/entity/src/epilot/models/operations/addrelations.py index bd7952772..ed0e14b80 100755 --- a/entity/src/epilot/models/operations/addrelations.py +++ b/entity/src/epilot/models/operations/addrelations.py @@ -4,8 +4,7 @@ import dataclasses import requests as requests_http from ..shared import relationitem as shared_relationitem -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -18,12 +17,11 @@ class AddRelationsRequest: r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" - request_body: Optional[list[shared_relationitem.RelationItem]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + request_body: Optional[List[shared_relationitem.RelationItem]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class AddRelationsResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/attachactivity.py b/entity/src/epilot/models/operations/attachactivity.py index 05f429870..714a96fb3 100755 --- a/entity/src/epilot/models/operations/attachactivity.py +++ b/entity/src/epilot/models/operations/attachactivity.py @@ -4,21 +4,19 @@ import dataclasses import requests as requests_http from ..shared import activityitem as shared_activityitem -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass class AttachActivityRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Activity Id""" - entities: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'entities', 'style': 'form', 'explode': False }}) + entities: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'entities', 'style': 'form', 'explode': False }}) r"""Comma-separated list of entities which the activity primarily concerns""" - @dataclasses.dataclass class AttachActivityResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/autocomplete.py b/entity/src/epilot/models/operations/autocomplete.py index b6bbdd495..63fe259b0 100755 --- a/entity/src/epilot/models/operations/autocomplete.py +++ b/entity/src/epilot/models/operations/autocomplete.py @@ -5,8 +5,7 @@ import requests as requests_http from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional, Union - +from typing import Any, Dict, List, Optional, Union @dataclasses.dataclass @@ -23,24 +22,21 @@ class AutocompleteRequest: - @dataclasses.dataclass class Autocomplete200ApplicationJSONResults: pass @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Autocomplete200ApplicationJSON: r"""Success""" hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) - results: Optional[list[Union[str, bool, dict[str, Any]]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[Union[str, bool, Dict[str, Any]]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class AutocompleteResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/createactivity.py b/entity/src/epilot/models/operations/createactivity.py index ebf0ec878..742f54d8a 100755 --- a/entity/src/epilot/models/operations/createactivity.py +++ b/entity/src/epilot/models/operations/createactivity.py @@ -5,20 +5,18 @@ import requests as requests_http from ..shared import activity as shared_activity from ..shared import activityitem as shared_activityitem -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass class CreateActivityRequest: activity: Optional[shared_activity.Activity] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - entities: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'entities', 'style': 'form', 'explode': False }}) + entities: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'entities', 'style': 'form', 'explode': False }}) r"""Comma-separated list of entities which the activity primarily concerns""" - @dataclasses.dataclass class CreateActivityResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/createentity.py b/entity/src/epilot/models/operations/createentity.py index 519a0283e..a33f5fd1d 100755 --- a/entity/src/epilot/models/operations/createentity.py +++ b/entity/src/epilot/models/operations/createentity.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http -from typing import Any, Optional - +from ..shared import entity as shared_entity +from ..shared import entityitem as shared_entityitem +from typing import Optional @dataclasses.dataclass @@ -15,19 +16,18 @@ class CreateEntityRequest: r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" - request_body: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + entity: Optional[shared_entity.Entity] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class CreateEntityResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) + entity_item: Optional[shared_entityitem.EntityItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/createsavedview.py b/entity/src/epilot/models/operations/createsavedview.py index 5fb15de53..8e9a4ee9a 100755 --- a/entity/src/epilot/models/operations/createsavedview.py +++ b/entity/src/epilot/models/operations/createsavedview.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class CreateSavedViewResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/deleteentity.py b/entity/src/epilot/models/operations/deleteentity.py index 813545047..21a6ff067 100755 --- a/entity/src/epilot/models/operations/deleteentity.py +++ b/entity/src/epilot/models/operations/deleteentity.py @@ -6,7 +6,6 @@ from typing import Optional - @dataclasses.dataclass class DeleteEntityRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) @@ -18,7 +17,6 @@ class DeleteEntityRequest: - @dataclasses.dataclass class DeleteEntityResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/deleterelation.py b/entity/src/epilot/models/operations/deleterelation.py index 085b7707b..af8208b03 100755 --- a/entity/src/epilot/models/operations/deleterelation.py +++ b/entity/src/epilot/models/operations/deleterelation.py @@ -6,7 +6,6 @@ from typing import Optional - @dataclasses.dataclass class DeleteRelationRequest: attribute: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attribute', 'style': 'simple', 'explode': False }}) @@ -25,7 +24,6 @@ class DeleteRelationRequest: - @dataclasses.dataclass class DeleteRelationResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/deletesavedview.py b/entity/src/epilot/models/operations/deletesavedview.py index 55ab025c5..5f6a827c7 100755 --- a/entity/src/epilot/models/operations/deletesavedview.py +++ b/entity/src/epilot/models/operations/deletesavedview.py @@ -6,7 +6,6 @@ from typing import Optional - @dataclasses.dataclass class DeleteSavedViewRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) @@ -15,7 +14,6 @@ class DeleteSavedViewRequest: - @dataclasses.dataclass class DeleteSavedViewResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/deleteschema.py b/entity/src/epilot/models/operations/deleteschema.py index e790b1a78..f15199e1b 100755 --- a/entity/src/epilot/models/operations/deleteschema.py +++ b/entity/src/epilot/models/operations/deleteschema.py @@ -6,7 +6,6 @@ from typing import Optional - @dataclasses.dataclass class DeleteSchemaRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @@ -14,7 +13,6 @@ class DeleteSchemaRequest: - @dataclasses.dataclass class DeleteSchemaResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/exportentities.py b/entity/src/epilot/models/operations/exportentities.py index de1693170..18a000a1b 100755 --- a/entity/src/epilot/models/operations/exportentities.py +++ b/entity/src/epilot/models/operations/exportentities.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class ExportEntitiesRequest: entity_search_params: Optional[shared_entitysearchparams.EntitySearchParams] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @@ -21,7 +20,6 @@ class ExportEntitiesRequest: - @dataclasses.dataclass class ExportEntitiesResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/getactivity.py b/entity/src/epilot/models/operations/getactivity.py index 650c72b7e..18803aa3d 100755 --- a/entity/src/epilot/models/operations/getactivity.py +++ b/entity/src/epilot/models/operations/getactivity.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class GetActivityRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) @@ -20,7 +19,6 @@ class GetActivityRequest: - @dataclasses.dataclass class GetActivityResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/getentity.py b/entity/src/epilot/models/operations/getentity.py index 4c05c6c24..08d350cfc 100755 --- a/entity/src/epilot/models/operations/getentity.py +++ b/entity/src/epilot/models/operations/getentity.py @@ -3,10 +3,10 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import entityitem as shared_entityitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional - +from typing import List, Optional @dataclasses.dataclass @@ -22,17 +22,15 @@ class GetEntityRequest: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class GetEntity200ApplicationJSON: r"""Success""" - entity: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity'), 'exclude': lambda f: f is None }}) - relations: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) + entity: Optional[shared_entityitem.EntityItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity'), 'exclude': lambda f: f is None }}) + relations: Optional[List[shared_entityitem.EntityItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class GetEntityResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/getentityactivityfeed.py b/entity/src/epilot/models/operations/getentityactivityfeed.py index 11e3133d2..a3e082ece 100755 --- a/entity/src/epilot/models/operations/getentityactivityfeed.py +++ b/entity/src/epilot/models/operations/getentityactivityfeed.py @@ -7,8 +7,7 @@ from dataclasses_json import Undefined, dataclass_json from datetime import datetime from epilot import utils -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -34,17 +33,15 @@ class GetEntityActivityFeedRequest: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class GetEntityActivityFeed200ApplicationJSON: r"""Success""" - results: Optional[list[shared_activityitem.ActivityItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_activityitem.ActivityItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) total: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('total'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class GetEntityActivityFeedResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/getrelatedentitiescount.py b/entity/src/epilot/models/operations/getrelatedentitiescount.py index 7a508f30b..64d63b2f6 100755 --- a/entity/src/epilot/models/operations/getrelatedentitiescount.py +++ b/entity/src/epilot/models/operations/getrelatedentitiescount.py @@ -4,8 +4,7 @@ import dataclasses import requests as requests_http from ..shared import getrelatedentitiescount as shared_getrelatedentitiescount -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -14,13 +13,12 @@ class GetRelatedEntitiesCountRequest: r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Schema""" - exclude_schemas: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'exclude_schemas', 'style': 'form', 'explode': False }}) + exclude_schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'exclude_schemas', 'style': 'form', 'explode': False }}) r"""To be excluded from the count by given schemas""" - @dataclasses.dataclass class GetRelatedEntitiesCountResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py index 7dd835213..cca678e43 100755 --- a/entity/src/epilot/models/operations/getrelations.py +++ b/entity/src/epilot/models/operations/getrelations.py @@ -3,10 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import getrelationsresp as shared_getrelationsresp +from ..shared import relationentity as shared_relationentity from ..shared import relationitem as shared_relationitem -from typing import Optional, Union - +from typing import List, Optional, Union @dataclasses.dataclass @@ -23,14 +22,13 @@ class GetRelationsRequest: - @dataclasses.dataclass class GetRelationsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - get_relations_resp: Optional[list[Union[shared_relationitem.RelationItem, dict[str, Any]]]] = dataclasses.field(default=None) + get_relations_resp: Optional[List[Union[shared_relationitem.RelationItem, shared_relationentity.RelationEntity]]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/getrelationsv2.py b/entity/src/epilot/models/operations/getrelationsv2.py index 22f512084..1c4e4f458 100755 --- a/entity/src/epilot/models/operations/getrelationsv2.py +++ b/entity/src/epilot/models/operations/getrelationsv2.py @@ -4,8 +4,7 @@ import dataclasses import requests as requests_http from ..shared import getrelationsrespwithpagination as shared_getrelationsrespwithpagination -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -14,7 +13,7 @@ class GetRelationsV2Request: r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Type""" - fields_: Optional[list[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': True }}) + fields_: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': True }}) r"""List of entity fields to include in results""" from_: Optional[int] = dataclasses.field(default=0, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) r"""Starting page number""" @@ -30,7 +29,6 @@ class GetRelationsV2Request: - @dataclasses.dataclass class GetRelationsV2Response: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/getsavedview.py b/entity/src/epilot/models/operations/getsavedview.py index 9b44344fd..c1e54c497 100755 --- a/entity/src/epilot/models/operations/getsavedview.py +++ b/entity/src/epilot/models/operations/getsavedview.py @@ -9,7 +9,6 @@ from typing import Optional - @dataclasses.dataclass class GetSavedViewRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) @@ -19,7 +18,6 @@ class GetSavedViewRequest: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class GetSavedView200ApplicationJSON: r"""Success""" @@ -28,7 +26,6 @@ class GetSavedView200ApplicationJSON: - @dataclasses.dataclass class GetSavedViewResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/getschema.py b/entity/src/epilot/models/operations/getschema.py index 3fc060d72..3e96e1e99 100755 --- a/entity/src/epilot/models/operations/getschema.py +++ b/entity/src/epilot/models/operations/getschema.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class GetSchemaRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @@ -16,7 +15,6 @@ class GetSchemaRequest: - @dataclasses.dataclass class GetSchemaResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/getschemaversions.py b/entity/src/epilot/models/operations/getschemaversions.py index b407a3fb4..19d10fa68 100755 --- a/entity/src/epilot/models/operations/getschemaversions.py +++ b/entity/src/epilot/models/operations/getschemaversions.py @@ -6,8 +6,7 @@ from ..shared import entityschemaitem as shared_entityschemaitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -22,17 +21,15 @@ class GetSchemaVersionsRequest: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class GetSchemaVersions200ApplicationJSON: r"""Success""" - drafts: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('drafts'), 'exclude': lambda f: f is None }}) - versions: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('versions'), 'exclude': lambda f: f is None }}) + drafts: Optional[List[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('drafts'), 'exclude': lambda f: f is None }}) + versions: Optional[List[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('versions'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class GetSchemaVersionsResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/gettaxonomy.py b/entity/src/epilot/models/operations/gettaxonomy.py index e0d171fd7..49a3d4451 100755 --- a/entity/src/epilot/models/operations/gettaxonomy.py +++ b/entity/src/epilot/models/operations/gettaxonomy.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class GetTaxonomyRequest: taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) @@ -16,7 +15,6 @@ class GetTaxonomyRequest: - @dataclasses.dataclass class GetTaxonomyResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/importentities.py b/entity/src/epilot/models/operations/importentities.py index adedfb808..5c7ba25aa 100755 --- a/entity/src/epilot/models/operations/importentities.py +++ b/entity/src/epilot/models/operations/importentities.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class ImportEntitiesRequest: entity_import_params: Optional[shared_entityimportparams.EntityImportParams] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @@ -17,7 +16,6 @@ class ImportEntitiesRequest: - @dataclasses.dataclass class ImportEntitiesResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/listfavoriteviewsforuser.py b/entity/src/epilot/models/operations/listfavoriteviewsforuser.py index eabd197c5..a24a8e82b 100755 --- a/entity/src/epilot/models/operations/listfavoriteviewsforuser.py +++ b/entity/src/epilot/models/operations/listfavoriteviewsforuser.py @@ -6,20 +6,18 @@ from ..shared import savedviewitem as shared_savedviewitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ListFavoriteViewsForUser200ApplicationJSON: r"""Success""" - results: Optional[list[shared_savedviewitem.SavedViewItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_savedviewitem.SavedViewItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class ListFavoriteViewsForUserResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/listsavedviews.py b/entity/src/epilot/models/operations/listsavedviews.py index 070395f45..6d84311d7 100755 --- a/entity/src/epilot/models/operations/listsavedviews.py +++ b/entity/src/epilot/models/operations/listsavedviews.py @@ -6,20 +6,18 @@ from ..shared import savedviewitem as shared_savedviewitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ListSavedViews200ApplicationJSON: r"""Success""" - results: Optional[list[shared_savedviewitem.SavedViewItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_savedviewitem.SavedViewItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class ListSavedViewsResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/listschemablueprints.py b/entity/src/epilot/models/operations/listschemablueprints.py index 7d0f83b00..9751d523e 100755 --- a/entity/src/epilot/models/operations/listschemablueprints.py +++ b/entity/src/epilot/models/operations/listschemablueprints.py @@ -6,20 +6,18 @@ from ..shared import entityschemaitem as shared_entityschemaitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ListSchemaBlueprints200ApplicationJSON: r"""Success""" - results: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class ListSchemaBlueprintsResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/listschemas.py b/entity/src/epilot/models/operations/listschemas.py index adbc1c515..ff903bc7e 100755 --- a/entity/src/epilot/models/operations/listschemas.py +++ b/entity/src/epilot/models/operations/listschemas.py @@ -6,8 +6,7 @@ from ..shared import entityschemaitem as shared_entityschemaitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -19,16 +18,14 @@ class ListSchemasRequest: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ListSchemas200ApplicationJSON: r"""Success""" - results: Optional[list[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_entityschemaitem.EntitySchemaItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class ListSchemasResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/listtaxonomies.py b/entity/src/epilot/models/operations/listtaxonomies.py index 58085ef51..2cc99a3df 100755 --- a/entity/src/epilot/models/operations/listtaxonomies.py +++ b/entity/src/epilot/models/operations/listtaxonomies.py @@ -6,20 +6,18 @@ from ..shared import taxonomy as shared_taxonomy from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ListTaxonomies200ApplicationJSON: r"""Returns list of taxonomies in an organisation""" - results: Optional[list[shared_taxonomy.Taxonomy]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_taxonomy.Taxonomy]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class ListTaxonomiesResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py index 3739a4d8e..a04c3a7f2 100755 --- a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py +++ b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py @@ -6,8 +6,7 @@ from ..shared import taxonomyclassification as shared_taxonomyclassification from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -21,16 +20,14 @@ class ListTaxonomyClassificationsForSchemaRequest: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ListTaxonomyClassificationsForSchema200ApplicationJSON: r"""List of taxonomy classifications""" - results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class ListTaxonomyClassificationsForSchemaResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/patchentity.py b/entity/src/epilot/models/operations/patchentity.py index 7031fb9d6..2c155da2a 100755 --- a/entity/src/epilot/models/operations/patchentity.py +++ b/entity/src/epilot/models/operations/patchentity.py @@ -3,15 +3,16 @@ from __future__ import annotations import dataclasses import requests as requests_http -from typing import Any, Optional - +from ..shared import entity as shared_entity +from ..shared import entityitem as shared_entityitem +from typing import Optional @dataclasses.dataclass class PatchEntityRequest: + entity: shared_entity.Entity = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Entity Id""" - request_body: dict[str, Any] = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Schema""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) @@ -24,14 +25,13 @@ class PatchEntityRequest: - @dataclasses.dataclass class PatchEntityResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) + entity_item: Optional[shared_entityitem.EntityItem] = dataclasses.field(default=None) r"""Entity was updated""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/putschema.py b/entity/src/epilot/models/operations/putschema.py index 7f52ff823..0dc010f98 100755 --- a/entity/src/epilot/models/operations/putschema.py +++ b/entity/src/epilot/models/operations/putschema.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class PutSchemaRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @@ -18,7 +17,6 @@ class PutSchemaRequest: - @dataclasses.dataclass class PutSchemaResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/searchentities.py b/entity/src/epilot/models/operations/searchentities.py index 3e192bb59..5ae7b7c19 100755 --- a/entity/src/epilot/models/operations/searchentities.py +++ b/entity/src/epilot/models/operations/searchentities.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class SearchEntitiesResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py b/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py index eee961df0..88efa8d53 100755 --- a/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py +++ b/entity/src/epilot/models/operations/taxonomiesclassificationssearch.py @@ -6,19 +6,17 @@ from ..shared import taxonomyclassification as shared_taxonomyclassification from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxonomiesClassificationsSearchRequestBody: - classification_ids: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classificationIds'), 'exclude': lambda f: f is None }}) + classification_ids: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classificationIds'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class TaxonomiesClassificationsSearchRequest: taxonomy_slug: str = dataclasses.field(metadata={'query_param': { 'field_name': 'taxonomySlug', 'style': 'form', 'explode': True }}) @@ -29,16 +27,14 @@ class TaxonomiesClassificationsSearchRequest: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxonomiesClassificationsSearch200ApplicationJSON: r"""Returns list of taxonomy classifications""" - results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class TaxonomiesClassificationsSearchResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/taxonomyautocomplete.py b/entity/src/epilot/models/operations/taxonomyautocomplete.py index 541316030..1fd024ba8 100755 --- a/entity/src/epilot/models/operations/taxonomyautocomplete.py +++ b/entity/src/epilot/models/operations/taxonomyautocomplete.py @@ -6,8 +6,7 @@ from ..shared import taxonomyclassification as shared_taxonomyclassification from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -23,16 +22,14 @@ class TaxonomyAutocompleteRequest: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxonomyAutocomplete200ApplicationJSON: r"""Taxonomy classifications""" - results: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class TaxonomyAutocompleteResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py b/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py index a3c03a31e..498159ffe 100755 --- a/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py +++ b/entity/src/epilot/models/operations/updateclassificationsfortaxonomy.py @@ -7,8 +7,7 @@ from ..shared import taxonomyclassification as shared_taxonomyclassification from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -20,25 +19,22 @@ class UpdateClassificationsForTaxonomyRequest: - @dataclasses.dataclass class UpdateClassificationsForTaxonomy200ApplicationJSONDeleted: pass @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UpdateClassificationsForTaxonomy200ApplicationJSON: r"""Taxonomies classifications""" - created: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created'), 'exclude': lambda f: f is None }}) + created: Optional[List[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created'), 'exclude': lambda f: f is None }}) deleted: Optional[UpdateClassificationsForTaxonomy200ApplicationJSONDeleted] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deleted'), 'exclude': lambda f: f is None }}) - updated: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated'), 'exclude': lambda f: f is None }}) + updated: Optional[List[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class UpdateClassificationsForTaxonomyResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/updateentity.py b/entity/src/epilot/models/operations/updateentity.py index 1f63f1cf0..d94c60888 100755 --- a/entity/src/epilot/models/operations/updateentity.py +++ b/entity/src/epilot/models/operations/updateentity.py @@ -3,8 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http -from typing import Any, Optional - +from ..shared import entity as shared_entity +from ..shared import entityitem as shared_entityitem +from typing import Optional @dataclasses.dataclass @@ -17,19 +18,18 @@ class UpdateEntityRequest: r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" - request_body: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + entity: Optional[shared_entity.Entity] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class UpdateEntityResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) + entity_item: Optional[shared_entityitem.EntityItem] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/operations/updaterelation.py b/entity/src/epilot/models/operations/updaterelation.py index 4907290c7..a8837bff6 100755 --- a/entity/src/epilot/models/operations/updaterelation.py +++ b/entity/src/epilot/models/operations/updaterelation.py @@ -6,19 +6,17 @@ from ..shared import relationitem as shared_relationitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UpdateRelationRequestBody: - tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) + tags: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) - @dataclasses.dataclass class UpdateRelationRequest: attribute: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attribute', 'style': 'simple', 'explode': False }}) @@ -38,7 +36,6 @@ class UpdateRelationRequest: - @dataclasses.dataclass class UpdateRelationResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/updatesavedview.py b/entity/src/epilot/models/operations/updatesavedview.py index 7133ccbd0..cf067bb92 100755 --- a/entity/src/epilot/models/operations/updatesavedview.py +++ b/entity/src/epilot/models/operations/updatesavedview.py @@ -8,7 +8,6 @@ from typing import Optional - @dataclasses.dataclass class UpdateSavedViewRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) @@ -18,7 +17,6 @@ class UpdateSavedViewRequest: - @dataclasses.dataclass class UpdateSavedViewResponse: content_type: str = dataclasses.field() diff --git a/entity/src/epilot/models/operations/upsertentity.py b/entity/src/epilot/models/operations/upsertentity.py index 5c999f6e6..c57081f3b 100755 --- a/entity/src/epilot/models/operations/upsertentity.py +++ b/entity/src/epilot/models/operations/upsertentity.py @@ -3,22 +3,22 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import entity as shared_entity +from ..shared import entityitem as shared_entityitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UpsertEntityRequestBody: - entity: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity') }}) - unique_key: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unique_key') }}) + entity: shared_entity.Entity = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity') }}) + unique_key: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unique_key') }}) - @dataclasses.dataclass class UpsertEntityRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) @@ -34,14 +34,13 @@ class UpsertEntityRequest: - @dataclasses.dataclass class UpsertEntityResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None) + entity_item: Optional[shared_entityitem.EntityItem] = dataclasses.field(default=None) r"""Entity was updated""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index 1df71ee08..040279ace 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" from .activity import * +from .activitycallercontext import * from .activityitem import * from .addressrelationattribute import * from .automationattribute import * @@ -11,12 +12,16 @@ from .countryattribute import * from .currencyattribute import * from .dateattribute import * +from .entity import * +from .entityacl import * from .entitycapability import * from .entitydefaultcreate import * from .entitydefaultedit import * from .entitydefaulttable import * from .entityimportparams import * +from .entityitem import * from .entityoperation import * +from .entityowner import * from .entityschema import * from .entityschemaitem import * from .entitysearchparams import * @@ -38,6 +43,7 @@ from .purposeattribute import * from .redirectentityview import * from .relationattribute import * +from .relationentity import * from .relationitem import * from .repeatableattribute import * from .savedview import * @@ -55,4 +61,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","EntityCapability","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelatedEntitiesCount","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationAttributeType","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] +__all__ = ["Activity","ActivityCallerContext","ActivityCallerContextEpilotAuth","ActivityCallerContextEpilotAuthToken","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","Entity","EntityACL","EntityCapability","EntityCapabilityUIHooks","EntityCapabilityUIHooksRequiredPermission","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityItem","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntityOperationPayload","EntityOwner","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemLayoutSettings","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaLayoutSettings","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelatedEntitiesCount","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeActionsNewEntityItem","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationAttributeType","RelationEntity","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewCreatedBy2","SavedViewCreatedBy2Source","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SavedViewItemCreatedBy2","SavedViewItemCreatedBy2Source","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] diff --git a/entity/src/epilot/models/shared/activity.py b/entity/src/epilot/models/shared/activity.py index f8a872f59..6f7a568bf 100755 --- a/entity/src/epilot/models/shared/activity.py +++ b/entity/src/epilot/models/shared/activity.py @@ -4,11 +4,10 @@ import dataclasses from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional +from typing import Any, Dict, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Activity: message: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message') }}) @@ -16,6 +15,6 @@ class Activity: title: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title') }}) r"""Title for activity. Supports handlebars syntax.""" type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) + payload: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/activitycallercontext.py b/entity/src/epilot/models/shared/activitycallercontext.py new file mode 100755 index 000000000..9d7333dd9 --- /dev/null +++ b/entity/src/epilot/models/shared/activitycallercontext.py @@ -0,0 +1,35 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from dataclasses_json import Undefined, dataclass_json +from epilot import utils +from typing import Any, Dict, Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class ActivityCallerContextEpilotAuthToken: + cognito_username: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('cognito:username'), 'exclude': lambda f: f is None }}) + custom_ivy_user_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('custom:ivy_user_id'), 'exclude': lambda f: f is None }}) + email: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email'), 'exclude': lambda f: f is None }}) + sub: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sub'), 'exclude': lambda f: f is None }}) + + + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class ActivityCallerContextEpilotAuth: + token: Optional[ActivityCallerContextEpilotAuthToken] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token'), 'exclude': lambda f: f is None }}) + + + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class ActivityCallerContext: + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + epilot_auth: Optional[ActivityCallerContextEpilotAuth] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('EpilotAuth'), 'exclude': lambda f: f is None }}) + + diff --git a/entity/src/epilot/models/shared/activityitem.py b/entity/src/epilot/models/shared/activityitem.py index 366474d32..944040e49 100755 --- a/entity/src/epilot/models/shared/activityitem.py +++ b/entity/src/epilot/models/shared/activityitem.py @@ -3,15 +3,15 @@ from __future__ import annotations import dataclasses import dateutil.parser +from ..shared import activitycallercontext as shared_activitycallercontext from ..shared import entityoperation as shared_entityoperation from dataclasses_json import Undefined, dataclass_json from datetime import datetime from epilot import utils -from typing import Any, Optional +from typing import Any, Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ActivityItem: message: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message') }}) @@ -21,11 +21,11 @@ class ActivityItem: type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_id'), 'exclude': lambda f: f is None }}) r"""See https://github.com/ulid/spec""" - caller: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caller'), 'exclude': lambda f: f is None }}) - operations: Optional[list[shared_entityoperation.EntityOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('operations'), 'exclude': lambda f: f is None }}) + caller: Optional[shared_activitycallercontext.ActivityCallerContext] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caller'), 'exclude': lambda f: f is None }}) + operations: Optional[List[shared_entityoperation.EntityOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('operations'), 'exclude': lambda f: f is None }}) operations_total: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('operations_total'), 'exclude': lambda f: f is None }}) r"""Count of total operations attached to this activity""" - payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) + payload: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) timestamp: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timestamp'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/addressrelationattribute.py b/entity/src/epilot/models/shared/addressrelationattribute.py index e0728d4cf..7d5bb6cc0 100755 --- a/entity/src/epilot/models/shared/addressrelationattribute.py +++ b/entity/src/epilot/models/shared/addressrelationattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class AddressRelationAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AddressRelationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class AddressRelationAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AddressRelationAttribute: r"""Reference to an address attribute of another entity""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[AddressRelationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/automationattribute.py b/entity/src/epilot/models/shared/automationattribute.py index 3389c3be7..87e3f5953 100755 --- a/entity/src/epilot/models/shared/automationattribute.py +++ b/entity/src/epilot/models/shared/automationattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class AutomationAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AutomationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class AutomationAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AutomationAttribute: r"""Automation entity""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[AutomationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/booleanattribute.py b/entity/src/epilot/models/shared/booleanattribute.py index 75ee5293b..8afee7c5f 100755 --- a/entity/src/epilot/models/shared/booleanattribute.py +++ b/entity/src/epilot/models/shared/booleanattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class BooleanAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BooleanAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class BooleanAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BooleanAttribute: r"""Yes / No Toggle""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[BooleanAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/classificationsupdate.py b/entity/src/epilot/models/shared/classificationsupdate.py index 0089f548f..243ca5326 100755 --- a/entity/src/epilot/models/shared/classificationsupdate.py +++ b/entity/src/epilot/models/shared/classificationsupdate.py @@ -5,15 +5,14 @@ from ..shared import taxonomyclassification as shared_taxonomyclassification from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ClassificationsUpdate: - create: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create'), 'exclude': lambda f: f is None }}) - delete: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('delete'), 'exclude': lambda f: f is None }}) - update: Optional[list[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('update'), 'exclude': lambda f: f is None }}) + create: Optional[List[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create'), 'exclude': lambda f: f is None }}) + delete: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('delete'), 'exclude': lambda f: f is None }}) + update: Optional[List[shared_taxonomyclassification.TaxonomyClassification]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('update'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/computedattribute.py b/entity/src/epilot/models/shared/computedattribute.py index 6b8a94368..4f2a20865 100755 --- a/entity/src/epilot/models/shared/computedattribute.py +++ b/entity/src/epilot/models/shared/computedattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class ComputedAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ComputedAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class ComputedAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ComputedAttribute: r"""An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes)""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[ComputedAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/consentattribute.py b/entity/src/epilot/models/shared/consentattribute.py index acdb4857d..cb3c865ba 100755 --- a/entity/src/epilot/models/shared/consentattribute.py +++ b/entity/src/epilot/models/shared/consentattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class ConsentAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ConsentAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,7 +46,6 @@ class ConsentAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ConsentAttribute: r"""Consent Management""" @@ -56,7 +53,7 @@ class ConsentAttribute: name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) topic: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('topic') }}) type: ConsentAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[ConsentAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. @@ -77,7 +74,7 @@ class ConsentAttribute: r"""Code name of the icon to used to represent this attribute. The value must be a valid @epilot/base-elements Icon name """ - identifiers: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('identifiers'), 'exclude': lambda f: f is None }}) + identifiers: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('identifiers'), 'exclude': lambda f: f is None }}) info_helpers: Optional[ConsentAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) r"""A set of configurations meant to document and assist the user in filling the attribute.""" layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/countryattribute.py b/entity/src/epilot/models/shared/countryattribute.py index 440ca2dfe..5b823ca04 100755 --- a/entity/src/epilot/models/shared/countryattribute.py +++ b/entity/src/epilot/models/shared/countryattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class CountryAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CountryAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class CountryAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CountryAttribute: r"""Country picker""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[CountryAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/currencyattribute.py b/entity/src/epilot/models/shared/currencyattribute.py index 62d416734..c533af784 100755 --- a/entity/src/epilot/models/shared/currencyattribute.py +++ b/entity/src/epilot/models/shared/currencyattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional, Union - +from typing import Any, List, Optional, Union @dataclasses.dataclass @@ -19,7 +18,6 @@ class CurrencyAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CurrencyAttributeCurrency1: r"""A currency configuration""" @@ -31,14 +29,12 @@ class CurrencyAttributeCurrency1: - @dataclasses.dataclass class CurrencyAttributeCurrency: pass @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CurrencyAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -67,16 +63,15 @@ class CurrencyAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CurrencyAttribute: r"""Currency input""" - currency: list[Union[CurrencyAttributeCurrency1]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) + currency: List[Union[CurrencyAttributeCurrency1]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) r"""An array of currency configurations with a country code (ISO-4217)""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) type: CurrencyAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[CurrencyAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/dateattribute.py b/entity/src/epilot/models/shared/dateattribute.py index aa76b10e4..40dc34957 100755 --- a/entity/src/epilot/models/shared/dateattribute.py +++ b/entity/src/epilot/models/shared/dateattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class DateAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DateAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -49,13 +47,12 @@ class DateAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DateAttribute: r"""Date or Datetime picker""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[DateAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/entity.py b/entity/src/epilot/models/shared/entity.py new file mode 100755 index 000000000..24a2d4aa5 --- /dev/null +++ b/entity/src/epilot/models/shared/entity.py @@ -0,0 +1,32 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import dateutil.parser +from ..shared import entityacl as shared_entityacl +from ..shared import entityowner as shared_entityowner +from dataclasses_json import Undefined, dataclass_json +from datetime import datetime +from epilot import utils +from typing import Any, Dict, List, Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class Entity: + acl: Optional[shared_entityacl.EntityACL] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_acl'), 'exclude': lambda f: f is None }}) + r"""Access control list (ACL) for an entity. Defines sharing access to external orgs or users.""" + created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse }}) + id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_id'), 'exclude': lambda f: f is None }}) + org: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_org'), 'exclude': lambda f: f is None }}) + r"""Organization Id the entity belongs to""" + owners: Optional[List[shared_entityowner.EntityOwner]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_owners'), 'exclude': lambda f: f is None }}) + schema: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_schema'), 'exclude': lambda f: f is None }}) + r"""URL-friendly identifier for the entity schema""" + tags: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags') }}) + title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_title') }}) + r"""Title of entity""" + updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse }}) + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + + diff --git a/entity/src/epilot/models/shared/entityacl.py b/entity/src/epilot/models/shared/entityacl.py new file mode 100755 index 000000000..b874c2527 --- /dev/null +++ b/entity/src/epilot/models/shared/entityacl.py @@ -0,0 +1,19 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from dataclasses_json import Undefined, dataclass_json +from epilot import utils +from typing import Any, Dict, List, Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class EntityACL: + r"""Access control list (ACL) for an entity. Defines sharing access to external orgs or users.""" + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + delete: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('delete'), 'exclude': lambda f: f is None }}) + edit: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edit'), 'exclude': lambda f: f is None }}) + view: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view'), 'exclude': lambda f: f is None }}) + + diff --git a/entity/src/epilot/models/shared/entitycapability.py b/entity/src/epilot/models/shared/entitycapability.py index 82e55ca8d..97e9b7b9e 100755 --- a/entity/src/epilot/models/shared/entitycapability.py +++ b/entity/src/epilot/models/shared/entitycapability.py @@ -32,18 +32,57 @@ from ..shared import userrelationattribute as shared_userrelationattribute from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional, Union +from typing import Any, Dict, List, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class EntityCapabilityUIHooksRequiredPermission: + r"""Require a permission to display UI hook""" + action: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action') }}) + resource: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('resource'), 'exclude': lambda f: f is None }}) + + + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class EntityCapabilityUIHooks: + hook: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hook') }}) + r"""name of the hook to use""" + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + component: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('component'), 'exclude': lambda f: f is None }}) + r"""the component to be dynamically loaded""" + disabled: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('disabled'), 'exclude': lambda f: f is None }}) + r"""Whether capability should be disabled""" + group_expanded: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group_expanded'), 'exclude': lambda f: f is None }}) + r"""Sets the group expand/collapse default state""" + header: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('header'), 'exclude': lambda f: f is None }}) + r"""Specific to Activity pilot""" + icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) + r"""Preview icon name(As in Base elements) for the capability""" + import_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('import'), 'exclude': lambda f: f is None }}) + r"""package to be imported""" + order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) + r"""render order (ascending)""" + render_condition: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_condition'), 'exclude': lambda f: f is None }}) + required_permission: Optional[EntityCapabilityUIHooksRequiredPermission] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('requiredPermission'), 'exclude': lambda f: f is None }}) + r"""Require a permission to display UI hook""" + route: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('route'), 'exclude': lambda f: f is None }}) + r"""route for specified capability""" + title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) + + + +@dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityCapability: r"""Capabilities the Entity has. Turn features on/off for entities.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Unique name for the capability""" - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - attributes: Optional[list[Union[shared_textattribute.TextAttribute, shared_linkattribute.LinkAttribute, shared_dateattribute.DateAttribute, shared_countryattribute.CountryAttribute, shared_booleanattribute.BooleanAttribute, shared_selectattribute.SelectAttribute, shared_multiselectattribute.MultiSelectAttribute, shared_statusattribute.StatusAttribute, shared_sequenceattribute.SequenceAttribute, shared_relationattribute.RelationAttribute, shared_userrelationattribute.UserRelationAttribute, shared_addressrelationattribute.AddressRelationAttribute, shared_paymentmethodrelationattribute.PaymentMethodRelationAttribute, shared_currencyattribute.CurrencyAttribute, shared_repeatableattribute.RepeatableAttribute, shared_tagsattribute.TagsAttribute, shared_numberattribute.NumberAttribute, shared_consentattribute.ConsentAttribute, shared_internalattribute.InternalAttribute, shared_orderedlistattribute.OrderedListAttribute, shared_fileattribute.FileAttribute, shared_computedattribute.ComputedAttribute, shared_partnerstatusattribute.PartnerStatusAttribute, shared_invitationemailattribute.InvitationEmailAttribute, shared_automationattribute.AutomationAttribute, shared_internaluserattribute.InternalUserAttribute, shared_purposeattribute.PurposeAttribute, shared_partnerorganisationattribute.PartnerOrganisationAttribute]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + attributes: Optional[List[Union[shared_textattribute.TextAttribute, shared_linkattribute.LinkAttribute, shared_dateattribute.DateAttribute, shared_countryattribute.CountryAttribute, shared_booleanattribute.BooleanAttribute, shared_selectattribute.SelectAttribute, shared_multiselectattribute.MultiSelectAttribute, shared_statusattribute.StatusAttribute, shared_sequenceattribute.SequenceAttribute, shared_relationattribute.RelationAttribute, shared_userrelationattribute.UserRelationAttribute, shared_addressrelationattribute.AddressRelationAttribute, shared_paymentmethodrelationattribute.PaymentMethodRelationAttribute, shared_currencyattribute.CurrencyAttribute, shared_repeatableattribute.RepeatableAttribute, shared_tagsattribute.TagsAttribute, shared_numberattribute.NumberAttribute, shared_consentattribute.ConsentAttribute, shared_internalattribute.InternalAttribute, shared_orderedlistattribute.OrderedListAttribute, shared_fileattribute.FileAttribute, shared_computedattribute.ComputedAttribute, shared_partnerstatusattribute.PartnerStatusAttribute, shared_invitationemailattribute.InvitationEmailAttribute, shared_automationattribute.AutomationAttribute, shared_internaluserattribute.InternalUserAttribute, shared_purposeattribute.PurposeAttribute, shared_partnerorganisationattribute.PartnerOrganisationAttribute]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes'), 'exclude': lambda f: f is None }}) feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This capability should only be active when the feature flag is enabled""" legacy: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('legacy'), 'exclude': lambda f: f is None }}) @@ -52,6 +91,6 @@ class EntityCapability: r"""This capability should only be active when the setting is enabled""" title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('title'), 'exclude': lambda f: f is None }}) r"""Human readable title of the capability""" - ui_hooks: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_hooks'), 'exclude': lambda f: f is None }}) + ui_hooks: Optional[List[EntityCapabilityUIHooks]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_hooks'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaultcreate.py b/entity/src/epilot/models/shared/entitydefaultcreate.py index 001572853..57c552550 100755 --- a/entity/src/epilot/models/shared/entitydefaultcreate.py +++ b/entity/src/epilot/models/shared/entitydefaultcreate.py @@ -5,11 +5,10 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Optional +from typing import Dict, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityDefaultCreateTableMenuOptions: icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) @@ -22,10 +21,9 @@ class EntityDefaultCreateViewType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityDefaultCreate: - search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) + search_params: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) table_menu_options: Optional[EntityDefaultCreateTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) view_type: Optional[EntityDefaultCreateViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaultedit.py b/entity/src/epilot/models/shared/entitydefaultedit.py index 0538a7bcc..93d6c09fc 100755 --- a/entity/src/epilot/models/shared/entitydefaultedit.py +++ b/entity/src/epilot/models/shared/entitydefaultedit.py @@ -5,11 +5,10 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Optional +from typing import Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityDefaultEditTableMenuOptions: icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) @@ -22,11 +21,10 @@ class EntityDefaultEditViewType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityDefaultEdit: - search_params: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) - summary_attributes: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) + search_params: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) + summary_attributes: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) r"""List of attribute names that we show in the summary header""" table_menu_options: Optional[EntityDefaultEditTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) view_type: Optional[EntityDefaultEditViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py index e53fe88f7..185ef4ba5 100755 --- a/entity/src/epilot/models/shared/entitydefaulttable.py +++ b/entity/src/epilot/models/shared/entitydefaulttable.py @@ -5,14 +5,13 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Optional, Union +from typing import List, Optional, Union class EntityDefaultTableDropdownItems2Type(str, Enum): LINK = 'link' @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityDefaultTableDropdownItems2: feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) @@ -30,7 +29,6 @@ class EntityDefaultTableDropdownItems1Type(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityDefaultTableDropdownItems1: entity: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity'), 'exclude': lambda f: f is None }}) @@ -44,20 +42,17 @@ class EntityDefaultTableDropdownItems1: - @dataclasses.dataclass class EntityDefaultTableDropdownItems: pass - @dataclasses.dataclass class EntityDefaultTableNavbarActionsOptionsParams: pass @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityDefaultTableNavbarActionsOptions: label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) @@ -67,11 +62,10 @@ class EntityDefaultTableNavbarActionsOptions: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityDefaultTableNavbarActions: type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - options: Optional[list[EntityDefaultTableNavbarActionsOptions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + options: Optional[List[EntityDefaultTableNavbarActionsOptions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) @@ -80,15 +74,14 @@ class EntityDefaultTableViewType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityDefaultTable: classic_view: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classic_view'), 'exclude': lambda f: f is None }}) - dropdown_items: Optional[list[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dropdown_items'), 'exclude': lambda f: f is None }}) + dropdown_items: Optional[List[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dropdown_items'), 'exclude': lambda f: f is None }}) enable_thumbnails: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_thumbnails'), 'exclude': lambda f: f is None }}) r"""Enable the thumbnail column""" - navbar_actions: Optional[list[EntityDefaultTableNavbarActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('navbar_actions'), 'exclude': lambda f: f is None }}) - row_actions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('row_actions'), 'exclude': lambda f: f is None }}) + navbar_actions: Optional[List[EntityDefaultTableNavbarActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('navbar_actions'), 'exclude': lambda f: f is None }}) + row_actions: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('row_actions'), 'exclude': lambda f: f is None }}) view_type: Optional[EntityDefaultTableViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entityimportparams.py b/entity/src/epilot/models/shared/entityimportparams.py index 16767e71a..d8967ca2d 100755 --- a/entity/src/epilot/models/shared/entityimportparams.py +++ b/entity/src/epilot/models/shared/entityimportparams.py @@ -7,7 +7,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityImportParamsS3Reference: r"""The S3 bucket and key where the JSON file for import is located.""" @@ -20,7 +19,6 @@ class EntityImportParamsS3Reference: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityImportParams: r"""The parameters for importing entities.""" diff --git a/entity/src/epilot/models/shared/entityitem.py b/entity/src/epilot/models/shared/entityitem.py new file mode 100755 index 000000000..c8e152b0a --- /dev/null +++ b/entity/src/epilot/models/shared/entityitem.py @@ -0,0 +1,32 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import dateutil.parser +from ..shared import entityacl as shared_entityacl +from ..shared import entityowner as shared_entityowner +from dataclasses_json import Undefined, dataclass_json +from datetime import datetime +from epilot import utils +from typing import Any, Dict, List, Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class EntityItem: + created_at: Optional[datetime] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_created_at'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_id') }}) + org: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_org') }}) + r"""Organization Id the entity belongs to""" + schema: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_schema') }}) + r"""URL-friendly identifier for the entity schema""" + title: Optional[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_title') }}) + r"""Title of entity""" + updated_at: Optional[datetime] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_updated_at'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) + acl: Optional[shared_entityacl.EntityACL] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_acl'), 'exclude': lambda f: f is None }}) + r"""Access control list (ACL) for an entity. Defines sharing access to external orgs or users.""" + owners: Optional[List[shared_entityowner.EntityOwner]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_owners'), 'exclude': lambda f: f is None }}) + tags: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags') }}) + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + + diff --git a/entity/src/epilot/models/shared/entityoperation.py b/entity/src/epilot/models/shared/entityoperation.py index bb79d5274..8a374ebe6 100755 --- a/entity/src/epilot/models/shared/entityoperation.py +++ b/entity/src/epilot/models/shared/entityoperation.py @@ -2,19 +2,23 @@ from __future__ import annotations import dataclasses +import dateutil.parser +from ..shared import entity as shared_entity +from ..shared import entityacl as shared_entityacl +from ..shared import entityowner as shared_entityowner from dataclasses_json import Undefined, dataclass_json +from datetime import datetime from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityOperationDiff: - added: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('added'), 'exclude': lambda f: f is None }}) - deleted: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deleted'), 'exclude': lambda f: f is None }}) - updated: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated'), 'exclude': lambda f: f is None }}) + added: Optional[shared_entity.Entity] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('added'), 'exclude': lambda f: f is None }}) + deleted: Optional[shared_entity.Entity] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deleted'), 'exclude': lambda f: f is None }}) + updated: Optional[shared_entity.Entity] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated'), 'exclude': lambda f: f is None }}) @@ -25,7 +29,6 @@ class EntityOperationOperation(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityOperationParams: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) @@ -36,7 +39,27 @@ class EntityOperationParams: @dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class EntityOperationPayload: + acl: Optional[shared_entityacl.EntityACL] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_acl'), 'exclude': lambda f: f is None }}) + r"""Access control list (ACL) for an entity. Defines sharing access to external orgs or users.""" + created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse }}) + id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_id'), 'exclude': lambda f: f is None }}) + org: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_org'), 'exclude': lambda f: f is None }}) + r"""Organization Id the entity belongs to""" + owners: Optional[List[shared_entityowner.EntityOwner]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_owners'), 'exclude': lambda f: f is None }}) + schema: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_schema'), 'exclude': lambda f: f is None }}) + r"""URL-friendly identifier for the entity schema""" + tags: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags') }}) + title: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_title') }}) + r"""Title of entity""" + updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse }}) + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + + + +@dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityOperation: entity: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity') }}) @@ -46,6 +69,6 @@ class EntityOperation: r"""See https://github.com/ulid/spec""" diff: Optional[EntityOperationDiff] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('diff'), 'exclude': lambda f: f is None }}) params: Optional[EntityOperationParams] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('params'), 'exclude': lambda f: f is None }}) - payload: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) + payload: Optional[EntityOperationPayload] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payload'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entityowner.py b/entity/src/epilot/models/shared/entityowner.py new file mode 100755 index 000000000..0584dfac0 --- /dev/null +++ b/entity/src/epilot/models/shared/entityowner.py @@ -0,0 +1,20 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from dataclasses_json import Undefined, dataclass_json +from epilot import utils +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class EntityOwner: + r"""The user / organization owning this entity. + + Note: Owner implicitly has access to the entity regardless of ACLs. + """ + org_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org_id') }}) + user_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user_id'), 'exclude': lambda f: f is None }}) + + diff --git a/entity/src/epilot/models/shared/entityschema.py b/entity/src/epilot/models/shared/entityschema.py index 3535b24ee..8626a8159 100755 --- a/entity/src/epilot/models/shared/entityschema.py +++ b/entity/src/epilot/models/shared/entityschema.py @@ -40,11 +40,10 @@ from ..shared import userrelationattribute as shared_userrelationattribute from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional, Union +from typing import Any, Dict, List, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaGroupSettingsInfoTooltipTitle: default: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default'), 'exclude': lambda f: f is None }}) @@ -54,12 +53,11 @@ class EntitySchemaGroupSettingsInfoTooltipTitle: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaGroupSettings: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) expanded: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('expanded'), 'exclude': lambda f: f is None }}) feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This group should only be active when the feature flag is enabled""" @@ -73,35 +71,46 @@ class EntitySchemaGroupSettings: +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class EntitySchemaLayoutSettings: + r"""Custom grid definitions for the layout. These settings are composed by managed and un-managed properties: + - Managed Properties: are interpreted and transformed into layout styles + - Un-managed Properties: are appended as styles into the attribute mounting node + """ + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + grid_gap: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('grid_gap'), 'exclude': lambda f: f is None }}) + r"""Defines the grid gap for the mounting node of the attribute.""" + grid_template_columns: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('grid_template_columns'), 'exclude': lambda f: f is None }}) + r"""Defines the grid column template for the mounting node of the attribute.""" + + + @dataclasses.dataclass class EntitySchemaUIConfigCreateView: pass - @dataclasses.dataclass class EntitySchemaUIConfigEditView: pass - @dataclasses.dataclass class EntitySchemaUIConfigListItemSummaryAttributes: pass @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaUIConfigListItem: - summary_attributes: Optional[list[Union[shared_summaryattribute.SummaryAttribute, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) + summary_attributes: Optional[List[Union[shared_summaryattribute.SummaryAttribute, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaUIConfigSharing: show_sharing_button: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_sharing_button'), 'exclude': lambda f: f is None }}) @@ -110,20 +119,17 @@ class EntitySchemaUIConfigSharing: - @dataclasses.dataclass class EntitySchemaUIConfigSingleView: pass - @dataclasses.dataclass class EntitySchemaUIConfigTableView: pass @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaUIConfig: create_view: Optional[Union[shared_entitydefaultcreate.EntityDefaultCreate, shared_redirectentityview.RedirectEntityView, shared_entityviewdisabled.EntityViewDisabled]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) @@ -137,13 +143,12 @@ class EntitySchemaUIConfig: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchema: r"""The \\"type\\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.""" - attributes: list[Union[shared_textattribute.TextAttribute, shared_linkattribute.LinkAttribute, shared_dateattribute.DateAttribute, shared_countryattribute.CountryAttribute, shared_booleanattribute.BooleanAttribute, shared_selectattribute.SelectAttribute, shared_multiselectattribute.MultiSelectAttribute, shared_statusattribute.StatusAttribute, shared_sequenceattribute.SequenceAttribute, shared_relationattribute.RelationAttribute, shared_userrelationattribute.UserRelationAttribute, shared_addressrelationattribute.AddressRelationAttribute, shared_paymentmethodrelationattribute.PaymentMethodRelationAttribute, shared_currencyattribute.CurrencyAttribute, shared_repeatableattribute.RepeatableAttribute, shared_tagsattribute.TagsAttribute, shared_numberattribute.NumberAttribute, shared_consentattribute.ConsentAttribute, shared_internalattribute.InternalAttribute, shared_orderedlistattribute.OrderedListAttribute, shared_fileattribute.FileAttribute, shared_computedattribute.ComputedAttribute, shared_partnerstatusattribute.PartnerStatusAttribute, shared_invitationemailattribute.InvitationEmailAttribute, shared_automationattribute.AutomationAttribute, shared_internaluserattribute.InternalUserAttribute, shared_purposeattribute.PurposeAttribute, shared_partnerorganisationattribute.PartnerOrganisationAttribute]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) + attributes: List[Union[shared_textattribute.TextAttribute, shared_linkattribute.LinkAttribute, shared_dateattribute.DateAttribute, shared_countryattribute.CountryAttribute, shared_booleanattribute.BooleanAttribute, shared_selectattribute.SelectAttribute, shared_multiselectattribute.MultiSelectAttribute, shared_statusattribute.StatusAttribute, shared_sequenceattribute.SequenceAttribute, shared_relationattribute.RelationAttribute, shared_userrelationattribute.UserRelationAttribute, shared_addressrelationattribute.AddressRelationAttribute, shared_paymentmethodrelationattribute.PaymentMethodRelationAttribute, shared_currencyattribute.CurrencyAttribute, shared_repeatableattribute.RepeatableAttribute, shared_tagsattribute.TagsAttribute, shared_numberattribute.NumberAttribute, shared_consentattribute.ConsentAttribute, shared_internalattribute.InternalAttribute, shared_orderedlistattribute.OrderedListAttribute, shared_fileattribute.FileAttribute, shared_computedattribute.ComputedAttribute, shared_partnerstatusattribute.PartnerStatusAttribute, shared_invitationemailattribute.InvitationEmailAttribute, shared_automationattribute.AutomationAttribute, shared_internaluserattribute.InternalUserAttribute, shared_purposeattribute.PurposeAttribute, shared_partnerorganisationattribute.PartnerOrganisationAttribute]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) r"""An ordered list of attributes the entity contains""" - capabilities: list[shared_entitycapability.EntityCapability] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities') }}) + capabilities: List[shared_entitycapability.EntityCapability] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""User-friendly identifier for the entity schema""" plural: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plural') }}) @@ -151,18 +156,18 @@ class EntitySchema: r"""URL-friendly identifier for the entity schema""" blueprint: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('blueprint'), 'exclude': lambda f: f is None }}) r"""Reference to blueprint""" - dialog_config: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dialog_config'), 'exclude': lambda f: f is None }}) + dialog_config: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dialog_config'), 'exclude': lambda f: f is None }}) draft: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('draft'), 'exclude': lambda f: f is None }}) - enable_setting: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_setting'), 'exclude': lambda f: f is None }}) + enable_setting: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_setting'), 'exclude': lambda f: f is None }}) r"""This schema should only be active when one of the organization settings is enabled""" - explicit_search_mappings: Optional[dict[str, shared_searchmappings.SearchMappings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('explicit_search_mappings'), 'exclude': lambda f: f is None }}) + explicit_search_mappings: Optional[Dict[str, shared_searchmappings.SearchMappings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('explicit_search_mappings'), 'exclude': lambda f: f is None }}) r"""Advanced: explicit Elasticsearch index mapping definitions for entity data""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This schema should only be active when the feature flag is enabled""" - group_settings: Optional[list[EntitySchemaGroupSettings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group_settings'), 'exclude': lambda f: f is None }}) + group_settings: Optional[List[EntitySchemaGroupSettings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group_settings'), 'exclude': lambda f: f is None }}) r"""A dictionary of Group Titles and associated settings if present.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) - layout_settings: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout_settings'), 'exclude': lambda f: f is None }}) + layout_settings: Optional[EntitySchemaLayoutSettings] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout_settings'), 'exclude': lambda f: f is None }}) r"""Custom grid definitions for the layout. These settings are composed by managed and un-managed properties: - Managed Properties: are interpreted and transformed into layout styles - Un-managed Properties: are appended as styles into the attribute mounting node diff --git a/entity/src/epilot/models/shared/entityschemaitem.py b/entity/src/epilot/models/shared/entityschemaitem.py index bcece419b..789ec2491 100755 --- a/entity/src/epilot/models/shared/entityschemaitem.py +++ b/entity/src/epilot/models/shared/entityschemaitem.py @@ -40,11 +40,10 @@ from ..shared import userrelationattribute as shared_userrelationattribute from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional, Union +from typing import Any, Dict, List, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaItemGroupSettingsInfoTooltipTitle: default: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('default'), 'exclude': lambda f: f is None }}) @@ -54,12 +53,11 @@ class EntitySchemaItemGroupSettingsInfoTooltipTitle: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaItemGroupSettings: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) expanded: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('expanded'), 'exclude': lambda f: f is None }}) feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This group should only be active when the feature flag is enabled""" @@ -74,7 +72,22 @@ class EntitySchemaItemGroupSettings: @dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class EntitySchemaItemLayoutSettings: + r"""Custom grid definitions for the layout. These settings are composed by managed and un-managed properties: + - Managed Properties: are interpreted and transformed into layout styles + - Un-managed Properties: are appended as styles into the attribute mounting node + """ + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + grid_gap: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('grid_gap'), 'exclude': lambda f: f is None }}) + r"""Defines the grid gap for the mounting node of the attribute.""" + grid_template_columns: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('grid_template_columns'), 'exclude': lambda f: f is None }}) + r"""Defines the grid column template for the mounting node of the attribute.""" + + + +@dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaItemSource: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) @@ -83,35 +96,30 @@ class EntitySchemaItemSource: - @dataclasses.dataclass class EntitySchemaItemUIConfigCreateView: pass - @dataclasses.dataclass class EntitySchemaItemUIConfigEditView: pass - @dataclasses.dataclass class EntitySchemaItemUIConfigListItemSummaryAttributes: pass @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaItemUIConfigListItem: - summary_attributes: Optional[list[Union[shared_summaryattribute.SummaryAttribute, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) + summary_attributes: Optional[List[Union[shared_summaryattribute.SummaryAttribute, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaItemUIConfigSharing: show_sharing_button: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('show_sharing_button'), 'exclude': lambda f: f is None }}) @@ -120,20 +128,17 @@ class EntitySchemaItemUIConfigSharing: - @dataclasses.dataclass class EntitySchemaItemUIConfigSingleView: pass - @dataclasses.dataclass class EntitySchemaItemUIConfigTableView: pass @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaItemUIConfig: create_view: Optional[Union[shared_entitydefaultcreate.EntityDefaultCreate, shared_redirectentityview.RedirectEntityView, shared_entityviewdisabled.EntityViewDisabled]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('create_view'), 'exclude': lambda f: f is None }}) @@ -147,13 +152,12 @@ class EntitySchemaItemUIConfig: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySchemaItem: r"""The \\"type\\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.""" - attributes: list[Union[shared_textattribute.TextAttribute, shared_linkattribute.LinkAttribute, shared_dateattribute.DateAttribute, shared_countryattribute.CountryAttribute, shared_booleanattribute.BooleanAttribute, shared_selectattribute.SelectAttribute, shared_multiselectattribute.MultiSelectAttribute, shared_statusattribute.StatusAttribute, shared_sequenceattribute.SequenceAttribute, shared_relationattribute.RelationAttribute, shared_userrelationattribute.UserRelationAttribute, shared_addressrelationattribute.AddressRelationAttribute, shared_paymentmethodrelationattribute.PaymentMethodRelationAttribute, shared_currencyattribute.CurrencyAttribute, shared_repeatableattribute.RepeatableAttribute, shared_tagsattribute.TagsAttribute, shared_numberattribute.NumberAttribute, shared_consentattribute.ConsentAttribute, shared_internalattribute.InternalAttribute, shared_orderedlistattribute.OrderedListAttribute, shared_fileattribute.FileAttribute, shared_computedattribute.ComputedAttribute, shared_partnerstatusattribute.PartnerStatusAttribute, shared_invitationemailattribute.InvitationEmailAttribute, shared_automationattribute.AutomationAttribute, shared_internaluserattribute.InternalUserAttribute, shared_purposeattribute.PurposeAttribute, shared_partnerorganisationattribute.PartnerOrganisationAttribute]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) + attributes: List[Union[shared_textattribute.TextAttribute, shared_linkattribute.LinkAttribute, shared_dateattribute.DateAttribute, shared_countryattribute.CountryAttribute, shared_booleanattribute.BooleanAttribute, shared_selectattribute.SelectAttribute, shared_multiselectattribute.MultiSelectAttribute, shared_statusattribute.StatusAttribute, shared_sequenceattribute.SequenceAttribute, shared_relationattribute.RelationAttribute, shared_userrelationattribute.UserRelationAttribute, shared_addressrelationattribute.AddressRelationAttribute, shared_paymentmethodrelationattribute.PaymentMethodRelationAttribute, shared_currencyattribute.CurrencyAttribute, shared_repeatableattribute.RepeatableAttribute, shared_tagsattribute.TagsAttribute, shared_numberattribute.NumberAttribute, shared_consentattribute.ConsentAttribute, shared_internalattribute.InternalAttribute, shared_orderedlistattribute.OrderedListAttribute, shared_fileattribute.FileAttribute, shared_computedattribute.ComputedAttribute, shared_partnerstatusattribute.PartnerStatusAttribute, shared_invitationemailattribute.InvitationEmailAttribute, shared_automationattribute.AutomationAttribute, shared_internaluserattribute.InternalUserAttribute, shared_purposeattribute.PurposeAttribute, shared_partnerorganisationattribute.PartnerOrganisationAttribute]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes') }}) r"""An ordered list of attributes the entity contains""" - capabilities: list[shared_entitycapability.EntityCapability] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities') }}) + capabilities: List[shared_entitycapability.EntityCapability] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('capabilities') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""User-friendly identifier for the entity schema""" plural: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plural') }}) @@ -163,20 +167,20 @@ class EntitySchemaItem: r"""Reference to blueprint""" comment: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('comment'), 'exclude': lambda f: f is None }}) created_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'exclude': lambda f: f is None }}) - dialog_config: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dialog_config'), 'exclude': lambda f: f is None }}) + dialog_config: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dialog_config'), 'exclude': lambda f: f is None }}) draft: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('draft'), 'exclude': lambda f: f is None }}) - enable_setting: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_setting'), 'exclude': lambda f: f is None }}) + enable_setting: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_setting'), 'exclude': lambda f: f is None }}) r"""This schema should only be active when one of the organization settings is enabled""" - explicit_search_mappings: Optional[dict[str, shared_searchmappings.SearchMappings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('explicit_search_mappings'), 'exclude': lambda f: f is None }}) + explicit_search_mappings: Optional[Dict[str, shared_searchmappings.SearchMappings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('explicit_search_mappings'), 'exclude': lambda f: f is None }}) r"""Advanced: explicit Elasticsearch index mapping definitions for entity data""" feature_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('feature_flag'), 'exclude': lambda f: f is None }}) r"""This schema should only be active when the feature flag is enabled""" - group_settings: Optional[list[EntitySchemaItemGroupSettings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group_settings'), 'exclude': lambda f: f is None }}) + group_settings: Optional[List[EntitySchemaItemGroupSettings]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('group_settings'), 'exclude': lambda f: f is None }}) r"""A dictionary of Group Titles and associated settings if present.""" icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Generated uuid for schema""" - layout_settings: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout_settings'), 'exclude': lambda f: f is None }}) + layout_settings: Optional[EntitySchemaItemLayoutSettings] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout_settings'), 'exclude': lambda f: f is None }}) r"""Custom grid definitions for the layout. These settings are composed by managed and un-managed properties: - Managed Properties: are interpreted and transformed into layout styles - Un-managed Properties: are appended as styles into the attribute mounting node diff --git a/entity/src/epilot/models/shared/entitysearchparams.py b/entity/src/epilot/models/shared/entitysearchparams.py index b3a2193b6..2ebbb3e60 100755 --- a/entity/src/epilot/models/shared/entitysearchparams.py +++ b/entity/src/epilot/models/shared/entitysearchparams.py @@ -4,8 +4,7 @@ import dataclasses from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass @@ -16,14 +15,13 @@ class EntitySearchParamsAggs: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySearchParams: q: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('q') }}) r"""Lucene queries supported with ElasticSearch""" aggs: Optional[EntitySearchParamsAggs] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggs'), 'exclude': lambda f: f is None }}) r"""Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.""" - fields_: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) + fields_: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) r"""List of entity fields to include in search results""" from_: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('from'), 'exclude': lambda f: f is None }}) hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hydrate'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitysearchresults.py b/entity/src/epilot/models/shared/entitysearchresults.py index 80028671e..66717912e 100755 --- a/entity/src/epilot/models/shared/entitysearchresults.py +++ b/entity/src/epilot/models/shared/entitysearchresults.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses +from ..shared import entityitem as shared_entityitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Any, Optional - +from typing import List, Optional @dataclasses.dataclass @@ -14,11 +14,10 @@ class EntitySearchResultsAggregations: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntitySearchResults: aggregations: Optional[EntitySearchResultsAggregations] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggregations'), 'exclude': lambda f: f is None }}) hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) - results: Optional[list[dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[shared_entityitem.EntityItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entityviewdisabled.py b/entity/src/epilot/models/shared/entityviewdisabled.py index 062013954..7585d58f1 100755 --- a/entity/src/epilot/models/shared/entityviewdisabled.py +++ b/entity/src/epilot/models/shared/entityviewdisabled.py @@ -12,7 +12,6 @@ class EntityViewDisabledViewType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EntityViewDisabled: view_type: Optional[EntityViewDisabledViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/fileattribute.py b/entity/src/epilot/models/shared/fileattribute.py index cf9709fe5..f24b6ee4f 100755 --- a/entity/src/epilot/models/shared/fileattribute.py +++ b/entity/src/epilot/models/shared/fileattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -23,7 +22,6 @@ class FileAttributeDefaultAccessControl(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class FileAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -53,15 +51,14 @@ class FileAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class FileAttribute: r"""File or Image Attachment""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) type: FileAttributeType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - allowed_extensions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allowed_extensions'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + allowed_extensions: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allowed_extensions'), 'exclude': lambda f: f is None }}) r"""List of file extensions (without the dot suffix)""" constraints: Optional[FileAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. diff --git a/entity/src/epilot/models/shared/getrelatedentitiescount.py b/entity/src/epilot/models/shared/getrelatedentitiescount.py index 75a577a84..4937882ce 100755 --- a/entity/src/epilot/models/shared/getrelatedentitiescount.py +++ b/entity/src/epilot/models/shared/getrelatedentitiescount.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class GetRelatedEntitiesCount: hits: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py index e2c60ff0f..58ad77ce4 100755 --- a/entity/src/epilot/models/shared/getrelationsrespwithpagination.py +++ b/entity/src/epilot/models/shared/getrelationsrespwithpagination.py @@ -2,18 +2,17 @@ from __future__ import annotations import dataclasses -from ..shared import getrelationsresp as shared_getrelationsresp +from ..shared import relationentity as shared_relationentity from ..shared import relationitem as shared_relationitem from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional, Union +from typing import List, Optional, Union @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class GetRelationsRespWithPagination: hits: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hits'), 'exclude': lambda f: f is None }}) - relations: Optional[list[Union[shared_relationitem.RelationItem, dict[str, Any]]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) + relations: Optional[List[Union[shared_relationitem.RelationItem, shared_relationentity.RelationEntity]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('relations'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/internalattribute.py b/entity/src/epilot/models/shared/internalattribute.py index 0f3377982..8904cf932 100755 --- a/entity/src/epilot/models/shared/internalattribute.py +++ b/entity/src/epilot/models/shared/internalattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class InternalAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InternalAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class InternalAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InternalAttribute: r"""No UI representation""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[InternalAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/internaluserattribute.py b/entity/src/epilot/models/shared/internaluserattribute.py index d3b4f06f6..bc78b86cb 100755 --- a/entity/src/epilot/models/shared/internaluserattribute.py +++ b/entity/src/epilot/models/shared/internaluserattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class InternalUserAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InternalUserAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class InternalUserAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InternalUserAttribute: r"""Epilot internal user info""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[InternalUserAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/invitationemailattribute.py b/entity/src/epilot/models/shared/invitationemailattribute.py index f884c68b7..00ed5f2a9 100755 --- a/entity/src/epilot/models/shared/invitationemailattribute.py +++ b/entity/src/epilot/models/shared/invitationemailattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class InvitationEmailAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InvitationEmailAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class InvitationEmailAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InvitationEmailAttribute: r"""Email address for send invitation""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[InvitationEmailAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/linkattribute.py b/entity/src/epilot/models/shared/linkattribute.py index b8e441e37..0be9182ac 100755 --- a/entity/src/epilot/models/shared/linkattribute.py +++ b/entity/src/epilot/models/shared/linkattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class LinkAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LinkAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class LinkAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LinkAttribute: r"""Link with title and href""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[LinkAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/multiselectattribute.py b/entity/src/epilot/models/shared/multiselectattribute.py index ef8026c2c..ee42a52d0 100755 --- a/entity/src/epilot/models/shared/multiselectattribute.py +++ b/entity/src/epilot/models/shared/multiselectattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional, Union - +from typing import Any, List, Optional, Union @dataclasses.dataclass @@ -19,7 +18,6 @@ class MultiSelectAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class MultiSelectAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -45,7 +43,6 @@ class MultiSelectAttributeInfoHelpers: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class MultiSelectAttributeOptions2: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) @@ -54,7 +51,6 @@ class MultiSelectAttributeOptions2: - @dataclasses.dataclass class MultiSelectAttributeOptions: pass @@ -65,13 +61,12 @@ class MultiSelectAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class MultiSelectAttribute: r"""Multi Choice Selection""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) allow_any: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_any'), 'exclude': lambda f: f is None }}) r"""Allow arbitrary input values in addition to provided options""" allow_extra_options: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_extra_options') }}) @@ -101,7 +96,7 @@ class MultiSelectAttribute: info_helpers: Optional[MultiSelectAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) r"""A set of configurations meant to document and assist the user in filling the attribute.""" layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[Union[str, MultiSelectAttributeOptions2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + options: Optional[List[Union[str, MultiSelectAttributeOptions2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/numberattribute.py b/entity/src/epilot/models/shared/numberattribute.py index b536b4ff6..19ac4e00f 100755 --- a/entity/src/epilot/models/shared/numberattribute.py +++ b/entity/src/epilot/models/shared/numberattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class NumberAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class NumberAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class NumberAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class NumberAttribute: r"""Numeric input""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[NumberAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/orderedlistattribute.py b/entity/src/epilot/models/shared/orderedlistattribute.py index 041f1ce8a..39f766c09 100755 --- a/entity/src/epilot/models/shared/orderedlistattribute.py +++ b/entity/src/epilot/models/shared/orderedlistattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class OrderedListAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class OrderedListAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class OrderedListAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class OrderedListAttribute: r"""Type of attribute to render N number of ordered fields""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[OrderedListAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/partnerorganisationattribute.py b/entity/src/epilot/models/shared/partnerorganisationattribute.py index 81d419c3e..8bf58167a 100755 --- a/entity/src/epilot/models/shared/partnerorganisationattribute.py +++ b/entity/src/epilot/models/shared/partnerorganisationattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class PartnerOrganisationAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PartnerOrganisationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class PartnerOrganisationAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PartnerOrganisationAttribute: r"""Shared Partner Organisations""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[PartnerOrganisationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/partnerstatusattribute.py b/entity/src/epilot/models/shared/partnerstatusattribute.py index 0b359ac34..c31039e36 100755 --- a/entity/src/epilot/models/shared/partnerstatusattribute.py +++ b/entity/src/epilot/models/shared/partnerstatusattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class PartnerStatusAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PartnerStatusAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class PartnerStatusAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PartnerStatusAttribute: r"""Partner Status""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[PartnerStatusAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py index 7e4cd1682..d23270214 100755 --- a/entity/src/epilot/models/shared/paymentmethodrelationattribute.py +++ b/entity/src/epilot/models/shared/paymentmethodrelationattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class PaymentMethodRelationAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentMethodRelationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class PaymentMethodRelationAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentMethodRelationAttribute: r"""Reference to a payment method attribute of another entity""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[PaymentMethodRelationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/purposeattribute.py b/entity/src/epilot/models/shared/purposeattribute.py index 81e036b8f..5fde92413 100755 --- a/entity/src/epilot/models/shared/purposeattribute.py +++ b/entity/src/epilot/models/shared/purposeattribute.py @@ -7,8 +7,7 @@ from datetime import datetime from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -21,7 +20,6 @@ class PurposeAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PurposeAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -50,13 +48,12 @@ class PurposeAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PurposeAttribute: r"""Entity Taxonomy""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[PurposeAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. @@ -84,7 +81,7 @@ class PurposeAttribute: layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Attribute sort order (ascending) in group""" - parents: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) + parents: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) preview_value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('preview_value_formatter'), 'exclude': lambda f: f is None }}) protected: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protected'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/redirectentityview.py b/entity/src/epilot/models/shared/redirectentityview.py index 440d7c0cb..139a5ac1a 100755 --- a/entity/src/epilot/models/shared/redirectentityview.py +++ b/entity/src/epilot/models/shared/redirectentityview.py @@ -12,7 +12,6 @@ class RedirectEntityViewViewType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class RedirectEntityView: route: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('route'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/relationattribute.py b/entity/src/epilot/models/shared/relationattribute.py index 9989c6b50..d405c076d 100755 --- a/entity/src/epilot/models/shared/relationattribute.py +++ b/entity/src/epilot/models/shared/relationattribute.py @@ -2,11 +2,15 @@ from __future__ import annotations import dataclasses +import dateutil.parser +from ..shared import entityacl as shared_entityacl +from ..shared import entityowner as shared_entityowner from ..shared import summaryfield as shared_summaryfield from dataclasses_json import Undefined, dataclass_json +from datetime import datetime from enum import Enum from epilot import utils -from typing import Any, Optional, Union +from typing import Any, Dict, List, Optional, Union class RelationAttributeActionsActionType(str, Enum): r"""The action type. Currently supported actions: @@ -23,7 +27,27 @@ class RelationAttributeActionsActionType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class RelationAttributeActionsNewEntityItem: + created_at: Optional[datetime] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_created_at'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_id') }}) + org: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_org') }}) + r"""Organization Id the entity belongs to""" + schema: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_schema') }}) + r"""URL-friendly identifier for the entity schema""" + title: Optional[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_title') }}) + r"""Title of entity""" + updated_at: Optional[datetime] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_updated_at'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) + acl: Optional[shared_entityacl.EntityACL] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_acl'), 'exclude': lambda f: f is None }}) + r"""Access control list (ACL) for an entity. Defines sharing access to external orgs or users.""" + owners: Optional[List[shared_entityowner.EntityOwner]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_owners'), 'exclude': lambda f: f is None }}) + tags: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags') }}) + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + + + +@dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class RelationAttributeActions: action_type: Optional[RelationAttributeActionsActionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action_type'), 'exclude': lambda f: f is None }}) @@ -41,14 +65,13 @@ class RelationAttributeActions: r"""Name of the feature flag that enables this action""" label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label'), 'exclude': lambda f: f is None }}) r"""The action label or action translation key (i18n)""" - new_entity_item: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('new_entity_item'), 'exclude': lambda f: f is None }}) + new_entity_item: Optional[RelationAttributeActionsNewEntityItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('new_entity_item'), 'exclude': lambda f: f is None }}) setting_flag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('setting_flag'), 'exclude': lambda f: f is None }}) r"""Name of the setting flag that enables this action""" - @dataclasses.dataclass class RelationAttributeConstraints: r"""A set of constraints applicable to the attribute. @@ -67,7 +90,6 @@ class RelationAttributeEditMode(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class RelationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -101,7 +123,6 @@ class RelationAttributeRelationType(str, Enum): HAS_ONE = 'has_one' - @dataclasses.dataclass class RelationAttributeSummaryFields: pass @@ -111,17 +132,16 @@ class RelationAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class RelationAttribute: r"""Entity Relationship""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) - actions: Optional[list[RelationAttributeActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('actions'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + actions: Optional[List[RelationAttributeActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('actions'), 'exclude': lambda f: f is None }}) add_button_label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('add_button_label'), 'exclude': lambda f: f is None }}) r"""Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is.""" - allowed_schemas: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allowedSchemas'), 'exclude': lambda f: f is None }}) + allowed_schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allowedSchemas'), 'exclude': lambda f: f is None }}) constraints: Optional[RelationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. @@ -167,7 +187,7 @@ class RelationAttribute: Note: Empty or invalid expression have no effect on the field visibility. """ required: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) - reverse_attributes: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reverse_attributes'), 'exclude': lambda f: f is None }}) + reverse_attributes: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reverse_attributes'), 'exclude': lambda f: f is None }}) r"""Map of schema slug to target relation attribute""" search_placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_placeholder'), 'exclude': lambda f: f is None }}) r"""Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is.""" @@ -177,7 +197,7 @@ class RelationAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - summary_fields: Optional[list[Union[str, shared_summaryfield.SummaryField]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_fields'), 'exclude': lambda f: f is None }}) + summary_fields: Optional[List[Union[str, shared_summaryfield.SummaryField]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_fields'), 'exclude': lambda f: f is None }}) type: Optional[RelationAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/relationentity.py b/entity/src/epilot/models/shared/relationentity.py new file mode 100755 index 000000000..3696832c5 --- /dev/null +++ b/entity/src/epilot/models/shared/relationentity.py @@ -0,0 +1,34 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import dateutil.parser +from ..shared import entityacl as shared_entityacl +from ..shared import entityowner as shared_entityowner +from ..shared import relationitem as shared_relationitem +from dataclasses_json import Undefined, dataclass_json +from datetime import datetime +from epilot import utils +from typing import Any, Dict, List, Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class RelationEntity: + created_at: Optional[datetime] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_created_at'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_id') }}) + org: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_org') }}) + r"""Organization Id the entity belongs to""" + schema: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_schema') }}) + r"""URL-friendly identifier for the entity schema""" + title: Optional[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_title') }}) + r"""Title of entity""" + updated_at: Optional[datetime] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_updated_at'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) + acl: Optional[shared_entityacl.EntityACL] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_acl'), 'exclude': lambda f: f is None }}) + r"""Access control list (ACL) for an entity. Defines sharing access to external orgs or users.""" + owners: Optional[List[shared_entityowner.EntityOwner]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_owners'), 'exclude': lambda f: f is None }}) + tags: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags') }}) + dollar_relation: Optional[shared_relationitem.RelationItem] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('$relation'), 'exclude': lambda f: f is None }}) + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + + diff --git a/entity/src/epilot/models/shared/relationitem.py b/entity/src/epilot/models/shared/relationitem.py index 20b199cce..982c9404f 100755 --- a/entity/src/epilot/models/shared/relationitem.py +++ b/entity/src/epilot/models/shared/relationitem.py @@ -4,16 +4,15 @@ import dataclasses from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class RelationItem: attribute: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attribute') }}) entity_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('entity_id') }}) - tags: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) + tags: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_tags'), 'exclude': lambda f: f is None }}) reverse: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reverse'), 'exclude': lambda f: f is None }}) r"""Whether this is a reverse relation""" diff --git a/entity/src/epilot/models/shared/repeatableattribute.py b/entity/src/epilot/models/shared/repeatableattribute.py index 6a8dcad02..ac60f5f1c 100755 --- a/entity/src/epilot/models/shared/repeatableattribute.py +++ b/entity/src/epilot/models/shared/repeatableattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class RepeatableAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class RepeatableAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -60,13 +58,12 @@ class RepeatableAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class RepeatableAttribute: r"""Repeatable (add N number of fields)""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[RepeatableAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/savedview.py b/entity/src/epilot/models/shared/savedview.py index 5d7971195..9e9b1d192 100755 --- a/entity/src/epilot/models/shared/savedview.py +++ b/entity/src/epilot/models/shared/savedview.py @@ -3,12 +3,26 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Optional, Union +from typing import Any, Dict, List, Optional, Union + +class SavedViewCreatedBy2Source(str, Enum): + SYSTEM = 'SYSTEM' + BLUEPRINT = 'BLUEPRINT' @dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SavedViewCreatedBy2: + r"""A system-created view""" + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + source: Optional[SavedViewCreatedBy2Source] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('source'), 'exclude': lambda f: f is None }}) + + + +@dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SavedViewCreatedBy1: r"""A user that created the view""" @@ -17,24 +31,22 @@ class SavedViewCreatedBy1: - @dataclasses.dataclass class SavedViewCreatedBy: pass @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SavedView: r"""A saved entity view""" - created_by: Union[SavedViewCreatedBy1, dict[str, Any]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) + created_by: Union[SavedViewCreatedBy1, SavedViewCreatedBy2] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""User-friendly identifier for the saved view""" - slug: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) + slug: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) r"""list of schemas a view can belong to""" - ui_config: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config') }}) - is_favorited_by: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isFavoritedBy'), 'exclude': lambda f: f is None }}) + ui_config: Dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config') }}) + is_favorited_by: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isFavoritedBy'), 'exclude': lambda f: f is None }}) r"""List of users (IDs) that have favorited the view""" org: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org'), 'exclude': lambda f: f is None }}) r"""Organisation ID a view belongs to""" diff --git a/entity/src/epilot/models/shared/savedviewitem.py b/entity/src/epilot/models/shared/savedviewitem.py index 07d9ec7b3..d6e10f17e 100755 --- a/entity/src/epilot/models/shared/savedviewitem.py +++ b/entity/src/epilot/models/shared/savedviewitem.py @@ -3,12 +3,26 @@ from __future__ import annotations import dataclasses from dataclasses_json import Undefined, dataclass_json +from enum import Enum from epilot import utils -from typing import Any, Optional, Union +from typing import Any, Dict, List, Optional, Union + +class SavedViewItemCreatedBy2Source(str, Enum): + SYSTEM = 'SYSTEM' + BLUEPRINT = 'BLUEPRINT' @dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SavedViewItemCreatedBy2: + r"""A system-created view""" + additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + source: Optional[SavedViewItemCreatedBy2Source] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('source'), 'exclude': lambda f: f is None }}) + + + +@dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SavedViewItemCreatedBy1: r"""A user that created the view""" @@ -17,27 +31,25 @@ class SavedViewItemCreatedBy1: - @dataclasses.dataclass class SavedViewItemCreatedBy: pass @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SavedViewItem: r"""A saved entity view""" - created_by: Union[SavedViewItemCreatedBy1, dict[str, Any]] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) + created_by: Union[SavedViewItemCreatedBy1, SavedViewItemCreatedBy2] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_by') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""User-friendly identifier for the saved view""" - slug: list[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) + slug: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slug') }}) r"""list of schemas a view can belong to""" - ui_config: dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config') }}) + ui_config: Dict[str, Any] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ui_config') }}) created_at: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Generated uuid for a saved view""" - is_favorited_by: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isFavoritedBy'), 'exclude': lambda f: f is None }}) + is_favorited_by: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isFavoritedBy'), 'exclude': lambda f: f is None }}) r"""List of users (IDs) that have favorited the view""" org: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org'), 'exclude': lambda f: f is None }}) r"""Organisation ID a view belongs to""" diff --git a/entity/src/epilot/models/shared/searchmappings.py b/entity/src/epilot/models/shared/searchmappings.py index 6d664078c..d150a3255 100755 --- a/entity/src/epilot/models/shared/searchmappings.py +++ b/entity/src/epilot/models/shared/searchmappings.py @@ -5,7 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional +from typing import Any, Dict, Optional class SearchMappingsType(str, Enum): KEYWORD = 'keyword' @@ -20,10 +20,9 @@ class SearchMappingsType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SearchMappings: - fields_: Optional[dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) + fields_: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) index: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) type: Optional[SearchMappingsType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/security.py b/entity/src/epilot/models/shared/security.py index 864a0d4a5..95a8719c2 100755 --- a/entity/src/epilot/models/shared/security.py +++ b/entity/src/epilot/models/shared/security.py @@ -5,7 +5,6 @@ from typing import Optional - @dataclasses.dataclass class Security: epilot_auth: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'http', 'sub_type': 'bearer', 'field_name': 'Authorization' }}) diff --git a/entity/src/epilot/models/shared/selectattribute.py b/entity/src/epilot/models/shared/selectattribute.py index f8b4f71ac..1d18811fc 100755 --- a/entity/src/epilot/models/shared/selectattribute.py +++ b/entity/src/epilot/models/shared/selectattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional, Union - +from typing import Any, List, Optional, Union @dataclasses.dataclass @@ -19,7 +18,6 @@ class SelectAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SelectAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -45,7 +43,6 @@ class SelectAttributeInfoHelpers: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SelectAttributeOptions1: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) @@ -54,7 +51,6 @@ class SelectAttributeOptions1: - @dataclasses.dataclass class SelectAttributeOptions: pass @@ -65,13 +61,12 @@ class SelectAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SelectAttribute: r"""Dropdown select""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) allow_any: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allow_any'), 'exclude': lambda f: f is None }}) r"""Allow arbitrary input values in addition to provided options""" constraints: Optional[SelectAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) @@ -97,7 +92,7 @@ class SelectAttribute: info_helpers: Optional[SelectAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) r"""A set of configurations meant to document and assist the user in filling the attribute.""" layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[Union[SelectAttributeOptions1, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + options: Optional[List[Union[SelectAttributeOptions1, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/sequenceattribute.py b/entity/src/epilot/models/shared/sequenceattribute.py index c2d067f4e..99317c667 100755 --- a/entity/src/epilot/models/shared/sequenceattribute.py +++ b/entity/src/epilot/models/shared/sequenceattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class SequenceAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SequenceAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class SequenceAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SequenceAttribute: r"""Sequence of unique identifiers""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[SequenceAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/statusattribute.py b/entity/src/epilot/models/shared/statusattribute.py index 6ca7ab746..deec3d7f5 100755 --- a/entity/src/epilot/models/shared/statusattribute.py +++ b/entity/src/epilot/models/shared/statusattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional, Union - +from typing import Any, List, Optional, Union @dataclasses.dataclass @@ -19,7 +18,6 @@ class StatusAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class StatusAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -45,7 +43,6 @@ class StatusAttributeInfoHelpers: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class StatusAttributeOptions2: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) @@ -56,7 +53,6 @@ class StatusAttributeOptions2: - @dataclasses.dataclass class StatusAttributeOptions: pass @@ -66,13 +62,12 @@ class StatusAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class StatusAttribute: r"""Status select""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[StatusAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. @@ -96,7 +91,7 @@ class StatusAttribute: info_helpers: Optional[StatusAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) r"""A set of configurations meant to document and assist the user in filling the attribute.""" layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[Union[str, StatusAttributeOptions2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + options: Optional[List[Union[str, StatusAttributeOptions2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/summaryattribute.py b/entity/src/epilot/models/shared/summaryattribute.py index a629a9ec6..e3cef4f93 100755 --- a/entity/src/epilot/models/shared/summaryattribute.py +++ b/entity/src/epilot/models/shared/summaryattribute.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SummaryAttribute: r"""Represents an expanded version of an attribute to be displayed in the list item summary. diff --git a/entity/src/epilot/models/shared/summaryfield.py b/entity/src/epilot/models/shared/summaryfield.py index 7e005154c..69b3a4656 100755 --- a/entity/src/epilot/models/shared/summaryfield.py +++ b/entity/src/epilot/models/shared/summaryfield.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SummaryField: r"""Summary Fields are displayed inside list view as a resume of the relation entity.""" diff --git a/entity/src/epilot/models/shared/tagsattribute.py b/entity/src/epilot/models/shared/tagsattribute.py index 34b590adf..c587c67d5 100755 --- a/entity/src/epilot/models/shared/tagsattribute.py +++ b/entity/src/epilot/models/shared/tagsattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class TagsAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TagsAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class TagsAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TagsAttribute: r"""Tags""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[TagsAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. @@ -78,7 +75,7 @@ class TagsAttribute: info_helpers: Optional[TagsAttributeInfoHelpers] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('info_helpers'), 'exclude': lambda f: f is None }}) r"""A set of configurations meant to document and assist the user in filling the attribute.""" layout: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('layout'), 'exclude': lambda f: f is None }}) - options: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + options: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) order: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) r"""Attribute sort order (ascending) in group""" placeholder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('placeholder'), 'exclude': lambda f: f is None }}) @@ -98,7 +95,7 @@ class TagsAttribute: r"""Render as a column in table views. When defined, overrides `hidden`""" sortable: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortable'), 'exclude': lambda f: f is None }}) r"""Allow sorting by this attribute in table views if `show_in_table` is true""" - suggestions: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggestions'), 'exclude': lambda f: f is None }}) + suggestions: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggestions'), 'exclude': lambda f: f is None }}) type: Optional[TagsAttributeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) value_formatter: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value_formatter'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/taxonomy.py b/entity/src/epilot/models/shared/taxonomy.py index 698366dee..1acb26816 100755 --- a/entity/src/epilot/models/shared/taxonomy.py +++ b/entity/src/epilot/models/shared/taxonomy.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Taxonomy: name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) diff --git a/entity/src/epilot/models/shared/taxonomyclassification.py b/entity/src/epilot/models/shared/taxonomyclassification.py index 3e28a7c16..fe3226888 100755 --- a/entity/src/epilot/models/shared/taxonomyclassification.py +++ b/entity/src/epilot/models/shared/taxonomyclassification.py @@ -6,17 +6,16 @@ from dataclasses_json import Undefined, dataclass_json from datetime import datetime from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxonomyClassification: name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) created_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) - parents: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) + parents: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parents'), 'exclude': lambda f: f is None }}) updated_at: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('updated_at'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/textattribute.py b/entity/src/epilot/models/shared/textattribute.py index 9e317ed64..ef3f9f67a 100755 --- a/entity/src/epilot/models/shared/textattribute.py +++ b/entity/src/epilot/models/shared/textattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class TextAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TextAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class TextAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TextAttribute: r"""Textarea or text input""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[TextAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/models/shared/userrelationattribute.py b/entity/src/epilot/models/shared/userrelationattribute.py index 9a678593e..3c7f3aac8 100755 --- a/entity/src/epilot/models/shared/userrelationattribute.py +++ b/entity/src/epilot/models/shared/userrelationattribute.py @@ -5,8 +5,7 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Any, Optional - +from typing import Any, List, Optional @dataclasses.dataclass @@ -19,7 +18,6 @@ class UserRelationAttributeConstraints: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UserRelationAttributeInfoHelpers: r"""A set of configurations meant to document and assist the user in filling the attribute.""" @@ -48,13 +46,12 @@ class UserRelationAttributeType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UserRelationAttribute: r"""User Relationship""" label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - purpose: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) + purpose: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_purpose'), 'exclude': lambda f: f is None }}) constraints: Optional[UserRelationAttributeConstraints] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('constraints'), 'exclude': lambda f: f is None }}) r"""A set of constraints applicable to the attribute. These constraints should and will be enforced by the attribute renderer. diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py index ecbedde5d..497389883 100755 --- a/entity/src/epilot/relations.py +++ b/entity/src/epilot/relations.py @@ -3,7 +3,7 @@ from .sdkconfiguration import SDKConfiguration from epilot import utils from epilot.models import errors, operations, shared -from typing import Optional, Union +from typing import List, Optional, Union class Relations: r"""Entity Relationships""" @@ -122,7 +122,7 @@ def get_relations(self, request: operations.GetRelationsRequest) -> operations.G if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[list[Union[shared.RelationItem, dict[str, Any]]]]) + out = utils.unmarshal_json(http_res.text, Optional[List[Union[shared.RelationItem, shared.RelationEntity]]]) res.get_relations_resp = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) diff --git a/entity/src/epilot/sdk.py b/entity/src/epilot/sdk.py index f89364459..979624ad9 100755 --- a/entity/src/epilot/sdk.py +++ b/entity/src/epilot/sdk.py @@ -12,6 +12,7 @@ from .taxonomy import Taxonomy from epilot import utils from epilot.models import shared +from typing import Dict class Epilot: r"""Entity API: Flexible data layer for epilot Entities. @@ -42,7 +43,7 @@ def __init__(self, security: shared.Security = None, server_idx: int = None, server_url: str = None, - url_params: dict[str, str] = None, + url_params: Dict[str, str] = None, client: requests_http.Session = None, retry_config: utils.RetryConfig = None ) -> None: @@ -55,7 +56,7 @@ def __init__(self, :param server_url: The server URL to use for all operations :type server_url: str :param url_params: Parameters to optionally template the server URL with - :type url_params: dict[str, str] + :type url_params: Dict[str, str] :param client: The requests.Session HTTP client to use for all operations :type client: requests_http.Session :param retry_config: The utils.RetryConfig to use globally diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 74725b313..a48d17a87 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -2,8 +2,9 @@ import requests from dataclasses import dataclass - +from typing import Dict, Tuple from .utils.retries import RetryConfig +from .utils import utils SERVERS = [ @@ -19,14 +20,14 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '1.27.1' - gen_version: str = '2.154.1' - user_agent: str = 'speakeasy-sdk/python 1.27.1 2.154.1 1.0.0 epilot-entity' + sdk_version: str = '2.0.0' + gen_version: str = '2.161.0' + user_agent: str = 'speakeasy-sdk/python 2.0.0 2.161.0 1.0.0 epilot-entity' retry_config: RetryConfig = None - def get_server_details(self) -> tuple[str, dict[str, str]]: + def get_server_details(self) -> Tuple[str, Dict[str, str]]: if self.server_url: - return self.server_url.removesuffix('/'), {} + return utils.remove_suffix(self.server_url, '/'), {} if self.server_idx is None: self.server_idx = 0 diff --git a/entity/src/epilot/utils/retries.py b/entity/src/epilot/utils/retries.py index 2138c1b5e..25f49a1f2 100755 --- a/entity/src/epilot/utils/retries.py +++ b/entity/src/epilot/utils/retries.py @@ -2,6 +2,7 @@ import random import time +from typing import List import requests @@ -32,9 +33,9 @@ def __init__(self, strategy: str, backoff: BackoffStrategy, retry_connection_err class Retries: config: RetryConfig - status_codes: list[str] + status_codes: List[str] - def __init__(self, config: RetryConfig, status_codes: list[str]): + def __init__(self, config: RetryConfig, status_codes: List[str]): self.config = config self.status_codes = status_codes diff --git a/entity/src/epilot/utils/utils.py b/entity/src/epilot/utils/utils.py index 4388f3b74..ccfad9f7a 100755 --- a/entity/src/epilot/utils/utils.py +++ b/entity/src/epilot/utils/utils.py @@ -9,7 +9,8 @@ from decimal import Decimal from email.message import Message from enum import Enum -from typing import Any, Callable, Optional, Tuple, Union, get_args, get_origin +from typing import (Any, Callable, Dict, List, Optional, Tuple, Union, + get_args, get_origin) from xmlrpc.client import boolean import dateutil.parser @@ -19,14 +20,14 @@ class SecurityClient: client: requests.Session - query_params: dict[str, str] = {} + query_params: Dict[str, str] = {} def __init__(self, client: requests.Session): self.client = client def request(self, method, url, **kwargs): params = kwargs.get('params', {}) - kwargs["params"] = self.query_params | params + kwargs["params"] = {**self.query_params, **params} return self.client.request(method, url, **kwargs) @@ -69,7 +70,7 @@ def _parse_security_option(client: SecurityClient, option: dataclass): client, metadata, getattr(option, opt_field.name)) -def _parse_security_scheme(client: SecurityClient, scheme_metadata: dict, scheme: any): +def _parse_security_scheme(client: SecurityClient, scheme_metadata: Dict, scheme: any): scheme_type = scheme_metadata.get('type') sub_type = scheme_metadata.get('sub_type') @@ -93,7 +94,7 @@ def _parse_security_scheme(client: SecurityClient, scheme_metadata: dict, scheme client, scheme_metadata, scheme_metadata, scheme) -def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: dict, security_metadata: dict, value: any): +def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: Dict, security_metadata: Dict, value: any): scheme_type = scheme_metadata.get('type') sub_type = scheme_metadata.get('sub_type') @@ -145,7 +146,7 @@ def _parse_basic_auth_scheme(client: SecurityClient, scheme: dataclass): def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass, - gbls: dict[str, dict[str, dict[str, Any]]] = None) -> str: + gbls: Dict[str, Dict[str, Dict[str, Any]]] = None) -> str: path_param_fields: Tuple[Field, ...] = fields(clazz) for field in path_param_fields: request_metadata = field.metadata.get('request') @@ -174,16 +175,16 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass '{' + key + '}', value, 1) else: if param_metadata.get('style', 'simple') == 'simple': - if isinstance(param, list): - pp_vals: list[str] = [] + if isinstance(param, List): + pp_vals: List[str] = [] for pp_val in param: if pp_val is None: continue pp_vals.append(_val_to_string(pp_val)) path = path.replace( '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - elif isinstance(param, dict): - pp_vals: list[str] = [] + elif isinstance(param, Dict): + pp_vals: List[str] = [] for pp_key in param: if param[pp_key] is None: continue @@ -196,7 +197,7 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass path = path.replace( '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) elif not isinstance(param, (str, int, float, complex, bool, Decimal)): - pp_vals: list[str] = [] + pp_vals: List[str] = [] param_fields: Tuple[Field, ...] = fields(param) for param_field in param_fields: param_value_metadata = param_field.metadata.get( @@ -222,14 +223,14 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass path = path.replace( '{' + param_metadata.get('field_name', field.name) + '}', _val_to_string(param), 1) - return server_url.removesuffix("/") + path + return remove_suffix(server_url, '/') + path def is_optional(field): return get_origin(field) is Union and type(None) in get_args(field) -def template_url(url_with_params: str, params: dict[str, str]) -> str: +def template_url(url_with_params: str, params: Dict[str, str]) -> str: for key, value in params.items(): url_with_params = url_with_params.replace( '{' + key + '}', value) @@ -237,9 +238,9 @@ def template_url(url_with_params: str, params: dict[str, str]) -> str: return url_with_params -def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[str, dict[str, Any]]] = None) -> dict[ - str, list[str]]: - params: dict[str, list[str]] = {} +def get_query_params(clazz: type, query_params: dataclass, gbls: Dict[str, Dict[str, Dict[str, Any]]] = None) -> Dict[ + str, List[str]]: + params: Dict[str, List[str]] = {} param_fields: Tuple[Field, ...] = fields(clazz) for field in param_fields: @@ -269,24 +270,24 @@ def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[ else: style = metadata.get('style', 'form') if style == 'deepObject': - params = params | _get_deep_object_query_params( - metadata, f_name, value) + params = {**params, **_get_deep_object_query_params( + metadata, f_name, value)} elif style == 'form': - params = params | _get_delimited_query_params( - metadata, f_name, value, ",") + params = {**params, **_get_delimited_query_params( + metadata, f_name, value, ",")} elif style == 'pipeDelimited': - params = params | _get_delimited_query_params( - metadata, f_name, value, "|") + params = {**params, **_get_delimited_query_params( + metadata, f_name, value, "|")} else: raise Exception('not yet implemented') return params -def get_headers(headers_params: dataclass) -> dict[str, str]: +def get_headers(headers_params: dataclass) -> Dict[str, str]: if headers_params is None: return {} - headers: dict[str, str] = {} + headers: Dict[str, str] = {} param_fields: Tuple[Field, ...] = fields(headers_params) for field in param_fields: @@ -303,8 +304,8 @@ def get_headers(headers_params: dataclass) -> dict[str, str]: return headers -def _get_serialized_params(metadata: dict, field_name: str, obj: any) -> dict[str, str]: - params: dict[str, str] = {} +def _get_serialized_params(metadata: Dict, field_name: str, obj: any) -> Dict[str, str]: + params: Dict[str, str] = {} serialization = metadata.get('serialization', '') if serialization == 'json': @@ -313,8 +314,8 @@ def _get_serialized_params(metadata: dict, field_name: str, obj: any) -> dict[st return params -def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> dict[str, list[str]]: - params: dict[str, list[str]] = {} +def _get_deep_object_query_params(metadata: Dict, field_name: str, obj: any) -> Dict[str, List[str]]: + params: Dict[str, List[str]] = {} if obj is None: return params @@ -330,7 +331,7 @@ def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> if obj_val is None: continue - if isinstance(obj_val, list): + if isinstance(obj_val, List): for val in obj_val: if val is None: continue @@ -348,12 +349,12 @@ def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> params[ f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ _val_to_string(obj_val)] - elif isinstance(obj, dict): + elif isinstance(obj, Dict): for key, value in obj.items(): if value is None: continue - if isinstance(value, list): + if isinstance(value, List): for val in value: if val is None: continue @@ -379,8 +380,8 @@ def _get_query_param_field_name(obj_field: Field) -> str: return obj_param_metadata.get("field_name", obj_field.name) -def _get_delimited_query_params(metadata: dict, field_name: str, obj: any, delimiter: str) -> dict[ - str, list[str]]: +def _get_delimited_query_params(metadata: Dict, field_name: str, obj: any, delimiter: str) -> Dict[ + str, List[str]]: return _populate_form(field_name, metadata.get("explode", True), obj, _get_query_param_field_name, delimiter) @@ -424,7 +425,7 @@ def serialize_request_body(request: dataclass, request_field_name: str, nullable request_val) -def serialize_content_type(field_name: str, media_type: str, request: dataclass, encoder=None) -> Tuple[str, any, list[list[any]]]: +def serialize_content_type(field_name: str, media_type: str, request: dataclass, encoder=None) -> Tuple[str, any, List[List[any]]]: if re.match(r'(application|text)\/.*?\+*json.*', media_type) is not None: return media_type, marshal_json(request, encoder), None if re.match(r'multipart\/.*', media_type) is not None: @@ -440,8 +441,8 @@ def serialize_content_type(field_name: str, media_type: str, request: dataclass, f"invalid request body type {type(request)} for mediaType {media_type}") -def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, any, list[list[any]]]: - form: list[list[any]] = [] +def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, any, List[List[any]]]: + form: List[List[any]] = [] request_fields = fields(request) for field in request_fields: @@ -482,7 +483,7 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, else: field_name = field_metadata.get( "field_name", field.name) - if isinstance(val, list): + if isinstance(val, List): for value in val: if value is None: continue @@ -493,8 +494,8 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, return media_type, None, form -def serialize_dict(original: dict, explode: bool, field_name, existing: Optional[dict[str, list[str]]]) -> dict[ - str, list[str]]: +def serialize_dict(original: Dict, explode: bool, field_name, existing: Optional[Dict[str, List[str]]]) -> Dict[ + str, List[str]]: if existing is None: existing = [] @@ -514,8 +515,8 @@ def serialize_dict(original: dict, explode: bool, field_name, existing: Optional return existing -def serialize_form_data(field_name: str, data: dataclass) -> dict[str, any]: - form: dict[str, list[str]] = {} +def serialize_form_data(field_name: str, data: dataclass) -> Dict[str, any]: + form: Dict[str, List[str]] = {} if is_dataclass(data): for field in fields(data): @@ -533,12 +534,12 @@ def serialize_form_data(field_name: str, data: dataclass) -> dict[str, any]: form[field_name] = [marshal_json(val)] else: if metadata.get('style', 'form') == 'form': - form = form | _populate_form( - field_name, metadata.get('explode', True), val, _get_form_field_name, ",") + form = {**form, **_populate_form( + field_name, metadata.get('explode', True), val, _get_form_field_name, ",")} else: raise Exception( f'Invalid form style for field {field.name}') - elif isinstance(data, dict): + elif isinstance(data, Dict): for key, value in data.items(): form[key] = [_val_to_string(value)] else: @@ -557,8 +558,8 @@ def _get_form_field_name(obj_field: Field) -> str: def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_func: Callable, delimiter: str) -> \ - dict[str, list[str]]: - params: dict[str, list[str]] = {} + Dict[str, List[str]]: + params: Dict[str, List[str]] = {} if obj is None: return params @@ -584,7 +585,7 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f if len(items) > 0: params[field_name] = [delimiter.join(items)] - elif isinstance(obj, dict): + elif isinstance(obj, Dict): items = [] for key, value in obj.items(): if value is None: @@ -597,7 +598,7 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f if len(items) > 0: params[field_name] = [delimiter.join(items)] - elif isinstance(obj, list): + elif isinstance(obj, List): items = [] for value in obj: @@ -651,7 +652,7 @@ def _serialize_header(explode: bool, obj: any) -> str: if len(items) > 0: return ','.join(items) - elif isinstance(obj, dict): + elif isinstance(obj, Dict): items = [] for key, value in obj.items(): @@ -666,7 +667,7 @@ def _serialize_header(explode: bool, obj: any) -> str: if len(items) > 0: return ','.join([str(item) for item in items]) - elif isinstance(obj, list): + elif isinstance(obj, List): items = [] for value in obj: @@ -779,7 +780,7 @@ def decimaldecoder(val): def map_encoder(optional: bool, value_encoder: Callable): - def map_encode(val: dict): + def map_encode(val: Dict): if optional and val is None: return None @@ -793,7 +794,7 @@ def map_encode(val: dict): def map_decoder(value_decoder: Callable): - def map_decode(val: dict): + def map_decode(val: Dict): decoded = {} for key, value in val.items(): decoded[key] = value_decoder(value) @@ -804,7 +805,7 @@ def map_decode(val: dict): def list_encoder(optional: bool, value_encoder: Callable): - def list_encode(val: list): + def list_encode(val: List): if optional and val is None: return None @@ -818,7 +819,7 @@ def list_encode(val: list): def list_decoder(value_decoder: Callable): - def list_decode(val: list): + def list_decode(val: List): decoded = [] for value in val: decoded.append(value_decoder(value)) @@ -846,7 +847,7 @@ def _val_to_string(val): return str(val) -def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: dict[str, dict[str, dict[str, Any]]]): +def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: Dict[str, Dict[str, Dict[str, Any]]]): if value is None and gbls is not None: if 'parameters' in gbls: if param_type in gbls['parameters']: @@ -863,3 +864,9 @@ def decode_fx(obj): kls = getattr(sys.modules['sdk.models.shared'], obj[field_name]) return unmarshal_json(json.dumps(obj), kls) return decode_fx + + +def remove_suffix(input_string, suffix): + if suffix and input_string.endswith(suffix): + return input_string[:-len(suffix)] + return input_string From 7e8d904d9686ac728471002cedfa50c419a61b11 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 21 Oct 2023 01:12:46 +0000 Subject: [PATCH 49/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.104.0 --- entity/RELEASES.md | 10 +- .../models/operations/getrelationsrequest.md | 4 + entity/docs/sdks/activity/README.md | 4 +- entity/docs/sdks/entities/README.md | 84 +++++++------- entity/docs/sdks/relations/README.md | 32 +++--- entity/docs/sdks/savedviews/README.md | 10 +- entity/docs/sdks/schemas/README.md | 108 +++++++----------- entity/docs/sdks/taxonomy/README.md | 6 +- entity/gen.yaml | 13 ++- entity/setup.py | 2 +- .../epilot/models/operations/getrelations.py | 8 ++ entity/src/epilot/sdkconfiguration.py | 6 +- entity/src/epilot/utils/utils.py | 20 ++++ 13 files changed, 167 insertions(+), 140 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 923f69454..fb154a454 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -364,4 +364,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.101.0 (2.161.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v2.0.0] entity \ No newline at end of file +- [python v2.0.0] entity + +## 2023-10-21 01:12:09 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.104.0 (2.169.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v2.1.0] entity \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsrequest.md b/entity/docs/models/operations/getrelationsrequest.md index b0b69507e..c4fc7b941 100755 --- a/entity/docs/models/operations/getrelationsrequest.md +++ b/entity/docs/models/operations/getrelationsrequest.md @@ -5,7 +5,11 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to exclude schemas | | +| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | | `id` | *str* | :heavy_check_mark: | Entity id | | | `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | +| `include_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to only include schemas | | +| `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | | `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/sdks/activity/README.md b/entity/docs/sdks/activity/README.md index 6c62f1537..cb90e9c81 100755 --- a/entity/docs/sdks/activity/README.md +++ b/entity/docs/sdks/activity/README.md @@ -78,13 +78,13 @@ req = operations.CreateActivityRequest( activity=shared.Activity( message='{{caller}} did something with {{entity payload.entity.id}}.', payload={ - "entity": 'Tricycle', + "entity": 'string', }, title='My custom activity', type='MyCustomActivity', ), entities=[ - '25acc1fe-2b8d-4182-9c2f-2569c1faffc1', + 'cf25acc1-fe2b-48d1-825c-2f2569c1faff', ], ) diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 3c8bf6337..2fe1559d8 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -102,18 +102,18 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( entity=shared.Entity( additional_properties={ - "_owners": 'Industrial', - "_schema": 'Implementation', - "_tags": 'Future', - "_created_at": 'Southeast', - "_updated_at": 'Tandem', - "_acl": 'male', - "_id": 'North', - "_org": 'Beach', + "_schema": 'string', + "_tags": 'string', + "_created_at": 'string', + "_updated_at": 'string', + "_acl": 'string', + "_id": 'string', + "_org": 'string', + "_owners": 'string', }, acl=shared.EntityACL( additional_properties={ - "Fresh": 'lavender', + "key": 'string', }, delete=[ 'o', @@ -151,7 +151,7 @@ req = operations.CreateEntityRequest( ], schema='contact', tags=[ - 'than', + 'string', ], ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', @@ -373,18 +373,18 @@ s = epilot.Epilot( req = operations.PatchEntityRequest( entity=shared.Entity( additional_properties={ - "_tags": 'fuchsia', - "_created_at": 'Account', - "_updated_at": 'engage', - "_acl": 'Cis', - "_id": 'solutions', - "_org": 'founder', - "_owners": 'Southeast', - "_schema": 'Cab', + "_created_at": 'string', + "_updated_at": 'string', + "_acl": 'string', + "_id": 'string', + "_org": 'string', + "_owners": 'string', + "_schema": 'string', + "_tags": 'string', }, acl=shared.EntityACL( additional_properties={ - "Italy": 'potentially', + "key": 'string', }, delete=[ 'o', @@ -422,11 +422,11 @@ req = operations.PatchEntityRequest( ], schema='contact', tags=[ - 'Multigender', + 'string', ], ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - id='b72319d9-e429-40d1-9da9-e1f40d7c71a7', + id='cd6dc474-9915-44f5-99d5-806e999b7231', slug='contact', ) @@ -605,18 +605,18 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( entity=shared.Entity( additional_properties={ - "_id": 'Hartmann', - "_org": 'invoice', - "_owners": 'fathom', - "_schema": 'Nepal', - "_tags": 'indexing', - "_created_at": 'male', - "_updated_at": 'Profound', - "_acl": 'policy', + "_schema": 'string', + "_tags": 'string', + "_created_at": 'string', + "_updated_at": 'string', + "_acl": 'string', + "_id": 'string', + "_org": 'string', + "_owners": 'string', }, acl=shared.EntityACL( additional_properties={ - "Southwest": 'Avon', + "key": 'string', }, delete=[ 'o', @@ -654,11 +654,11 @@ req = operations.UpdateEntityRequest( ], schema='contact', tags=[ - 'Volvo', + 'string', ], ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - id='74462a98-e27f-4fce-b6a4-e496163b217a', + id='2d5d17df-5520-4987-bd5a-6b1d12df7446', slug='contact', ) @@ -711,18 +711,18 @@ req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( entity=shared.Entity( additional_properties={ - "_schema": 'West', - "_tags": 'close', - "_created_at": 'Infrastructure', - "_updated_at": 'music', - "_acl": 'astride', - "_id": 'Designer', - "_org": 'strategic', - "_owners": 'along', + "_acl": 'string', + "_id": 'string', + "_org": 'string', + "_owners": 'string', + "_schema": 'string', + "_tags": 'string', + "_created_at": 'string', + "_updated_at": 'string', }, acl=shared.EntityACL( additional_properties={ - "Rap": 'Virtual', + "key": 'string', }, delete=[ 'o', @@ -760,7 +760,7 @@ req = operations.UpsertEntityRequest( ], schema='contact', tags=[ - 'Home', + 'string', ], ), unique_key=[ diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index 0891129aa..a2a5dc114 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -34,14 +34,14 @@ req = operations.AddRelationsRequest( request_body=[ shared.RelationItem( tags=[ - 'Forward', + 'string', ], - attribute='Pickup', - entity_id='1d83d924-8b56-4499-9f66-0d593cfe3d00', + attribute='string', + entity_id='acd6b1d8-3d92-448b-9649-9df660d593cf', ), ], activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - id='6d87e69d-98cd-409b-b6d3-0b52c3610877', + id='e3d006d8-7e69-4d98-8d09-bf6d30b52c36', slug='contact', ) @@ -82,9 +82,9 @@ s = epilot.Epilot( req = operations.DeleteRelationRequest( activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - attribute='compressing', - entity_id='Representative', - id='cd911519-f5b7-47b8-95b9-c58577ae4d21', + attribute='string', + entity_id='string', + id='84afcd91-1519-4f5b-b7b8-55b9c58577ae', slug='contact', ) @@ -126,9 +126,9 @@ s = epilot.Epilot( req = operations.GetRelatedEntitiesCountRequest( exclude_schemas=[ - 'Tuna', + 'string', ], - id='515de5fe-136e-44ad-8ca5-7656a6a8afba', + id='3a515de5-fe13-46e4-ad0c-a57656a6a8af', slug='contact', ) @@ -173,7 +173,13 @@ s = epilot.Epilot( ) req = operations.GetRelationsRequest( + exclude_schemas=[ + 'contact', + ], id='e642d6bf-f2f7-41f9-8aa4-db0ec78f30e6', + include_schemas=[ + 'contact', + ], slug='contact', ) @@ -265,13 +271,13 @@ s = epilot.Epilot( req = operations.UpdateRelationRequest( request_body=operations.UpdateRelationRequestBody( tags=[ - 'Androgyne', + 'string', ], ), activity_id='01F130Q52Q6MWSNS8N2AVXV4JN', - attribute='male', - entity_id='Account', - id='ff6a74da-3b01-4c38-94f8-c4b226143d8a', + attribute='string', + entity_id='string', + id='90bd69bf-f6a7-44da-bb01-c3854f8c4b22', slug='contact', ) diff --git a/entity/docs/sdks/savedviews/README.md b/entity/docs/sdks/savedviews/README.md index 7ff011c65..574656ad7 100755 --- a/entity/docs/sdks/savedviews/README.md +++ b/entity/docs/sdks/savedviews/README.md @@ -44,8 +44,8 @@ req = shared.SavedView( 'contact', ], ui_config={ - "filters": 'Cyclocross', - "table_layout": 'Plastic', + "filters": 'string', + "table_layout": 'string', }, ) @@ -237,11 +237,11 @@ req = operations.UpdateSavedViewRequest( 'contact', ], ui_config={ - "table_layout": 'red', - "filters": 'Car', + "filters": 'string', + "table_layout": 'string', }, ), - id='92cd4781-664d-4f55-b084-1d72e4e501ca', + id='203092cd-4781-4664-9f55-b0841d72e4e5', ) res = s.saved_views.update_saved_view(req) diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index 466216ce2..ba9855f0a 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -268,99 +268,99 @@ req = operations.PutSchemaRequest( info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='channels', + label='string', layout='full_width', - name='exploit', + name='string', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '6bf8fcc1-de0f-432d-a571-5210cf504680', + '535d6bf8-fcc1-4de0-b32d-65715210cf50', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='till', + label='string', layout='full_width', - name='grill', + name='string', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - 'fd6bef20-dd28-47b6-95b3-e0e28c6d1668', + '4680eaf6-fd6b-4ef2-8dd2-87b615b3e0e2', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='discrete', + label='string', layout='full_width', - name='Unbranded', + name='string', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '4eb242b7-20a7-4fd0-81cb-030766bc3807', + '8c6d1668-543e-44eb-a42b-720a7fd081cb', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='radical', + label='string', layout='full_width', - name='compressing', + name='string', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '37b1710c-2601-4905-a25f-bb37949e5c67', + '030766bc-3807-45c8-837b-1710c2601905', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='firmware', + label='string', layout='full_width', - name='IP', + name='string', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '47c7479d-9c56-40ea-b969-366d774fa49a', + 'e25fbb37-949e-45c6-b657-647c7479d9c5', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='voluptatem', + label='string', layout='full_width', - name='withdrawal', + name='string', order=0, setting_flag='MY_SETTING', ), shared.TextAttribute( purpose=[ - '19da9b26-82a9-4ba9-8c09-53674af53c32', + '60ea7969-366d-4774-ba49-a55907519da9', ], constraints=shared.TextAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', info_helpers=shared.TextAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='Corporate', + label='string', layout='full_width', - name='synthesize', + name='string', order=0, setting_flag='MY_SETTING', ), @@ -368,24 +368,21 @@ req = operations.PutSchemaRequest( capabilities=[ shared.EntityCapability( purpose=[ - '3faa88fa-b246-43c7-80e7-5fefd4fb709f', + 'b2682a9b-a9cc-4095-b674-af53c32a28a3', ], attributes=[ - shared.StatusAttribute( + shared.PartnerOrganisationAttribute( purpose=[ - '3acc8e6b-9335-4e75-97f7-7f7639161823', + 'aa88fab2-463c-4780-a75f-efd4fb709f43', ], - constraints=shared.StatusAttributeConstraints(), + constraints=shared.PartnerOrganisationAttributeConstraints(), feature_flag='FF_MY_FEATURE_FLAG', - info_helpers=shared.StatusAttributeInfoHelpers( + info_helpers=shared.PartnerOrganisationAttributeInfoHelpers( hint_tooltip_placement='top', ), - label='analyzer', + label='string', layout='full_width', - name='Classical', - options=[ - 'Lamborghini', - ], + name='string', order=0, setting_flag='MY_SETTING', ), @@ -397,7 +394,7 @@ req = operations.PutSchemaRequest( ui_hooks=[ shared.EntityCapabilityUIHooks( additional_properties={ - "newton": 'hacking', + "key": 'string', }, component='PricingItems', hook='EntityDetailsV2:Tab', @@ -416,7 +413,7 @@ req = operations.PutSchemaRequest( ), ], dialog_config={ - "North": 'Kia', + "key": 'string', }, draft=False, enable_setting=[ @@ -436,7 +433,7 @@ req = operations.PutSchemaRequest( explicit_search_mappings={ "image": shared.SearchMappings( fields_={ - "HDD": 'engage', + "key": 'string', }, ), }, @@ -444,23 +441,23 @@ req = operations.PutSchemaRequest( group_settings=[ shared.EntitySchemaGroupSettings( purpose=[ - 'e87e0545-1ea9-476b-baa4-556cbb2f4955', + 'acc8e6b9-335e-475d-bf77-f76391618236', ], feature_flag='FF_MY_FEATURE_FLAG', id='', info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle(), - label='Orchestrator', + label='string', render_condition='_is_composite_price = "false"', setting_flag='MY_SETTING', ), shared.EntitySchemaGroupSettings( purpose=[ - 'f0c06824-2f55-46b2-8c16-cff63699539a', + '09a0d8c5-8211-4d87-949e-87e05451ea97', ], feature_flag='FF_MY_FEATURE_FLAG', id='', info_tooltip_title=shared.EntitySchemaGroupSettingsInfoTooltipTitle(), - label='Folk', + label='string', render_condition='_is_composite_price = "false"', setting_flag='MY_SETTING', ), @@ -468,7 +465,7 @@ req = operations.PutSchemaRequest( icon='person', layout_settings=shared.EntitySchemaLayoutSettings( additional_properties={ - "male": 'Health', + "key": 'string', }, ), name='Contact', @@ -477,16 +474,16 @@ req = operations.PutSchemaRequest( slug='contact', title_template='{{first_name}} {{last_name}}', ui_config=shared.EntitySchemaUIConfig( - shared.EntityDefaultCreate( - search_params={ - "Avon": 'marvelous', - }, - table_menu_options=shared.EntityDefaultCreateTableMenuOptions(), + shared.RedirectEntityView( + route='/app/pricing-hub/product/:entityId', ), shared.EntityViewDisabled(), list_item=shared.EntitySchemaUIConfigListItem( summary_attributes=[ - 'email', + shared.SummaryAttribute( + label='string', + value='string', + ), ], ), sharing=shared.EntitySchemaUIConfigSharing( @@ -495,27 +492,8 @@ req = operations.PutSchemaRequest( shared.RedirectEntityView( route='/app/pricing-hub/product/:entityId', ), - shared.EntityDefaultTable( - dropdown_items=[ - shared.EntityDefaultTableDropdownItems1( - entity='contact', - feature_flag='FF_MY_FEATURE_FLAG', - ), - ], - navbar_actions=[ - shared.EntityDefaultTableNavbarActions( - options=[ - shared.EntityDefaultTableNavbarActionsOptions( - label='invoice', - params=shared.EntityDefaultTableNavbarActionsOptionsParams(), - ), - ], - type='XML', - ), - ], - row_actions=[ - 'Mouse', - ], + shared.RedirectEntityView( + route='/app/pricing-hub/product/:entityId', ), ), ), diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index 59556e2cf..654fb6b17 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -104,7 +104,7 @@ req = operations.TaxonomiesClassificationsSearchRequest( '140d9b86-5e3a-4ede-b609-1ca17c7aaeae', ], ), - taxonomy_slug='Bicycle', + taxonomy_slug='string', ) res = s.taxonomy.taxonomies_classifications_search(req) @@ -143,7 +143,7 @@ s = epilot.Epilot( ) req = operations.TaxonomyAutocompleteRequest( - taxonomy_slug='Planner', + taxonomy_slug='string', ) res = s.taxonomy.taxonomy_autocomplete(req) @@ -204,7 +204,7 @@ req = operations.UpdateClassificationsForTaxonomyRequest( ), ], ), - taxonomy_slug='or', + taxonomy_slug='string', ) res = s.taxonomy.update_classifications_for_taxonomy(req) diff --git a/entity/gen.yaml b/entity/gen.yaml index 46bc0f3fa..a03e9ca0c 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,10 +1,11 @@ configVersion: 1.0.0 management: - docChecksum: f8fda659e78397d7d3ffdf366a682493 + docChecksum: 82907e4b42c145f2d0c1d69c446538c8 docVersion: 1.0.0 - speakeasyVersion: 1.101.0 - generationVersion: 2.161.0 + speakeasyVersion: 1.104.0 + generationVersion: 2.169.0 generation: + repoURL: https://github.com/epilot-dev/sdk-python.git sdkClassName: epilot sdkFlattening: true singleTagPerOp: false @@ -12,13 +13,15 @@ generation: features: python: additionalProperties: 0.1.0 - core: 3.0.2 + core: 3.3.0 globalSecurity: 2.82.0 globalServerURLs: 2.82.0 python: - version: 2.0.0 + version: 2.1.0 author: epilot description: Python Client SDK for Epilot flattenGlobalSecurity: false + installationURL: https://github.com/epilot-dev/sdk-python.git#subdirectory=entity maxMethodParams: 0 packageName: epilot-entity + repoSubDirectory: entity diff --git a/entity/setup.py b/entity/setup.py index 1db34ea21..f74c299e6 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="2.0.0", + version="2.1.0", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py index cca678e43..562e9e75c 100755 --- a/entity/src/epilot/models/operations/getrelations.py +++ b/entity/src/epilot/models/operations/getrelations.py @@ -14,10 +14,18 @@ class GetRelationsRequest: r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Type""" + exclude_schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'exclude_schemas', 'style': 'form', 'explode': False }}) + r"""Filter results to exclude schemas""" + from_: Optional[int] = dataclasses.field(default=0, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) + r"""Starting page number""" hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) r"""When true, expand relation items with full blown entities.""" include_reverse: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) r"""When true, includes reverse relations in response (other entities pointing to this entity)""" + include_schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'include_schemas', 'style': 'form', 'explode': False }}) + r"""Filter results to only include schemas""" + size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) + r"""Number of results to return per page""" diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index a48d17a87..e30e8f03b 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -20,9 +20,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '2.0.0' - gen_version: str = '2.161.0' - user_agent: str = 'speakeasy-sdk/python 2.0.0 2.161.0 1.0.0 epilot-entity' + sdk_version: str = '2.1.0' + gen_version: str = '2.169.0' + user_agent: str = 'speakeasy-sdk/python 2.1.0 2.169.0 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: diff --git a/entity/src/epilot/utils/utils.py b/entity/src/epilot/utils/utils.py index ccfad9f7a..3ab126104 100755 --- a/entity/src/epilot/utils/utils.py +++ b/entity/src/epilot/utils/utils.py @@ -759,6 +759,8 @@ def bigintencode(val: int): def bigintdecoder(val): + if isinstance(val, float): + raise ValueError(f"{val} is a float") return int(val) @@ -828,6 +830,24 @@ def list_decode(val: List): return list_decode +def union_encoder(all_encoders: Dict[str, Callable]): + def selective_encoder(val: any): + if type(val) in all_encoders: + return all_encoders[type(val)](val) + return val + return selective_encoder + +def union_decoder(all_decoders: List[Callable]): + def selective_decoder(val: any): + decoded = val + for decoder in all_decoders: + try: + decoded = decoder(val) + break + except (TypeError, ValueError): + continue + return decoded + return selective_decoder def get_field_name(name): def override(_, _field_name=name): From ee361d512b6eed51a3a490ff5cce3939feef1263 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Mon, 23 Oct 2023 01:14:52 +0000 Subject: [PATCH 50/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.104.0 --- entity/README.md | 1 + entity/RELEASES.md | 10 +++- .../operations/getrelationsv3request.md | 15 ++++++ .../operations/getrelationsv3response.md | 11 ++++ entity/docs/sdks/entities/README.md | 20 +++---- entity/docs/sdks/relations/README.md | 52 +++++++++++++++++++ entity/files.gen | 3 ++ entity/gen.yaml | 4 +- entity/setup.py | 2 +- .../src/epilot/models/operations/__init__.py | 3 +- .../models/operations/getrelationsv3.py | 43 +++++++++++++++ entity/src/epilot/relations.py | 33 ++++++++++++ entity/src/epilot/sdkconfiguration.py | 4 +- 13 files changed, 184 insertions(+), 17 deletions(-) create mode 100755 entity/docs/models/operations/getrelationsv3request.md create mode 100755 entity/docs/models/operations/getrelationsv3response.md create mode 100755 entity/src/epilot/models/operations/getrelationsv3.py diff --git a/entity/README.md b/entity/README.md index 748d57418..c0810c9fc 100755 --- a/entity/README.md +++ b/entity/README.md @@ -72,6 +72,7 @@ if res.activity_item is not None: * [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 ### [saved_views](docs/sdks/savedviews/README.md) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index fb154a454..b82e9562c 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -372,4 +372,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.104.0 (2.169.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v2.1.0] entity \ No newline at end of file +- [python v2.1.0] entity + +## 2023-10-23 01:14:22 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.104.0 (2.169.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v2.1.1] entity \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv3request.md b/entity/docs/models/operations/getrelationsv3request.md new file mode 100755 index 000000000..0472f748e --- /dev/null +++ b/entity/docs/models/operations/getrelationsv3request.md @@ -0,0 +1,15 @@ +# GetRelationsV3Request + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to exclude schemas | | +| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | +| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | +| `include_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to only include schemas | | +| `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv3response.md b/entity/docs/models/operations/getrelationsv3response.md new file mode 100755 index 000000000..9a7f44fba --- /dev/null +++ b/entity/docs/models/operations/getrelationsv3response.md @@ -0,0 +1,11 @@ +# GetRelationsV3Response + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `get_relations_resp_with_pagination` | [Optional[shared.GetRelationsRespWithPagination]](../../models/shared/getrelationsrespwithpagination.md) | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 2fe1559d8..0f96f40b4 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -102,14 +102,14 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( entity=shared.Entity( additional_properties={ - "_schema": 'string', - "_tags": 'string', - "_created_at": 'string', "_updated_at": 'string', "_acl": 'string', "_id": 'string', "_org": 'string', "_owners": 'string', + "_schema": 'string', + "_tags": 'string', + "_created_at": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -373,14 +373,14 @@ s = epilot.Epilot( req = operations.PatchEntityRequest( entity=shared.Entity( additional_properties={ + "_owners": 'string', + "_schema": 'string', + "_tags": 'string', "_created_at": 'string', "_updated_at": 'string', "_acl": 'string', "_id": 'string', "_org": 'string', - "_owners": 'string', - "_schema": 'string', - "_tags": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -605,14 +605,14 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( entity=shared.Entity( additional_properties={ - "_schema": 'string', - "_tags": 'string', "_created_at": 'string', "_updated_at": 'string', "_acl": 'string', "_id": 'string', "_org": 'string', "_owners": 'string', + "_schema": 'string', + "_tags": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -711,14 +711,14 @@ req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( entity=shared.Entity( additional_properties={ + "_created_at": 'string', + "_updated_at": 'string', "_acl": 'string', "_id": 'string', "_org": 'string', "_owners": 'string', "_schema": 'string', "_tags": 'string', - "_created_at": 'string', - "_updated_at": 'string', }, acl=shared.EntityACL( additional_properties={ diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index a2a5dc114..8f6933ee6 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -12,6 +12,7 @@ Entity Relationships * [get_related_entities_count](#get_related_entities_count) - getRelatedEntitiesCount * [get_relations](#get_relations) - getRelations * [get_relations_v2](#get_relations_v2) - getRelationsV2 +* [get_relations_v3](#get_relations_v3) - getRelationsV3 * [update_relation](#update_relation) - updateRelation ## add_relations @@ -252,6 +253,57 @@ if res.get_relations_resp_with_pagination is not None: **[operations.GetRelationsV2Response](../../models/operations/getrelationsv2response.md)** +## get_relations_v3 + +Returns 1st level direct relations for an entity with pagination. + +You can control whether to return the full entity or just the relation item with the `?hydrate` query param. + +Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. + + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.GetRelationsV3Request( + exclude_schemas=[ + 'contact', + ], + id='6e35e8b4-d75d-4f84-a79c-6a8b45571a04', + include_schemas=[ + 'contact', + ], + slug='contact', +) + +res = s.relations.get_relations_v3(req) + +if res.get_relations_resp_with_pagination is not None: + # handle response + pass +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `request` | [operations.GetRelationsV3Request](../../models/operations/getrelationsv3request.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.GetRelationsV3Response](../../models/operations/getrelationsv3response.md)** + + ## update_relation Updates an existing relation between two entities. diff --git a/entity/files.gen b/entity/files.gen index 541f34999..0b012adbe 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -35,6 +35,7 @@ src/epilot/models/operations/deleterelation.py src/epilot/models/operations/getrelatedentitiescount.py src/epilot/models/operations/getrelations.py src/epilot/models/operations/getrelationsv2.py +src/epilot/models/operations/getrelationsv3.py src/epilot/models/operations/updaterelation.py src/epilot/models/operations/createsavedview.py src/epilot/models/operations/deletesavedview.py @@ -160,6 +161,8 @@ docs/models/operations/getrelationsrequest.md docs/models/operations/getrelationsresponse.md docs/models/operations/getrelationsv2request.md docs/models/operations/getrelationsv2response.md +docs/models/operations/getrelationsv3request.md +docs/models/operations/getrelationsv3response.md docs/models/operations/updaterelationrequestbody.md docs/models/operations/updaterelationrequest.md docs/models/operations/updaterelationresponse.md diff --git a/entity/gen.yaml b/entity/gen.yaml index a03e9ca0c..bf50e0813 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,6 +1,6 @@ configVersion: 1.0.0 management: - docChecksum: 82907e4b42c145f2d0c1d69c446538c8 + docChecksum: 4f2bfdba964b95ce160b61f2cc75d523 docVersion: 1.0.0 speakeasyVersion: 1.104.0 generationVersion: 2.169.0 @@ -17,7 +17,7 @@ features: globalSecurity: 2.82.0 globalServerURLs: 2.82.0 python: - version: 2.1.0 + version: 2.1.1 author: epilot description: Python Client SDK for Epilot flattenGlobalSecurity: false diff --git a/entity/setup.py b/entity/setup.py index f74c299e6..b7f573203 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="2.1.0", + version="2.1.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/operations/__init__.py b/entity/src/epilot/models/operations/__init__.py index 456cf7794..fc4c6d68d 100755 --- a/entity/src/epilot/models/operations/__init__.py +++ b/entity/src/epilot/models/operations/__init__.py @@ -17,6 +17,7 @@ from .getrelatedentitiescount import * from .getrelations import * from .getrelationsv2 import * +from .getrelationsv3 import * from .getsavedview import * from .getschema import * from .getschemaversions import * @@ -39,4 +40,4 @@ from .updatesavedview import * from .upsertentity import * -__all__ = ["AddRelationsRequest","AddRelationsResponse","AttachActivityRequest","AttachActivityResponse","Autocomplete200ApplicationJSON","Autocomplete200ApplicationJSONResults","AutocompleteRequest","AutocompleteResponse","CreateActivityRequest","CreateActivityResponse","CreateEntityRequest","CreateEntityResponse","CreateSavedViewResponse","DeleteEntityRequest","DeleteEntityResponse","DeleteRelationRequest","DeleteRelationResponse","DeleteSavedViewRequest","DeleteSavedViewResponse","DeleteSchemaRequest","DeleteSchemaResponse","ExportEntitiesRequest","ExportEntitiesResponse","GetActivityRequest","GetActivityResponse","GetEntity200ApplicationJSON","GetEntityActivityFeed200ApplicationJSON","GetEntityActivityFeedRequest","GetEntityActivityFeedResponse","GetEntityRequest","GetEntityResponse","GetRelatedEntitiesCountRequest","GetRelatedEntitiesCountResponse","GetRelationsRequest","GetRelationsResponse","GetRelationsV2Request","GetRelationsV2Response","GetSavedView200ApplicationJSON","GetSavedViewRequest","GetSavedViewResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaVersions200ApplicationJSON","GetSchemaVersionsRequest","GetSchemaVersionsResponse","GetTaxonomyRequest","GetTaxonomyResponse","ImportEntitiesRequest","ImportEntitiesResponse","ListFavoriteViewsForUser200ApplicationJSON","ListFavoriteViewsForUserResponse","ListSavedViews200ApplicationJSON","ListSavedViewsResponse","ListSchemaBlueprints200ApplicationJSON","ListSchemaBlueprintsResponse","ListSchemas200ApplicationJSON","ListSchemasRequest","ListSchemasResponse","ListTaxonomies200ApplicationJSON","ListTaxonomiesResponse","ListTaxonomyClassificationsForSchema200ApplicationJSON","ListTaxonomyClassificationsForSchemaRequest","ListTaxonomyClassificationsForSchemaResponse","PatchEntityRequest","PatchEntityResponse","PutSchemaRequest","PutSchemaResponse","SearchEntitiesResponse","TaxonomiesClassificationsSearch200ApplicationJSON","TaxonomiesClassificationsSearchRequest","TaxonomiesClassificationsSearchRequestBody","TaxonomiesClassificationsSearchResponse","TaxonomyAutocomplete200ApplicationJSON","TaxonomyAutocompleteRequest","TaxonomyAutocompleteResponse","UpdateClassificationsForTaxonomy200ApplicationJSON","UpdateClassificationsForTaxonomy200ApplicationJSONDeleted","UpdateClassificationsForTaxonomyRequest","UpdateClassificationsForTaxonomyResponse","UpdateEntityRequest","UpdateEntityResponse","UpdateRelationRequest","UpdateRelationRequestBody","UpdateRelationResponse","UpdateSavedViewRequest","UpdateSavedViewResponse","UpsertEntityRequest","UpsertEntityRequestBody","UpsertEntityResponse"] +__all__ = ["AddRelationsRequest","AddRelationsResponse","AttachActivityRequest","AttachActivityResponse","Autocomplete200ApplicationJSON","Autocomplete200ApplicationJSONResults","AutocompleteRequest","AutocompleteResponse","CreateActivityRequest","CreateActivityResponse","CreateEntityRequest","CreateEntityResponse","CreateSavedViewResponse","DeleteEntityRequest","DeleteEntityResponse","DeleteRelationRequest","DeleteRelationResponse","DeleteSavedViewRequest","DeleteSavedViewResponse","DeleteSchemaRequest","DeleteSchemaResponse","ExportEntitiesRequest","ExportEntitiesResponse","GetActivityRequest","GetActivityResponse","GetEntity200ApplicationJSON","GetEntityActivityFeed200ApplicationJSON","GetEntityActivityFeedRequest","GetEntityActivityFeedResponse","GetEntityRequest","GetEntityResponse","GetRelatedEntitiesCountRequest","GetRelatedEntitiesCountResponse","GetRelationsRequest","GetRelationsResponse","GetRelationsV2Request","GetRelationsV2Response","GetRelationsV3Request","GetRelationsV3Response","GetSavedView200ApplicationJSON","GetSavedViewRequest","GetSavedViewResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaVersions200ApplicationJSON","GetSchemaVersionsRequest","GetSchemaVersionsResponse","GetTaxonomyRequest","GetTaxonomyResponse","ImportEntitiesRequest","ImportEntitiesResponse","ListFavoriteViewsForUser200ApplicationJSON","ListFavoriteViewsForUserResponse","ListSavedViews200ApplicationJSON","ListSavedViewsResponse","ListSchemaBlueprints200ApplicationJSON","ListSchemaBlueprintsResponse","ListSchemas200ApplicationJSON","ListSchemasRequest","ListSchemasResponse","ListTaxonomies200ApplicationJSON","ListTaxonomiesResponse","ListTaxonomyClassificationsForSchema200ApplicationJSON","ListTaxonomyClassificationsForSchemaRequest","ListTaxonomyClassificationsForSchemaResponse","PatchEntityRequest","PatchEntityResponse","PutSchemaRequest","PutSchemaResponse","SearchEntitiesResponse","TaxonomiesClassificationsSearch200ApplicationJSON","TaxonomiesClassificationsSearchRequest","TaxonomiesClassificationsSearchRequestBody","TaxonomiesClassificationsSearchResponse","TaxonomyAutocomplete200ApplicationJSON","TaxonomyAutocompleteRequest","TaxonomyAutocompleteResponse","UpdateClassificationsForTaxonomy200ApplicationJSON","UpdateClassificationsForTaxonomy200ApplicationJSONDeleted","UpdateClassificationsForTaxonomyRequest","UpdateClassificationsForTaxonomyResponse","UpdateEntityRequest","UpdateEntityResponse","UpdateRelationRequest","UpdateRelationRequestBody","UpdateRelationResponse","UpdateSavedViewRequest","UpdateSavedViewResponse","UpsertEntityRequest","UpsertEntityRequestBody","UpsertEntityResponse"] diff --git a/entity/src/epilot/models/operations/getrelationsv3.py b/entity/src/epilot/models/operations/getrelationsv3.py new file mode 100755 index 000000000..7c9eaa79a --- /dev/null +++ b/entity/src/epilot/models/operations/getrelationsv3.py @@ -0,0 +1,43 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from ..shared import getrelationsrespwithpagination as shared_getrelationsrespwithpagination +from typing import List, Optional + + +@dataclasses.dataclass +class GetRelationsV3Request: + id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) + r"""Entity id""" + slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + r"""Entity Type""" + exclude_schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'exclude_schemas', 'style': 'form', 'explode': False }}) + r"""Filter results to exclude schemas""" + from_: Optional[int] = dataclasses.field(default=0, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) + r"""Starting page number""" + hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) + r"""When true, expand relation items with full blown entities.""" + include_reverse: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) + r"""When true, includes reverse relations in response (other entities pointing to this entity)""" + include_schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'include_schemas', 'style': 'form', 'explode': False }}) + r"""Filter results to only include schemas""" + size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) + r"""Number of results to return per page""" + + + + +@dataclasses.dataclass +class GetRelationsV3Response: + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" + get_relations_resp_with_pagination: Optional[shared_getrelationsrespwithpagination.GetRelationsRespWithPagination] = dataclasses.field(default=None) + r"""Success""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" + + diff --git a/entity/src/epilot/relations.py b/entity/src/epilot/relations.py index 497389883..96c075caf 100755 --- a/entity/src/epilot/relations.py +++ b/entity/src/epilot/relations.py @@ -163,6 +163,39 @@ def get_relations_v2(self, request: operations.GetRelationsV2Request) -> operati return res + def get_relations_v3(self, request: operations.GetRelationsV3Request) -> operations.GetRelationsV3Response: + r"""getRelationsV3 + Returns 1st level direct relations for an entity with pagination. + + You can control whether to return the full entity or just the relation item with the `?hydrate` query param. + + Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param. + """ + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(operations.GetRelationsV3Request, base_url, '/v3/entity/{slug}/{id}/relations', request) + headers = {} + query_params = utils.get_query_params(operations.GetRelationsV3Request, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + + client = self.sdk_configuration.security_client + + http_res = client.request('GET', url, params=query_params, headers=headers) + content_type = http_res.headers.get('Content-Type') + + res = operations.GetRelationsV3Response(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[shared.GetRelationsRespWithPagination]) + res.get_relations_resp_with_pagination = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + + return res + + def update_relation(self, request: operations.UpdateRelationRequest) -> operations.UpdateRelationResponse: r"""updateRelation Updates an existing relation between two entities. diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index e30e8f03b..03d8300a5 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -20,9 +20,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '2.1.0' + sdk_version: str = '2.1.1' gen_version: str = '2.169.0' - user_agent: str = 'speakeasy-sdk/python 2.1.0 2.169.0 1.0.0 epilot-entity' + user_agent: str = 'speakeasy-sdk/python 2.1.1 2.169.0 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: From 2237e1a97e6f78eded41c1e4104a886a7445a786 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 24 Oct 2023 01:14:25 +0000 Subject: [PATCH 51/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.105.0 --- entity/RELEASES.md | 10 +++++++- entity/docs/models/shared/entityaction.md | 13 +++++++++++ .../docs/models/shared/entitydefaultcreate.md | 9 ++++---- .../entitydefaultcreatetablemenuoptions.md | 9 -------- .../docs/models/shared/entitydefaultedit.md | 11 ++++----- .../entitydefaultedittablemenuoptions.md | 9 -------- .../docs/models/shared/entitydefaulttable.md | 2 +- .../shared/entitydefaulttablerowactions.md | 17 ++++++++++++++ .../entityschemaitemuiconfiglistitem.md | 1 + .../shared/entityschemauiconfiglistitem.md | 1 + entity/docs/sdks/entities/README.md | 16 ++++++------- entity/docs/sdks/schemas/README.md | 8 +++++++ entity/files.gen | 5 ++-- entity/gen.yaml | 8 +++---- entity/setup.py | 2 +- entity/src/epilot/models/shared/__init__.py | 3 ++- .../src/epilot/models/shared/entityaction.py | 23 +++++++++++++++++++ .../models/shared/entitydefaultcreate.py | 10 -------- .../epilot/models/shared/entitydefaultedit.py | 10 -------- .../models/shared/entitydefaulttable.py | 8 ++++++- .../src/epilot/models/shared/entityschema.py | 2 ++ .../epilot/models/shared/entityschemaitem.py | 2 ++ entity/src/epilot/sdkconfiguration.py | 6 ++--- 23 files changed, 114 insertions(+), 71 deletions(-) create mode 100755 entity/docs/models/shared/entityaction.md delete mode 100755 entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md delete mode 100755 entity/docs/models/shared/entitydefaultedittablemenuoptions.md create mode 100755 entity/docs/models/shared/entitydefaulttablerowactions.md create mode 100755 entity/src/epilot/models/shared/entityaction.py diff --git a/entity/RELEASES.md b/entity/RELEASES.md index b82e9562c..9a4a28d5b 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -380,4 +380,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.104.0 (2.169.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v2.1.1] entity \ No newline at end of file +- [python v2.1.1] entity + +## 2023-10-24 01:13:56 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.105.0 (2.169.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v2.1.2] entity \ No newline at end of file diff --git a/entity/docs/models/shared/entityaction.md b/entity/docs/models/shared/entityaction.md new file mode 100755 index 000000000..f4e8286a0 --- /dev/null +++ b/entity/docs/models/shared/entityaction.md @@ -0,0 +1,13 @@ +# EntityAction + +An entity action configured from the entity schema + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `action` | *str* | :heavy_check_mark: | A unique action name | preview_file | +| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | visibility | +| `label` | *str* | :heavy_check_mark: | N/A | Preview File | +| `permission` | *Optional[str]* | :heavy_minus_sign: | Permission required to show the action.
If not provided, the action will be shown to all users.
| entity:edit | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreate.md b/entity/docs/models/shared/entitydefaultcreate.md index c7154b1ce..faef9e226 100755 --- a/entity/docs/models/shared/entitydefaultcreate.md +++ b/entity/docs/models/shared/entitydefaultcreate.md @@ -3,8 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `search_params` | Dict[str, *str*] | :heavy_minus_sign: | N/A | -| `table_menu_options` | [Optional[EntityDefaultCreateTableMenuOptions]](../../models/shared/entitydefaultcreatetablemenuoptions.md) | :heavy_minus_sign: | N/A | -| `view_type` | [Optional[EntityDefaultCreateViewType]](../../models/shared/entitydefaultcreateviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `search_params` | Dict[str, *str*] | :heavy_minus_sign: | N/A | +| `view_type` | [Optional[EntityDefaultCreateViewType]](../../models/shared/entitydefaultcreateviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md b/entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md deleted file mode 100755 index 045c545d2..000000000 --- a/entity/docs/models/shared/entitydefaultcreatetablemenuoptions.md +++ /dev/null @@ -1,9 +0,0 @@ -# EntityDefaultCreateTableMenuOptions - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultedit.md b/entity/docs/models/shared/entitydefaultedit.md index af949f786..1029ccfef 100755 --- a/entity/docs/models/shared/entitydefaultedit.md +++ b/entity/docs/models/shared/entitydefaultedit.md @@ -3,9 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `search_params` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | -| `summary_attributes` | List[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | email | -| `table_menu_options` | [Optional[EntityDefaultEditTableMenuOptions]](../../models/shared/entitydefaultedittablemenuoptions.md) | :heavy_minus_sign: | N/A | | -| `view_type` | [Optional[EntityDefaultEditViewType]](../../models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `search_params` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | +| `summary_attributes` | List[*str*] | :heavy_minus_sign: | List of attribute names that we show in the summary header | email | +| `view_type` | [Optional[EntityDefaultEditViewType]](../../models/shared/entitydefaulteditviewtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaultedittablemenuoptions.md b/entity/docs/models/shared/entitydefaultedittablemenuoptions.md deleted file mode 100755 index afa2a817e..000000000 --- a/entity/docs/models/shared/entitydefaultedittablemenuoptions.md +++ /dev/null @@ -1,9 +0,0 @@ -# EntityDefaultEditTableMenuOptions - - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `icon` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttable.md b/entity/docs/models/shared/entitydefaulttable.md index c5179825e..05dc8b09b 100755 --- a/entity/docs/models/shared/entitydefaulttable.md +++ b/entity/docs/models/shared/entitydefaulttable.md @@ -9,5 +9,5 @@ | `dropdown_items` | List[[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]](../../models/shared/entitydefaulttabledropdownitems.md)] | :heavy_minus_sign: | N/A | | `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | | `navbar_actions` | List[[EntityDefaultTableNavbarActions](../../models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | -| `row_actions` | List[*str*] | :heavy_minus_sign: | N/A | +| `row_actions` | List[[Union[str, EntityAction]](../../models/shared/entitydefaulttablerowactions.md)] | :heavy_minus_sign: | N/A | | `view_type` | [Optional[EntityDefaultTableViewType]](../../models/shared/entitydefaulttableviewtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttablerowactions.md b/entity/docs/models/shared/entitydefaulttablerowactions.md new file mode 100755 index 000000000..8e0a85ae0 --- /dev/null +++ b/entity/docs/models/shared/entitydefaulttablerowactions.md @@ -0,0 +1,17 @@ +# EntityDefaultTableRowActions + + +## Supported Types + +### + +```python +entityDefaultTableRowActions: str = /* values here */ +``` + +### EntityAction + +```python +entityDefaultTableRowActions: shared.EntityAction = /* values here */ +``` + diff --git a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md index 72921e7c9..1d309b11c 100755 --- a/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md +++ b/entity/docs/models/shared/entityschemaitemuiconfiglistitem.md @@ -5,4 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `quick_actions` | List[[EntityAction](../../models/shared/entityaction.md)] | :heavy_minus_sign: | N/A | | `summary_attributes` | List[[Union[SummaryAttribute, str]](../../models/shared/entityschemaitemuiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/models/shared/entityschemauiconfiglistitem.md b/entity/docs/models/shared/entityschemauiconfiglistitem.md index 6a0cf0342..b0f90aef6 100755 --- a/entity/docs/models/shared/entityschemauiconfiglistitem.md +++ b/entity/docs/models/shared/entityschemauiconfiglistitem.md @@ -5,4 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `quick_actions` | List[[EntityAction](../../models/shared/entityaction.md)] | :heavy_minus_sign: | N/A | | `summary_attributes` | List[[Union[SummaryAttribute, str]](../../models/shared/entityschemauiconfiglistitemsummaryattributes.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 0f96f40b4..0e714c31f 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -102,14 +102,14 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( entity=shared.Entity( additional_properties={ - "_updated_at": 'string', - "_acl": 'string', "_id": 'string', "_org": 'string', "_owners": 'string', "_schema": 'string', "_tags": 'string', "_created_at": 'string', + "_updated_at": 'string', + "_acl": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -373,14 +373,14 @@ s = epilot.Epilot( req = operations.PatchEntityRequest( entity=shared.Entity( additional_properties={ - "_owners": 'string', - "_schema": 'string', - "_tags": 'string', "_created_at": 'string', "_updated_at": 'string', "_acl": 'string', "_id": 'string', "_org": 'string', + "_owners": 'string', + "_schema": 'string', + "_tags": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -605,14 +605,14 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( entity=shared.Entity( additional_properties={ + "_schema": 'string', + "_tags": 'string', "_created_at": 'string', "_updated_at": 'string', "_acl": 'string', "_id": 'string', "_org": 'string', "_owners": 'string', - "_schema": 'string', - "_tags": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -711,7 +711,6 @@ req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( entity=shared.Entity( additional_properties={ - "_created_at": 'string', "_updated_at": 'string', "_acl": 'string', "_id": 'string', @@ -719,6 +718,7 @@ req = operations.UpsertEntityRequest( "_owners": 'string', "_schema": 'string', "_tags": 'string', + "_created_at": 'string', }, acl=shared.EntityACL( additional_properties={ diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index ba9855f0a..651eadd65 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -479,6 +479,14 @@ req = operations.PutSchemaRequest( ), shared.EntityViewDisabled(), list_item=shared.EntitySchemaUIConfigListItem( + quick_actions=[ + shared.EntityAction( + action='preview_file', + icon='visibility', + label='Preview File', + permission='entity:edit', + ), + ], summary_attributes=[ shared.SummaryAttribute( label='string', diff --git a/entity/files.gen b/entity/files.gen index 0b012adbe..0f217eaac 100755 --- a/entity/files.gen +++ b/entity/files.gen @@ -75,6 +75,7 @@ src/epilot/models/shared/savedviewitem.py src/epilot/models/shared/savedview.py src/epilot/models/shared/entityschemaitem.py src/epilot/models/shared/entitydefaulttable.py +src/epilot/models/shared/entityaction.py src/epilot/models/shared/redirectentityview.py src/epilot/models/shared/entityviewdisabled.py src/epilot/models/shared/entitydefaultedit.py @@ -266,17 +267,17 @@ docs/models/shared/entitydefaulttabledropdownitems.md docs/models/shared/entitydefaulttablenavbaractionsoptionsparams.md docs/models/shared/entitydefaulttablenavbaractionsoptions.md docs/models/shared/entitydefaulttablenavbaractions.md +docs/models/shared/entitydefaulttablerowactions.md docs/models/shared/entitydefaulttableviewtype.md docs/models/shared/entitydefaulttable.md +docs/models/shared/entityaction.md docs/models/shared/redirectentityviewviewtype.md docs/models/shared/redirectentityview.md docs/models/shared/entityviewdisabledviewtype.md docs/models/shared/entityviewdisabled.md -docs/models/shared/entitydefaultedittablemenuoptions.md docs/models/shared/entitydefaulteditviewtype.md docs/models/shared/entitydefaultedit.md docs/models/shared/summaryattribute.md -docs/models/shared/entitydefaultcreatetablemenuoptions.md docs/models/shared/entitydefaultcreateviewtype.md docs/models/shared/entitydefaultcreate.md docs/models/shared/searchmappingstype.md diff --git a/entity/gen.yaml b/entity/gen.yaml index bf50e0813..f302ca657 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,9 +1,9 @@ configVersion: 1.0.0 management: - docChecksum: 4f2bfdba964b95ce160b61f2cc75d523 + docChecksum: 98298ca31cb0b7762f9dda606bce4f1b docVersion: 1.0.0 - speakeasyVersion: 1.104.0 - generationVersion: 2.169.0 + speakeasyVersion: 1.105.0 + generationVersion: 2.169.3 generation: repoURL: https://github.com/epilot-dev/sdk-python.git sdkClassName: epilot @@ -17,7 +17,7 @@ features: globalSecurity: 2.82.0 globalServerURLs: 2.82.0 python: - version: 2.1.1 + version: 2.1.2 author: epilot description: Python Client SDK for Epilot flattenGlobalSecurity: false diff --git a/entity/setup.py b/entity/setup.py index b7f573203..7f21ae490 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="2.1.1", + version="2.1.2", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/shared/__init__.py b/entity/src/epilot/models/shared/__init__.py index 040279ace..8b60bddb1 100755 --- a/entity/src/epilot/models/shared/__init__.py +++ b/entity/src/epilot/models/shared/__init__.py @@ -14,6 +14,7 @@ from .dateattribute import * from .entity import * from .entityacl import * +from .entityaction import * from .entitycapability import * from .entitydefaultcreate import * from .entitydefaultedit import * @@ -61,4 +62,4 @@ from .textattribute import * from .userrelationattribute import * -__all__ = ["Activity","ActivityCallerContext","ActivityCallerContextEpilotAuth","ActivityCallerContextEpilotAuthToken","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","Entity","EntityACL","EntityCapability","EntityCapabilityUIHooks","EntityCapabilityUIHooksRequiredPermission","EntityDefaultCreate","EntityDefaultCreateTableMenuOptions","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditTableMenuOptions","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityItem","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntityOperationPayload","EntityOwner","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemLayoutSettings","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaLayoutSettings","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelatedEntitiesCount","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeActionsNewEntityItem","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationAttributeType","RelationEntity","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewCreatedBy2","SavedViewCreatedBy2Source","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SavedViewItemCreatedBy2","SavedViewItemCreatedBy2Source","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] +__all__ = ["Activity","ActivityCallerContext","ActivityCallerContextEpilotAuth","ActivityCallerContextEpilotAuthToken","ActivityItem","AddressRelationAttribute","AddressRelationAttributeConstraints","AddressRelationAttributeInfoHelpers","AddressRelationAttributeType","AutomationAttribute","AutomationAttributeConstraints","AutomationAttributeInfoHelpers","AutomationAttributeType","BooleanAttribute","BooleanAttributeConstraints","BooleanAttributeInfoHelpers","BooleanAttributeType","ClassificationsUpdate","ComputedAttribute","ComputedAttributeConstraints","ComputedAttributeInfoHelpers","ComputedAttributeType","ConsentAttribute","ConsentAttributeConstraints","ConsentAttributeInfoHelpers","ConsentAttributeType","CountryAttribute","CountryAttributeConstraints","CountryAttributeInfoHelpers","CountryAttributeType","CurrencyAttribute","CurrencyAttributeConstraints","CurrencyAttributeCurrency","CurrencyAttributeCurrency1","CurrencyAttributeInfoHelpers","CurrencyAttributeType","DateAttribute","DateAttributeConstraints","DateAttributeInfoHelpers","DateAttributeType","Entity","EntityACL","EntityAction","EntityCapability","EntityCapabilityUIHooks","EntityCapabilityUIHooksRequiredPermission","EntityDefaultCreate","EntityDefaultCreateViewType","EntityDefaultEdit","EntityDefaultEditViewType","EntityDefaultTable","EntityDefaultTableDropdownItems","EntityDefaultTableDropdownItems1","EntityDefaultTableDropdownItems1Type","EntityDefaultTableDropdownItems2","EntityDefaultTableDropdownItems2Type","EntityDefaultTableNavbarActions","EntityDefaultTableNavbarActionsOptions","EntityDefaultTableNavbarActionsOptionsParams","EntityDefaultTableRowActions","EntityDefaultTableViewType","EntityImportParams","EntityImportParamsS3Reference","EntityItem","EntityOperation","EntityOperationDiff","EntityOperationOperation","EntityOperationParams","EntityOperationPayload","EntityOwner","EntitySchema","EntitySchemaGroupSettings","EntitySchemaGroupSettingsInfoTooltipTitle","EntitySchemaItem","EntitySchemaItemGroupSettings","EntitySchemaItemGroupSettingsInfoTooltipTitle","EntitySchemaItemLayoutSettings","EntitySchemaItemSource","EntitySchemaItemUIConfig","EntitySchemaItemUIConfigCreateView","EntitySchemaItemUIConfigEditView","EntitySchemaItemUIConfigListItem","EntitySchemaItemUIConfigListItemSummaryAttributes","EntitySchemaItemUIConfigSharing","EntitySchemaItemUIConfigSingleView","EntitySchemaItemUIConfigTableView","EntitySchemaLayoutSettings","EntitySchemaUIConfig","EntitySchemaUIConfigCreateView","EntitySchemaUIConfigEditView","EntitySchemaUIConfigListItem","EntitySchemaUIConfigListItemSummaryAttributes","EntitySchemaUIConfigSharing","EntitySchemaUIConfigSingleView","EntitySchemaUIConfigTableView","EntitySearchParams","EntitySearchParamsAggs","EntitySearchResults","EntitySearchResultsAggregations","EntityViewDisabled","EntityViewDisabledViewType","FileAttribute","FileAttributeConstraints","FileAttributeDefaultAccessControl","FileAttributeInfoHelpers","FileAttributeType","GetRelatedEntitiesCount","GetRelationsRespWithPagination","InternalAttribute","InternalAttributeConstraints","InternalAttributeInfoHelpers","InternalAttributeType","InternalUserAttribute","InternalUserAttributeConstraints","InternalUserAttributeInfoHelpers","InternalUserAttributeType","InvitationEmailAttribute","InvitationEmailAttributeConstraints","InvitationEmailAttributeInfoHelpers","InvitationEmailAttributeType","LinkAttribute","LinkAttributeConstraints","LinkAttributeInfoHelpers","LinkAttributeType","MultiSelectAttribute","MultiSelectAttributeConstraints","MultiSelectAttributeInfoHelpers","MultiSelectAttributeOptions","MultiSelectAttributeOptions2","MultiSelectAttributeType","NumberAttribute","NumberAttributeConstraints","NumberAttributeInfoHelpers","NumberAttributeType","OrderedListAttribute","OrderedListAttributeConstraints","OrderedListAttributeInfoHelpers","OrderedListAttributeType","PartnerOrganisationAttribute","PartnerOrganisationAttributeConstraints","PartnerOrganisationAttributeInfoHelpers","PartnerOrganisationAttributeType","PartnerStatusAttribute","PartnerStatusAttributeConstraints","PartnerStatusAttributeInfoHelpers","PartnerStatusAttributeType","PaymentMethodRelationAttribute","PaymentMethodRelationAttributeConstraints","PaymentMethodRelationAttributeInfoHelpers","PaymentMethodRelationAttributeType","PurposeAttribute","PurposeAttributeConstraints","PurposeAttributeInfoHelpers","PurposeAttributeType","RedirectEntityView","RedirectEntityViewViewType","RelationAttribute","RelationAttributeActions","RelationAttributeActionsActionType","RelationAttributeActionsNewEntityItem","RelationAttributeConstraints","RelationAttributeDrawerSize","RelationAttributeEditMode","RelationAttributeInfoHelpers","RelationAttributeRelationAffinityMode","RelationAttributeRelationType","RelationAttributeSummaryFields","RelationAttributeType","RelationEntity","RelationItem","RepeatableAttribute","RepeatableAttributeConstraints","RepeatableAttributeInfoHelpers","RepeatableAttributeRelationAffinityMode","RepeatableAttributeType","SavedView","SavedViewCreatedBy","SavedViewCreatedBy1","SavedViewCreatedBy2","SavedViewCreatedBy2Source","SavedViewItem","SavedViewItemCreatedBy","SavedViewItemCreatedBy1","SavedViewItemCreatedBy2","SavedViewItemCreatedBy2Source","SearchMappings","SearchMappingsType","Security","SelectAttribute","SelectAttributeConstraints","SelectAttributeInfoHelpers","SelectAttributeOptions","SelectAttributeOptions1","SelectAttributeType","SequenceAttribute","SequenceAttributeConstraints","SequenceAttributeInfoHelpers","SequenceAttributeType","StatusAttribute","StatusAttributeConstraints","StatusAttributeInfoHelpers","StatusAttributeOptions","StatusAttributeOptions2","StatusAttributeType","SummaryAttribute","SummaryField","TagsAttribute","TagsAttributeConstraints","TagsAttributeInfoHelpers","TagsAttributeType","Taxonomy","TaxonomyClassification","TextAttribute","TextAttributeConstraints","TextAttributeInfoHelpers","TextAttributeType","UserRelationAttribute","UserRelationAttributeConstraints","UserRelationAttributeInfoHelpers","UserRelationAttributeType"] diff --git a/entity/src/epilot/models/shared/entityaction.py b/entity/src/epilot/models/shared/entityaction.py new file mode 100755 index 000000000..08c02cc2c --- /dev/null +++ b/entity/src/epilot/models/shared/entityaction.py @@ -0,0 +1,23 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from dataclasses_json import Undefined, dataclass_json +from epilot import utils +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class EntityAction: + r"""An entity action configured from the entity schema""" + action: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action') }}) + r"""A unique action name""" + label: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label') }}) + icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) + permission: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('permission'), 'exclude': lambda f: f is None }}) + r"""Permission required to show the action. + If not provided, the action will be shown to all users. + """ + + diff --git a/entity/src/epilot/models/shared/entitydefaultcreate.py b/entity/src/epilot/models/shared/entitydefaultcreate.py index 57c552550..9e92dcc8b 100755 --- a/entity/src/epilot/models/shared/entitydefaultcreate.py +++ b/entity/src/epilot/models/shared/entitydefaultcreate.py @@ -7,15 +7,6 @@ from epilot import utils from typing import Dict, Optional - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class EntityDefaultCreateTableMenuOptions: - icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) - label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label'), 'exclude': lambda f: f is None }}) - - - class EntityDefaultCreateViewType(str, Enum): DEFAULT = 'default' @@ -24,7 +15,6 @@ class EntityDefaultCreateViewType(str, Enum): @dataclasses.dataclass class EntityDefaultCreate: search_params: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) - table_menu_options: Optional[EntityDefaultCreateTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) view_type: Optional[EntityDefaultCreateViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaultedit.py b/entity/src/epilot/models/shared/entitydefaultedit.py index 93d6c09fc..1025a9992 100755 --- a/entity/src/epilot/models/shared/entitydefaultedit.py +++ b/entity/src/epilot/models/shared/entitydefaultedit.py @@ -7,15 +7,6 @@ from epilot import utils from typing import Dict, List, Optional - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class EntityDefaultEditTableMenuOptions: - icon: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('icon'), 'exclude': lambda f: f is None }}) - label: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label'), 'exclude': lambda f: f is None }}) - - - class EntityDefaultEditViewType(str, Enum): DEFAULT = 'default' @@ -26,7 +17,6 @@ class EntityDefaultEdit: search_params: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_params'), 'exclude': lambda f: f is None }}) summary_attributes: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) r"""List of attribute names that we show in the summary header""" - table_menu_options: Optional[EntityDefaultEditTableMenuOptions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table_menu_options'), 'exclude': lambda f: f is None }}) view_type: Optional[EntityDefaultEditViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py index 185ef4ba5..f841933fa 100755 --- a/entity/src/epilot/models/shared/entitydefaulttable.py +++ b/entity/src/epilot/models/shared/entitydefaulttable.py @@ -2,6 +2,7 @@ from __future__ import annotations import dataclasses +from ..shared import entityaction as shared_entityaction from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils @@ -69,6 +70,11 @@ class EntityDefaultTableNavbarActions: + +@dataclasses.dataclass +class EntityDefaultTableRowActions: + pass + class EntityDefaultTableViewType(str, Enum): DEFAULT = 'default' @@ -81,7 +87,7 @@ class EntityDefaultTable: enable_thumbnails: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_thumbnails'), 'exclude': lambda f: f is None }}) r"""Enable the thumbnail column""" navbar_actions: Optional[List[EntityDefaultTableNavbarActions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('navbar_actions'), 'exclude': lambda f: f is None }}) - row_actions: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('row_actions'), 'exclude': lambda f: f is None }}) + row_actions: Optional[List[Union[str, shared_entityaction.EntityAction]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('row_actions'), 'exclude': lambda f: f is None }}) view_type: Optional[EntityDefaultTableViewType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entityschema.py b/entity/src/epilot/models/shared/entityschema.py index 8626a8159..fd05902bf 100755 --- a/entity/src/epilot/models/shared/entityschema.py +++ b/entity/src/epilot/models/shared/entityschema.py @@ -10,6 +10,7 @@ from ..shared import countryattribute as shared_countryattribute from ..shared import currencyattribute as shared_currencyattribute from ..shared import dateattribute as shared_dateattribute +from ..shared import entityaction as shared_entityaction from ..shared import entitycapability as shared_entitycapability from ..shared import entitydefaultcreate as shared_entitydefaultcreate from ..shared import entitydefaultedit as shared_entitydefaultedit @@ -105,6 +106,7 @@ class EntitySchemaUIConfigListItemSummaryAttributes: @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaUIConfigListItem: + quick_actions: Optional[List[shared_entityaction.EntityAction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quick_actions'), 'exclude': lambda f: f is None }}) summary_attributes: Optional[List[Union[shared_summaryattribute.SummaryAttribute, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/entityschemaitem.py b/entity/src/epilot/models/shared/entityschemaitem.py index 789ec2491..b4f9a0ea3 100755 --- a/entity/src/epilot/models/shared/entityschemaitem.py +++ b/entity/src/epilot/models/shared/entityschemaitem.py @@ -10,6 +10,7 @@ from ..shared import countryattribute as shared_countryattribute from ..shared import currencyattribute as shared_currencyattribute from ..shared import dateattribute as shared_dateattribute +from ..shared import entityaction as shared_entityaction from ..shared import entitycapability as shared_entitycapability from ..shared import entitydefaultcreate as shared_entitydefaultcreate from ..shared import entitydefaultedit as shared_entitydefaultedit @@ -114,6 +115,7 @@ class EntitySchemaItemUIConfigListItemSummaryAttributes: @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntitySchemaItemUIConfigListItem: + quick_actions: Optional[List[shared_entityaction.EntityAction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quick_actions'), 'exclude': lambda f: f is None }}) summary_attributes: Optional[List[Union[shared_summaryattribute.SummaryAttribute, str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summary_attributes'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 03d8300a5..5f5625382 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -20,9 +20,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '2.1.1' - gen_version: str = '2.169.0' - user_agent: str = 'speakeasy-sdk/python 2.1.1 2.169.0 1.0.0 epilot-entity' + sdk_version: str = '2.1.2' + gen_version: str = '2.169.3' + user_agent: str = 'speakeasy-sdk/python 2.1.2 2.169.3 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: From bf6cd409279ca5b9e353e397be54e042b9a4b1b3 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 25 Oct 2023 01:14:19 +0000 Subject: [PATCH 52/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.107.0 --- entity/RELEASES.md | 10 +++++++++- entity/docs/sdks/entities/README.md | 10 +++++----- entity/gen.yaml | 8 ++++---- entity/setup.py | 2 +- entity/src/epilot/sdkconfiguration.py | 6 +++--- 5 files changed, 22 insertions(+), 14 deletions(-) diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 9a4a28d5b..f8db1f7af 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -388,4 +388,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.105.0 (2.169.3) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v2.1.2] entity \ No newline at end of file +- [python v2.1.2] entity + +## 2023-10-25 01:13:51 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.107.0 (2.171.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v2.1.3] entity \ No newline at end of file diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 0e714c31f..6bedf05d9 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -102,14 +102,14 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( entity=shared.Entity( additional_properties={ + "_updated_at": 'string', + "_acl": 'string', "_id": 'string', "_org": 'string', "_owners": 'string', "_schema": 'string', "_tags": 'string', "_created_at": 'string', - "_updated_at": 'string', - "_acl": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -711,14 +711,14 @@ req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( entity=shared.Entity( additional_properties={ + "_schema": 'string', + "_tags": 'string', + "_created_at": 'string', "_updated_at": 'string', "_acl": 'string', "_id": 'string', "_org": 'string', "_owners": 'string', - "_schema": 'string', - "_tags": 'string', - "_created_at": 'string', }, acl=shared.EntityACL( additional_properties={ diff --git a/entity/gen.yaml b/entity/gen.yaml index f302ca657..46ffa5f62 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,9 +1,9 @@ configVersion: 1.0.0 management: - docChecksum: 98298ca31cb0b7762f9dda606bce4f1b + docChecksum: 2ba039db69a6d628e2f24b9441071f07 docVersion: 1.0.0 - speakeasyVersion: 1.105.0 - generationVersion: 2.169.3 + speakeasyVersion: 1.107.0 + generationVersion: 2.171.0 generation: repoURL: https://github.com/epilot-dev/sdk-python.git sdkClassName: epilot @@ -17,7 +17,7 @@ features: globalSecurity: 2.82.0 globalServerURLs: 2.82.0 python: - version: 2.1.2 + version: 2.1.3 author: epilot description: Python Client SDK for Epilot flattenGlobalSecurity: false diff --git a/entity/setup.py b/entity/setup.py index 7f21ae490..a98fd3241 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="2.1.2", + version="2.1.3", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 5f5625382..a52bf8ab2 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -20,9 +20,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '2.1.2' - gen_version: str = '2.169.3' - user_agent: str = 'speakeasy-sdk/python 2.1.2 2.169.3 1.0.0 epilot-entity' + sdk_version: str = '2.1.3' + gen_version: str = '2.171.0' + user_agent: str = 'speakeasy-sdk/python 2.1.3 2.171.0 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: From 81f1851f45df023f83de8df4e72877ab38b188e3 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Sat, 28 Oct 2023 01:12:01 +0000 Subject: [PATCH 53/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.109.0 --- entity/README.md | 105 ++++++++++++++++++ entity/RELEASES.md | 10 +- .../models/operations/createentityrequest.md | 2 +- .../models/operations/deleteentityrequest.md | 2 +- .../models/operations/deleteschemarequest.md | 2 +- .../getentityactivityfeedrequest.md | 2 +- .../getrelatedentitiescountrequest.md | 10 +- .../models/operations/getrelationsrequest.md | 20 ++-- .../operations/getrelationsv2request.md | 20 ++-- .../operations/getrelationsv3request.md | 20 ++-- .../models/operations/getschemarequest.md | 2 +- .../operations/getschemaversionsrequest.md | 2 +- .../models/operations/gettaxonomyrequest.md | 6 +- ...taxonomyclassificationsforschemarequest.md | 4 +- .../models/operations/patchentityrequest.md | 16 +-- .../models/operations/putschemarequest.md | 2 +- .../operations/taxonomyautocompleterequest.md | 2 +- .../models/operations/upsertentityrequest.md | 4 +- .../docs/models/shared/entitysearchparams.md | 2 +- entity/docs/models/shared/searchmappings.md | 2 +- entity/docs/sdks/entities/README.md | 16 +-- entity/docs/sdks/export/README.md | 2 +- entity/docs/sdks/relations/README.md | 4 +- entity/docs/sdks/schemas/README.md | 4 +- entity/docs/sdks/taxonomy/README.md | 2 +- entity/gen.yaml | 10 +- entity/setup.py | 2 +- .../epilot/models/operations/createentity.py | 2 +- .../epilot/models/operations/deleteentity.py | 1 + .../epilot/models/operations/deleteschema.py | 1 + .../operations/getentityactivityfeed.py | 2 +- .../operations/getrelatedentitiescount.py | 4 +- .../epilot/models/operations/getrelations.py | 2 +- .../models/operations/getrelationsv2.py | 4 +- .../models/operations/getrelationsv3.py | 2 +- .../src/epilot/models/operations/getschema.py | 1 + .../models/operations/getschemaversions.py | 1 + .../epilot/models/operations/gettaxonomy.py | 2 +- .../listtaxonomyclassificationsforschema.py | 2 + .../epilot/models/operations/patchentity.py | 8 +- .../src/epilot/models/operations/putschema.py | 1 + .../models/operations/taxonomyautocomplete.py | 2 +- .../epilot/models/operations/upsertentity.py | 4 +- .../models/shared/entitysearchparams.py | 2 +- .../epilot/models/shared/searchmappings.py | 2 +- entity/src/epilot/sdkconfiguration.py | 6 +- 46 files changed, 222 insertions(+), 102 deletions(-) diff --git a/entity/README.md b/entity/README.md index c0810c9fc..27a607795 100755 --- a/entity/README.md +++ b/entity/README.md @@ -121,6 +121,111 @@ return value of `Next` is `None`, then there are no more pages to be fetched. Here's an example of one such pagination call: + + + +# 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. + + + + + + + +# 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 +``` + + + + + +# 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) +``` + + + + diff --git a/entity/RELEASES.md b/entity/RELEASES.md index f8db1f7af..498ac9197 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -396,4 +396,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.107.0 (2.171.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v2.1.3] entity \ No newline at end of file +- [python v2.1.3] entity + +## 2023-10-28 01:11:29 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.109.0 (2.173.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v2.1.4] entity \ No newline at end of file diff --git a/entity/docs/models/operations/createentityrequest.md b/entity/docs/models/operations/createentityrequest.md index 54ec655ea..42257e042 100755 --- a/entity/docs/models/operations/createentityrequest.md +++ b/entity/docs/models/operations/createentityrequest.md @@ -8,4 +8,4 @@ | `entity` | [Optional[shared.Entity]](../../models/shared/entity.md) | :heavy_minus_sign: | N/A | | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteentityrequest.md b/entity/docs/models/operations/deleteentityrequest.md index 2d034cf52..b456f7821 100755 --- a/entity/docs/models/operations/deleteentityrequest.md +++ b/entity/docs/models/operations/deleteentityrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `id` | *str* | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | Entity id | | | `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/deleteschemarequest.md b/entity/docs/models/operations/deleteschemarequest.md index 6de6bc920..8c104d0df 100755 --- a/entity/docs/models/operations/deleteschemarequest.md +++ b/entity/docs/models/operations/deleteschemarequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getentityactivityfeedrequest.md b/entity/docs/models/operations/getentityactivityfeedrequest.md index f60f393f5..98e4998a1 100755 --- a/entity/docs/models/operations/getentityactivityfeedrequest.md +++ b/entity/docs/models/operations/getentityactivityfeedrequest.md @@ -7,7 +7,7 @@ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | `after` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Get activities after this timestamp | | | `before` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | get activities before this timestamp | | -| `from_` | *Optional[int]* | :heavy_minus_sign: | start from page | | +| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | | `id` | *str* | :heavy_check_mark: | Entity id | | | `include_relations` | *Optional[bool]* | :heavy_minus_sign: | Include activities from related entities | | | `size` | *Optional[int]* | :heavy_minus_sign: | max number of results to return | | diff --git a/entity/docs/models/operations/getrelatedentitiescountrequest.md b/entity/docs/models/operations/getrelatedentitiescountrequest.md index b73c7a450..6f8be471a 100755 --- a/entity/docs/models/operations/getrelatedentitiescountrequest.md +++ b/entity/docs/models/operations/getrelatedentitiescountrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | To be excluded from the count by given schemas | | -| `id` | *str* | :heavy_check_mark: | Entity id | | -| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | +| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to exclude schemas | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsrequest.md b/entity/docs/models/operations/getrelationsrequest.md index c4fc7b941..7edbc6270 100755 --- a/entity/docs/models/operations/getrelationsrequest.md +++ b/entity/docs/models/operations/getrelationsrequest.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to exclude schemas | | -| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | -| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | -| `id` | *str* | :heavy_check_mark: | Entity id | | -| `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | -| `include_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to only include schemas | | -| `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to exclude schemas | | +| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | +| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | +| `include_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to only include schemas | | +| `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv2request.md b/entity/docs/models/operations/getrelationsv2request.md index 4c3871f70..4149c6dff 100755 --- a/entity/docs/models/operations/getrelationsv2request.md +++ b/entity/docs/models/operations/getrelationsv2request.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `fields_` | List[*str*] | :heavy_minus_sign: | List of entity fields to include in results | _id,_schema,_title | -| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | -| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | -| `id` | *str* | :heavy_check_mark: | Entity id | | -| `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | -| `query` | *Optional[str]* | :heavy_minus_sign: | Input to filter search results | | -| `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `fields` | List[*str*] | :heavy_minus_sign: | List of entity fields to include in results | _id,_schema,_title | +| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | +| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | +| `query` | *Optional[str]* | :heavy_minus_sign: | Input to filter search results | | +| `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getrelationsv3request.md b/entity/docs/models/operations/getrelationsv3request.md index 0472f748e..a7db9d1cf 100755 --- a/entity/docs/models/operations/getrelationsv3request.md +++ b/entity/docs/models/operations/getrelationsv3request.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to exclude schemas | | -| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | -| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, expand relation items with full blown entities. | | -| `id` | *str* | :heavy_check_mark: | Entity id | | -| `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | -| `include_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to only include schemas | | -| `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | -| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `exclude_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to exclude schemas | | +| `from_` | *Optional[int]* | :heavy_minus_sign: | Starting page number | | +| `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `include_reverse` | *Optional[bool]* | :heavy_minus_sign: | When true, includes reverse relations in response (other entities pointing to this entity) | | +| `include_schemas` | List[*str*] | :heavy_minus_sign: | Filter results to only include schemas | | +| `size` | *Optional[int]* | :heavy_minus_sign: | Number of results to return per page | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemarequest.md b/entity/docs/models/operations/getschemarequest.md index 8c26cdd5c..6fe00fc7d 100755 --- a/entity/docs/models/operations/getschemarequest.md +++ b/entity/docs/models/operations/getschemarequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/getschemaversionsrequest.md b/entity/docs/models/operations/getschemaversionsrequest.md index 64d754a5d..89dec35be 100755 --- a/entity/docs/models/operations/getschemaversionsrequest.md +++ b/entity/docs/models/operations/getschemaversionsrequest.md @@ -7,6 +7,6 @@ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | `drafts_from` | *Optional[float]* | :heavy_minus_sign: | N/A | | | `drafts_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | contact | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | | `versions_from` | *Optional[float]* | :heavy_minus_sign: | N/A | | | `versions_size` | *Optional[float]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/entity/docs/models/operations/gettaxonomyrequest.md b/entity/docs/models/operations/gettaxonomyrequest.md index 32f13f4e2..a0fc1bb0d 100755 --- a/entity/docs/models/operations/gettaxonomyrequest.md +++ b/entity/docs/models/operations/gettaxonomyrequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug to return taxonomy for | purpose | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file diff --git a/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md b/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md index 9e1d16f97..55ab5ecfa 100755 --- a/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md +++ b/entity/docs/models/operations/listtaxonomyclassificationsforschemarequest.md @@ -7,5 +7,5 @@ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | `query` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `size` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | contact | -| `taxonomy_slug` | *str* | :heavy_check_mark: | N/A | purpose | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | +| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug | | \ No newline at end of file diff --git a/entity/docs/models/operations/patchentityrequest.md b/entity/docs/models/operations/patchentityrequest.md index c2b2fdcf7..84235986b 100755 --- a/entity/docs/models/operations/patchentityrequest.md +++ b/entity/docs/models/operations/patchentityrequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `entity` | [shared.Entity](../../models/shared/entity.md) | :heavy_check_mark: | N/A | | -| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | -| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for the patch entity to become available in Search API. Useful for large migrations | | -| `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = returns the patch result but doesn't perform the patch. | | -| `id` | *str* | :heavy_check_mark: | Entity Id | | -| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `entity` | [shared.Entity](../../models/shared/entity.md) | :heavy_check_mark: | N/A | | +| `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | +| `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | +| `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = return results but does not perform the operation. | | +| `id` | *str* | :heavy_check_mark: | Entity id | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/putschemarequest.md b/entity/docs/models/operations/putschemarequest.md index c9a028b63..65ea185dd 100755 --- a/entity/docs/models/operations/putschemarequest.md +++ b/entity/docs/models/operations/putschemarequest.md @@ -7,4 +7,4 @@ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | `entity_schema` | [Optional[shared.EntitySchema]](../../models/shared/entityschema.md) | :heavy_minus_sign: | N/A | | | `draft` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | contact | \ No newline at end of file +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/operations/taxonomyautocompleterequest.md b/entity/docs/models/operations/taxonomyautocompleterequest.md index 5a8b57d23..3c7a757e4 100755 --- a/entity/docs/models/operations/taxonomyautocompleterequest.md +++ b/entity/docs/models/operations/taxonomyautocompleterequest.md @@ -7,4 +7,4 @@ | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | | `query` | *Optional[str]* | :heavy_minus_sign: | Input to autocomplete | | `size` | *Optional[float]* | :heavy_minus_sign: | Minimum number of results to return | -| `taxonomy_slug` | *str* | :heavy_check_mark: | Limit results to slug | \ No newline at end of file +| `taxonomy_slug` | *str* | :heavy_check_mark: | Taxonomy slug | \ No newline at end of file diff --git a/entity/docs/models/operations/upsertentityrequest.md b/entity/docs/models/operations/upsertentityrequest.md index b531e76f2..a961d8418 100755 --- a/entity/docs/models/operations/upsertentityrequest.md +++ b/entity/docs/models/operations/upsertentityrequest.md @@ -8,5 +8,5 @@ | `request_body` | [Optional[UpsertEntityRequestBody]](../../models/operations/upsertentityrequestbody.md) | :heavy_minus_sign: | N/A | | | `activity_id` | *Optional[str]* | :heavy_minus_sign: | Activity to include in event feed | 01F130Q52Q6MWSNS8N2AVXV4JN | | `async_` | *Optional[bool]* | :heavy_minus_sign: | Don't wait for updated entity to become available in Search API. Useful for large migrations | | -| `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = return matched entities but don't update them. | | -| `slug` | *str* | :heavy_check_mark: | Entity Schema | contact | \ No newline at end of file +| `dry_run` | *Optional[bool]* | :heavy_minus_sign: | Dry Run mode = return results but does not perform the operation. | | +| `slug` | *str* | :heavy_check_mark: | Entity Type | contact | \ No newline at end of file diff --git a/entity/docs/models/shared/entitysearchparams.md b/entity/docs/models/shared/entitysearchparams.md index 8693681e9..a9f12a2cb 100755 --- a/entity/docs/models/shared/entitysearchparams.md +++ b/entity/docs/models/shared/entitysearchparams.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `aggs` | [Optional[EntitySearchParamsAggs]](../../models/shared/entitysearchparamsaggs.md) | :heavy_minus_sign: | Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics. | | -| `fields_` | List[*str*] | :heavy_minus_sign: | List of entity fields to include in search results | _id,_title,first_name | +| `fields` | List[*str*] | :heavy_minus_sign: | List of entity fields to include in search results | _id,_title,first_name | | `from_` | *Optional[int]* | :heavy_minus_sign: | N/A | | | `hydrate` | *Optional[bool]* | :heavy_minus_sign: | When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place. | | | `include_scores` | *Optional[bool]* | :heavy_minus_sign: | Adds a `_score` number field to results that can be used to rank by match score | | diff --git a/entity/docs/models/shared/searchmappings.md b/entity/docs/models/shared/searchmappings.md index dec7a286a..5de79a6af 100755 --- a/entity/docs/models/shared/searchmappings.md +++ b/entity/docs/models/shared/searchmappings.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `fields_` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `fields` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `index` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `type` | [Optional[SearchMappingsType]](../../models/shared/searchmappingstype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index 6bedf05d9..f8fe7cef0 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -102,14 +102,14 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( entity=shared.Entity( additional_properties={ - "_updated_at": 'string', - "_acl": 'string', "_id": 'string', "_org": 'string', "_owners": 'string', "_schema": 'string', "_tags": 'string', "_created_at": 'string', + "_updated_at": 'string', + "_acl": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -373,14 +373,14 @@ s = epilot.Epilot( req = operations.PatchEntityRequest( entity=shared.Entity( additional_properties={ + "_owners": 'string', + "_schema": 'string', + "_tags": 'string', "_created_at": 'string', "_updated_at": 'string', "_acl": 'string', "_id": 'string', "_org": 'string', - "_owners": 'string', - "_schema": 'string', - "_tags": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -532,7 +532,7 @@ s = epilot.Epilot( req = shared.EntitySearchParams( aggs=shared.EntitySearchParamsAggs(), - fields_=[ + fields=[ '_id', '_title', 'first_name', @@ -605,6 +605,7 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( entity=shared.Entity( additional_properties={ + "_owners": 'string', "_schema": 'string', "_tags": 'string', "_created_at": 'string', @@ -612,7 +613,6 @@ req = operations.UpdateEntityRequest( "_acl": 'string', "_id": 'string', "_org": 'string', - "_owners": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -711,7 +711,6 @@ req = operations.UpsertEntityRequest( request_body=operations.UpsertEntityRequestBody( entity=shared.Entity( additional_properties={ - "_schema": 'string', "_tags": 'string', "_created_at": 'string', "_updated_at": 'string', @@ -719,6 +718,7 @@ req = operations.UpsertEntityRequest( "_id": 'string', "_org": 'string', "_owners": 'string', + "_schema": 'string', }, acl=shared.EntityACL( additional_properties={ diff --git a/entity/docs/sdks/export/README.md b/entity/docs/sdks/export/README.md index 71c9e7e35..798dc6f01 100755 --- a/entity/docs/sdks/export/README.md +++ b/entity/docs/sdks/export/README.md @@ -28,7 +28,7 @@ s = epilot.Epilot( req = operations.ExportEntitiesRequest( entity_search_params=shared.EntitySearchParams( aggs=shared.EntitySearchParamsAggs(), - fields_=[ + fields=[ '_id', '_title', 'first_name', diff --git a/entity/docs/sdks/relations/README.md b/entity/docs/sdks/relations/README.md index 8f6933ee6..f9cb1819f 100755 --- a/entity/docs/sdks/relations/README.md +++ b/entity/docs/sdks/relations/README.md @@ -127,7 +127,7 @@ s = epilot.Epilot( req = operations.GetRelatedEntitiesCountRequest( exclude_schemas=[ - 'string', + 'contact', ], id='3a515de5-fe13-46e4-ad0c-a57656a6a8af', slug='contact', @@ -225,7 +225,7 @@ s = epilot.Epilot( ) req = operations.GetRelationsV2Request( - fields_=[ + fields=[ '_id', '_schema', '_title', diff --git a/entity/docs/sdks/schemas/README.md b/entity/docs/sdks/schemas/README.md index 651eadd65..c7b5225a5 100755 --- a/entity/docs/sdks/schemas/README.md +++ b/entity/docs/sdks/schemas/README.md @@ -217,7 +217,7 @@ s = epilot.Epilot( req = operations.ListTaxonomyClassificationsForSchemaRequest( slug='contact', - taxonomy_slug='purpose', + taxonomy_slug='string', ) res = s.schemas.list_taxonomy_classifications_for_schema(req) @@ -432,7 +432,7 @@ req = operations.PutSchemaRequest( ], explicit_search_mappings={ "image": shared.SearchMappings( - fields_={ + fields={ "key": 'string', }, ), diff --git a/entity/docs/sdks/taxonomy/README.md b/entity/docs/sdks/taxonomy/README.md index 654fb6b17..07cb36527 100755 --- a/entity/docs/sdks/taxonomy/README.md +++ b/entity/docs/sdks/taxonomy/README.md @@ -30,7 +30,7 @@ s = epilot.Epilot( ) req = operations.GetTaxonomyRequest( - taxonomy_slug='purpose', + taxonomy_slug='string', ) res = s.taxonomy.get_taxonomy(req) diff --git a/entity/gen.yaml b/entity/gen.yaml index 46ffa5f62..b36704df1 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,9 +1,9 @@ configVersion: 1.0.0 management: - docChecksum: 2ba039db69a6d628e2f24b9441071f07 + docChecksum: 550354d0dee9f8f9cab62872a5a6becf docVersion: 1.0.0 - speakeasyVersion: 1.107.0 - generationVersion: 2.171.0 + speakeasyVersion: 1.109.0 + generationVersion: 2.173.0 generation: repoURL: https://github.com/epilot-dev/sdk-python.git sdkClassName: epilot @@ -13,11 +13,11 @@ generation: features: python: additionalProperties: 0.1.0 - core: 3.3.0 + core: 3.3.1 globalSecurity: 2.82.0 globalServerURLs: 2.82.0 python: - version: 2.1.3 + version: 2.1.4 author: epilot description: Python Client SDK for Epilot flattenGlobalSecurity: false diff --git a/entity/setup.py b/entity/setup.py index a98fd3241..db99856e1 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="2.1.3", + version="2.1.4", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/operations/createentity.py b/entity/src/epilot/models/operations/createentity.py index a33f5fd1d..e83067531 100755 --- a/entity/src/epilot/models/operations/createentity.py +++ b/entity/src/epilot/models/operations/createentity.py @@ -11,7 +11,7 @@ @dataclasses.dataclass class CreateEntityRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Schema""" + r"""Entity Type""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) diff --git a/entity/src/epilot/models/operations/deleteentity.py b/entity/src/epilot/models/operations/deleteentity.py index 21a6ff067..44e78a62b 100755 --- a/entity/src/epilot/models/operations/deleteentity.py +++ b/entity/src/epilot/models/operations/deleteentity.py @@ -9,6 +9,7 @@ @dataclasses.dataclass class DeleteEntityRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) + r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Type""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) diff --git a/entity/src/epilot/models/operations/deleteschema.py b/entity/src/epilot/models/operations/deleteschema.py index f15199e1b..9b1ae2b9d 100755 --- a/entity/src/epilot/models/operations/deleteschema.py +++ b/entity/src/epilot/models/operations/deleteschema.py @@ -9,6 +9,7 @@ @dataclasses.dataclass class DeleteSchemaRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + r"""Entity Type""" diff --git a/entity/src/epilot/models/operations/getentityactivityfeed.py b/entity/src/epilot/models/operations/getentityactivityfeed.py index a3e082ece..803be50e3 100755 --- a/entity/src/epilot/models/operations/getentityactivityfeed.py +++ b/entity/src/epilot/models/operations/getentityactivityfeed.py @@ -21,7 +21,7 @@ class GetEntityActivityFeedRequest: before: Optional[datetime] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'before', 'style': 'form', 'explode': True }}) r"""get activities before this timestamp""" from_: Optional[int] = dataclasses.field(default=0, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) - r"""start from page""" + r"""Starting page number""" include_relations: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'include_relations', 'style': 'form', 'explode': True }}) r"""Include activities from related entities""" size: Optional[int] = dataclasses.field(default=25, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) diff --git a/entity/src/epilot/models/operations/getrelatedentitiescount.py b/entity/src/epilot/models/operations/getrelatedentitiescount.py index 64d63b2f6..ad99756ff 100755 --- a/entity/src/epilot/models/operations/getrelatedentitiescount.py +++ b/entity/src/epilot/models/operations/getrelatedentitiescount.py @@ -12,9 +12,9 @@ class GetRelatedEntitiesCountRequest: id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Schema""" + r"""Entity Type""" exclude_schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'exclude_schemas', 'style': 'form', 'explode': False }}) - r"""To be excluded from the count by given schemas""" + r"""Filter results to exclude schemas""" diff --git a/entity/src/epilot/models/operations/getrelations.py b/entity/src/epilot/models/operations/getrelations.py index 562e9e75c..68d8a0ba0 100755 --- a/entity/src/epilot/models/operations/getrelations.py +++ b/entity/src/epilot/models/operations/getrelations.py @@ -19,7 +19,7 @@ class GetRelationsRequest: from_: Optional[int] = dataclasses.field(default=0, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) r"""Starting page number""" hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) - r"""When true, expand relation items with full blown entities.""" + r"""When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.""" include_reverse: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) r"""When true, includes reverse relations in response (other entities pointing to this entity)""" include_schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'include_schemas', 'style': 'form', 'explode': False }}) diff --git a/entity/src/epilot/models/operations/getrelationsv2.py b/entity/src/epilot/models/operations/getrelationsv2.py index 1c4e4f458..6450dd096 100755 --- a/entity/src/epilot/models/operations/getrelationsv2.py +++ b/entity/src/epilot/models/operations/getrelationsv2.py @@ -13,12 +13,12 @@ class GetRelationsV2Request: r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) r"""Entity Type""" - fields_: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': True }}) + fields: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': True }}) r"""List of entity fields to include in results""" from_: Optional[int] = dataclasses.field(default=0, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) r"""Starting page number""" hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) - r"""When true, expand relation items with full blown entities.""" + r"""When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.""" include_reverse: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) r"""When true, includes reverse relations in response (other entities pointing to this entity)""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) diff --git a/entity/src/epilot/models/operations/getrelationsv3.py b/entity/src/epilot/models/operations/getrelationsv3.py index 7c9eaa79a..f17bdc70c 100755 --- a/entity/src/epilot/models/operations/getrelationsv3.py +++ b/entity/src/epilot/models/operations/getrelationsv3.py @@ -18,7 +18,7 @@ class GetRelationsV3Request: from_: Optional[int] = dataclasses.field(default=0, metadata={'query_param': { 'field_name': 'from', 'style': 'form', 'explode': True }}) r"""Starting page number""" hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'hydrate', 'style': 'form', 'explode': True }}) - r"""When true, expand relation items with full blown entities.""" + r"""When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.""" include_reverse: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'include_reverse', 'style': 'form', 'explode': True }}) r"""When true, includes reverse relations in response (other entities pointing to this entity)""" include_schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'include_schemas', 'style': 'form', 'explode': False }}) diff --git a/entity/src/epilot/models/operations/getschema.py b/entity/src/epilot/models/operations/getschema.py index 3e96e1e99..a71e8b72d 100755 --- a/entity/src/epilot/models/operations/getschema.py +++ b/entity/src/epilot/models/operations/getschema.py @@ -10,6 +10,7 @@ @dataclasses.dataclass class GetSchemaRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + r"""Entity Type""" id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'id', 'style': 'form', 'explode': True }}) diff --git a/entity/src/epilot/models/operations/getschemaversions.py b/entity/src/epilot/models/operations/getschemaversions.py index 19d10fa68..789bae63c 100755 --- a/entity/src/epilot/models/operations/getschemaversions.py +++ b/entity/src/epilot/models/operations/getschemaversions.py @@ -12,6 +12,7 @@ @dataclasses.dataclass class GetSchemaVersionsRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + r"""Entity Type""" drafts_from: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'drafts_from', 'style': 'form', 'explode': True }}) drafts_size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'drafts_size', 'style': 'form', 'explode': True }}) versions_from: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'versions_from', 'style': 'form', 'explode': True }}) diff --git a/entity/src/epilot/models/operations/gettaxonomy.py b/entity/src/epilot/models/operations/gettaxonomy.py index 49a3d4451..ac56e1cf6 100755 --- a/entity/src/epilot/models/operations/gettaxonomy.py +++ b/entity/src/epilot/models/operations/gettaxonomy.py @@ -10,7 +10,7 @@ @dataclasses.dataclass class GetTaxonomyRequest: taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) - r"""Taxonomy slug to return taxonomy for""" + r"""Taxonomy slug""" diff --git a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py index a04c3a7f2..b5694e875 100755 --- a/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py +++ b/entity/src/epilot/models/operations/listtaxonomyclassificationsforschema.py @@ -12,7 +12,9 @@ @dataclasses.dataclass class ListTaxonomyClassificationsForSchemaRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + r"""Entity Type""" taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) + r"""Taxonomy slug""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) diff --git a/entity/src/epilot/models/operations/patchentity.py b/entity/src/epilot/models/operations/patchentity.py index 2c155da2a..065598c70 100755 --- a/entity/src/epilot/models/operations/patchentity.py +++ b/entity/src/epilot/models/operations/patchentity.py @@ -12,15 +12,15 @@ class PatchEntityRequest: entity: shared_entity.Entity = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - r"""Entity Id""" + r"""Entity id""" slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Schema""" + r"""Entity Type""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) - r"""Don't wait for the patch entity to become available in Search API. Useful for large migrations""" + r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" dry_run: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'dry_run', 'style': 'form', 'explode': True }}) - r"""Dry Run mode = returns the patch result but doesn't perform the patch.""" + r"""Dry Run mode = return results but does not perform the operation.""" diff --git a/entity/src/epilot/models/operations/putschema.py b/entity/src/epilot/models/operations/putschema.py index 0dc010f98..898ee5c07 100755 --- a/entity/src/epilot/models/operations/putschema.py +++ b/entity/src/epilot/models/operations/putschema.py @@ -11,6 +11,7 @@ @dataclasses.dataclass class PutSchemaRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) + r"""Entity Type""" draft: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'draft', 'style': 'form', 'explode': True }}) entity_schema: Optional[shared_entityschema.EntitySchema] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) diff --git a/entity/src/epilot/models/operations/taxonomyautocomplete.py b/entity/src/epilot/models/operations/taxonomyautocomplete.py index 1fd024ba8..a971968a8 100755 --- a/entity/src/epilot/models/operations/taxonomyautocomplete.py +++ b/entity/src/epilot/models/operations/taxonomyautocomplete.py @@ -12,7 +12,7 @@ @dataclasses.dataclass class TaxonomyAutocompleteRequest: taxonomy_slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'taxonomySlug', 'style': 'simple', 'explode': False }}) - r"""Limit results to slug""" + r"""Taxonomy slug""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Input to autocomplete""" size: Optional[float] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'size', 'style': 'form', 'explode': True }}) diff --git a/entity/src/epilot/models/operations/upsertentity.py b/entity/src/epilot/models/operations/upsertentity.py index c57081f3b..ea196ff27 100755 --- a/entity/src/epilot/models/operations/upsertentity.py +++ b/entity/src/epilot/models/operations/upsertentity.py @@ -22,13 +22,13 @@ class UpsertEntityRequestBody: @dataclasses.dataclass class UpsertEntityRequest: slug: str = dataclasses.field(metadata={'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': False }}) - r"""Entity Schema""" + r"""Entity Type""" activity_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'activity_id', 'style': 'form', 'explode': True }}) r"""Activity to include in event feed""" async_: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'async', 'style': 'form', 'explode': True }}) r"""Don't wait for updated entity to become available in Search API. Useful for large migrations""" dry_run: Optional[bool] = dataclasses.field(default=False, metadata={'query_param': { 'field_name': 'dry_run', 'style': 'form', 'explode': True }}) - r"""Dry Run mode = return matched entities but don't update them.""" + r"""Dry Run mode = return results but does not perform the operation.""" request_body: Optional[UpsertEntityRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) diff --git a/entity/src/epilot/models/shared/entitysearchparams.py b/entity/src/epilot/models/shared/entitysearchparams.py index 2ebbb3e60..cb30eb69f 100755 --- a/entity/src/epilot/models/shared/entitysearchparams.py +++ b/entity/src/epilot/models/shared/entitysearchparams.py @@ -21,7 +21,7 @@ class EntitySearchParams: r"""Lucene queries supported with ElasticSearch""" aggs: Optional[EntitySearchParamsAggs] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aggs'), 'exclude': lambda f: f is None }}) r"""Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.""" - fields_: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) + fields: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) r"""List of entity fields to include in search results""" from_: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('from'), 'exclude': lambda f: f is None }}) hydrate: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hydrate'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/models/shared/searchmappings.py b/entity/src/epilot/models/shared/searchmappings.py index d150a3255..c1eee0c84 100755 --- a/entity/src/epilot/models/shared/searchmappings.py +++ b/entity/src/epilot/models/shared/searchmappings.py @@ -22,7 +22,7 @@ class SearchMappingsType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SearchMappings: - fields_: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) + fields: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fields'), 'exclude': lambda f: f is None }}) index: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) type: Optional[SearchMappingsType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index a52bf8ab2..66d9c63d1 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -20,9 +20,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '2.1.3' - gen_version: str = '2.171.0' - user_agent: str = 'speakeasy-sdk/python 2.1.3 2.171.0 1.0.0 epilot-entity' + sdk_version: str = '2.1.4' + gen_version: str = '2.173.0' + user_agent: str = 'speakeasy-sdk/python 2.1.4 2.173.0 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: From 699e09211cfb8e52554767eb1b68b2861b77635f Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 1 Nov 2023 01:19:02 +0000 Subject: [PATCH 54/54] ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.109.2 --- entity/README.md | 4 ---- entity/RELEASES.md | 10 +++++++++- entity/docs/models/shared/entitydefaulttable.md | 1 - entity/docs/sdks/entities/README.md | 12 ++++++------ entity/gen.yaml | 6 +++--- entity/setup.py | 2 +- .../src/epilot/models/shared/entitydefaulttable.py | 1 - entity/src/epilot/sdkconfiguration.py | 4 ++-- 8 files changed, 21 insertions(+), 19 deletions(-) diff --git a/entity/README.md b/entity/README.md index 27a607795..fd12c1886 100755 --- a/entity/README.md +++ b/entity/README.md @@ -127,8 +127,6 @@ Here's an example of one such pagination call: # 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. - - @@ -222,8 +220,6 @@ http_client = requests.Session() http_client.headers.update({'x-custom-header': 'someValue'}) s = epilot.Epilot(client: http_client) ``` - - diff --git a/entity/RELEASES.md b/entity/RELEASES.md index 498ac9197..ec54217ca 100644 --- a/entity/RELEASES.md +++ b/entity/RELEASES.md @@ -404,4 +404,12 @@ Based on: - OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml - Speakeasy CLI 1.109.0 (2.173.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [python v2.1.4] entity \ No newline at end of file +- [python v2.1.4] entity + +## 2023-11-01 01:18:34 +### Changes +Based on: +- OpenAPI Doc 1.0.0 https://docs.api.epilot.io/entity.yaml +- Speakeasy CLI 1.109.2 (2.173.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v2.1.5] entity \ No newline at end of file diff --git a/entity/docs/models/shared/entitydefaulttable.md b/entity/docs/models/shared/entitydefaulttable.md index 05dc8b09b..a3ce3412d 100755 --- a/entity/docs/models/shared/entitydefaulttable.md +++ b/entity/docs/models/shared/entitydefaulttable.md @@ -5,7 +5,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `classic_view` | *Optional[str]* | :heavy_minus_sign: | N/A | | `dropdown_items` | List[[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]](../../models/shared/entitydefaulttabledropdownitems.md)] | :heavy_minus_sign: | N/A | | `enable_thumbnails` | *Optional[bool]* | :heavy_minus_sign: | Enable the thumbnail column | | `navbar_actions` | List[[EntityDefaultTableNavbarActions](../../models/shared/entitydefaulttablenavbaractions.md)] | :heavy_minus_sign: | N/A | diff --git a/entity/docs/sdks/entities/README.md b/entity/docs/sdks/entities/README.md index f8fe7cef0..a0b83567b 100755 --- a/entity/docs/sdks/entities/README.md +++ b/entity/docs/sdks/entities/README.md @@ -102,6 +102,7 @@ s = epilot.Epilot( req = operations.CreateEntityRequest( entity=shared.Entity( additional_properties={ + "_acl": 'string', "_id": 'string', "_org": 'string', "_owners": 'string', @@ -109,7 +110,6 @@ req = operations.CreateEntityRequest( "_tags": 'string', "_created_at": 'string', "_updated_at": 'string', - "_acl": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -373,14 +373,14 @@ s = epilot.Epilot( req = operations.PatchEntityRequest( entity=shared.Entity( additional_properties={ - "_owners": 'string', - "_schema": 'string', - "_tags": 'string', - "_created_at": 'string', "_updated_at": 'string', "_acl": 'string', "_id": 'string', "_org": 'string', + "_owners": 'string', + "_schema": 'string', + "_tags": 'string', + "_created_at": 'string', }, acl=shared.EntityACL( additional_properties={ @@ -605,7 +605,6 @@ s = epilot.Epilot( req = operations.UpdateEntityRequest( entity=shared.Entity( additional_properties={ - "_owners": 'string', "_schema": 'string', "_tags": 'string', "_created_at": 'string', @@ -613,6 +612,7 @@ req = operations.UpdateEntityRequest( "_acl": 'string', "_id": 'string', "_org": 'string', + "_owners": 'string', }, acl=shared.EntityACL( additional_properties={ diff --git a/entity/gen.yaml b/entity/gen.yaml index b36704df1..0854e421b 100644 --- a/entity/gen.yaml +++ b/entity/gen.yaml @@ -1,8 +1,8 @@ configVersion: 1.0.0 management: - docChecksum: 550354d0dee9f8f9cab62872a5a6becf + docChecksum: e8adb604a2c9aaf4c8973aa40510b5c2 docVersion: 1.0.0 - speakeasyVersion: 1.109.0 + speakeasyVersion: 1.109.2 generationVersion: 2.173.0 generation: repoURL: https://github.com/epilot-dev/sdk-python.git @@ -17,7 +17,7 @@ features: globalSecurity: 2.82.0 globalServerURLs: 2.82.0 python: - version: 2.1.4 + version: 2.1.5 author: epilot description: Python Client SDK for Epilot flattenGlobalSecurity: false diff --git a/entity/setup.py b/entity/setup.py index db99856e1..1fd614041 100755 --- a/entity/setup.py +++ b/entity/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="epilot-entity", - version="2.1.4", + version="2.1.5", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, diff --git a/entity/src/epilot/models/shared/entitydefaulttable.py b/entity/src/epilot/models/shared/entitydefaulttable.py index f841933fa..18e9a2f26 100755 --- a/entity/src/epilot/models/shared/entitydefaulttable.py +++ b/entity/src/epilot/models/shared/entitydefaulttable.py @@ -82,7 +82,6 @@ class EntityDefaultTableViewType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EntityDefaultTable: - classic_view: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('classic_view'), 'exclude': lambda f: f is None }}) dropdown_items: Optional[List[Union[EntityDefaultTableDropdownItems1, EntityDefaultTableDropdownItems2]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dropdown_items'), 'exclude': lambda f: f is None }}) enable_thumbnails: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_thumbnails'), 'exclude': lambda f: f is None }}) r"""Enable the thumbnail column""" diff --git a/entity/src/epilot/sdkconfiguration.py b/entity/src/epilot/sdkconfiguration.py index 66d9c63d1..b05d51411 100755 --- a/entity/src/epilot/sdkconfiguration.py +++ b/entity/src/epilot/sdkconfiguration.py @@ -20,9 +20,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '2.1.4' + sdk_version: str = '2.1.5' gen_version: str = '2.173.0' - user_agent: str = 'speakeasy-sdk/python 2.1.4 2.173.0 1.0.0 epilot-entity' + user_agent: str = 'speakeasy-sdk/python 2.1.5 2.173.0 1.0.0 epilot-entity' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: